接口请求域名： tat.intl.tencentcloudapi.com 。
接口用于查询被托管的实例信息。
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRegisterInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceIds.N | 否 | Array of String | 托管实例 id。 每次请求的上限为 100。 参数不支持同时指定 InstanceIds 和 Filters 。 |
| Filters.N | 否 | Array of Filter | 过滤器列表。每次请求的 Filters 的上限为 10，Filter.Values 的上限为 5。参数不支持同时指定 InstanceIds 和 Filters 。- instance-name 按照【托管实例名称】进行过滤。 类型：String 必选：否 - instance-id 按照【托管实例ID】进行过滤。 类型：String 必选：否 - register-status 按照【托管实例状态】进行过滤，取值：Online |
| Offset | 否 | Integer | 偏移量，默认为 0。 |
| Limit | 否 | Integer | 返回数量，默认为 20，最大值为 100。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 该实例注册过的注册码总数。 |
| RegisterInstanceSet | Array of RegisterInstanceInfo | 被托管的实例信息的列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
根据Filters查询托管实例。
POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegisterInstances
<公共请求参数>
{
"Filters": [
{
"Name": "instance-name",
"Values": [
"WebServer-01"
]
}
],
"Offset": 0,
"Limit": 1
}
{
"Response": {
"TotalCount": 1,
"RegisterInstanceSet": [
{
"RegisterCodeId": "d0b7xxxx-a6xx-40x9-898x-44c9f508axxx",
"InstanceId": "rins-uf673dgi",
"InstanceName": "WebServer-01",
"MachineId": "22c4dvvv-3ae9-4ff3-8331-d44147c96f8b",
"SystemName": "Windows",
"HostName": "webserver01",
"LocalIp": "10.0.0.1",
"PublicKey": "-----BEGIN RSA PUBLIC KEY-----\nAAAAAAAAAQEA1vVOon7U12dLFl7AOZjGnfWSMJ4rhHAagLne85Qbyn7rrow90bZF\ngsO9cpUfljliymtGAe1ZxkZZAWbwYeiS+x3KMO3rsbaXZtb9CiPSuMmyCcoyNRWy\nztLhIAHz6TFdoYYPdepY/HrL1rppGaVvUT6ufZrWIw2wF4KzPsIwGmfKYDrP+JOd\nfxkdewMwaFUP8xotqF+qi6YVbBMYSEGQyU9n42FTNxHMsLrBf1yPIcyaD+itWbWk\nyG0KcHTF2gbtgHqGV9wkc5jcqJYK3iJ1bQgEIWZ1lThRncOnHKHmSEnQ/XD5+6Hi\nLdVILVm0Gu8cnelE34kTcIqUAIQcB9wJBBBBBBBB\n-----END RSA PUBLIC KEY-----\n",
"Status": "Online",
"CreatedTime": "2020-09-22T08:00:00Z",
"UpdatedTime": "2020-09-22T08:00:00Z"
}
],
"RequestId": "e28b9a8c-d7d3-4a12-bf8a-0123456789ab"
}
}
根据托管实例ID查询托管实例。
POST / HTTP/1.1
Host: tat.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegisterInstances
<公共请求参数>
{
"InstanceIds": [
"rins-uf673dgi"
],
"Offset": 0,
"Limit": 1
}
{
"Response": {
"TotalCount": 1,
"RegisterInstanceSet": [
{
"RegisterCodeId": "d0b7xxxx-a6xx-40x9-898x-44c9f508axxx",
"InstanceId": "rins-uf673dgi",
"InstanceName": "WebServer-01",
"MachineId": "22c4dvvv-3ae9-4ff3-8331-d44147c96f8b",
"SystemName": "Windows",
"HostName": "webserver01",
"LocalIp": "10.0.0.1",
"PublicKey": "-----BEGIN RSA PUBLIC KEY-----\nAAAAAAAAAQEA1vVOon7U12dLFl7AOZjGnfWSMJ4rhHAagLne85Qbyn7rrow90bZF\ngsO9cpUfljliymtGAe1ZxkZZAWbwYeiS+x3KMO3rsbaXZtb9CiPSuMmyCcoyNRWy\nztLhIAHz6TFdoYYPdepY/HrL1rppGaVvUT6ufZrWIw2wF4KzPsIwGmfKYDrP+JOd\nfxkdewMwaFUP8xotqF+qi6YVbBMYSEGQyU9n42FTNxHMsLrBf1yPIcyaD+itWbWk\nyG0KcHTF2gbtgHqGV9wkc5jcqJYK3iJ1bQgEIWZ1lThRncOnHKHmSEnQ/XD5+6Hi\nLdVILVm0Gu8cnelE34kTcIqUAIQcB9wJBBBBBBBB\n-----END RSA PUBLIC KEY-----\n",
"Status": "Online",
"CreatedTime": "2020-09-22T08:00:00Z",
"UpdatedTime": "2020-09-22T08:00:00Z"
}
],
"RequestId": "e28b9a8c-d7d3-4a12-bf8a-0123456789ab"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidFilter | Filter 无效。 |
| InvalidParameterValue.InvalidRegisterInstanceId | 无效的托管实例ID。 |
| ResourceNotFound.RoleNotFound | 角色不存在。 |
| UnauthorizedOperation.AssumeRoleUnauthorized | 角色扮演未授权。 |
文档反馈