查询实例信息

最近更新时间: 2026-10-10 00:11:03

1. 接口描述

接口请求域名： tcr.api3.fincloud.tencent.com。

查询实例信息

默认接口请求频率限制：100次/秒。

接口更新时间：2023-09-05 10:07:01。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeInstances
Version	是	否	String	公共参数，本接口取值：2019-09-24
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
Registryids	否	否	Array of String	实例ID列表(为空时，表示获取账号下所有实例) 示例值：
Offset	否	否	Int64	偏移量,默认0 示例值：
Limit	否	否	Int64	最大输出条数，默认20，最大为100 示例值：
Filters	否	否	Array of Filter	过滤条件示例值：查看
AllRegion	否	否	Bool	获取所有地域的实例，默认为False 示例值：

3. 输出参数

参数名称	类型	描述
TotalCount	Int64	总实例个数示例值：
Registries	Array of Registry	实例信息列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
MissingParameter
InternalError
InvalidParameter
InternalError.DbError
UnsupportedOperation
UnauthorizedOperation
UnknownParameter
OperationDenied	操作被拒绝。
ResourceInsufficient.ErrorInstanceNotRunning	实例状态异常。
FailedOperation

5. 示例

示例1 查看实例列表

输入示例

https://tcr.api3.fincloud.tencent.com/?Action=DescribeInstances
&<Common Parameters>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Registries": [
            {
                "RegistryId": "cls-xxxxxxx",
                "RegistryName": "aaa",
                "Status": "Running",
                "RegistryType": "standard",
                "PublicDomain": "mytest.cloudcloudcr.com",
                "CreateTime": "2019-08-09",
                "InternalEndpoint": "8.9.10.9",
                "ExpiredAt": "2020-09-10",
                "PayMod": 1,
                "RenewFlag": 1
            }
        ],
        "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
    }
}