1. 接口描述
接口请求域名: tat.tencentcloudapi.com 。
接口用于查询被托管的实例信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRegisterInstances。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 否 | Array of String | 实例id。 示例值:["rins-8d88xxxx"] |
Filters.N | 否 | Array of Filter | 过滤器列表。 - instance-name 按照【实例名称】进行过滤。 类型:String 必选:否 - instance-id 按照【实例ID】进行过滤。 类型:String 必选:否 - register-code-id 按照【注册码ID】进行过滤。 类型:String 必选:否 - sys-name 按照【操作系统类型】进行过滤,取值:Linux | Windows。 类型:String 必选:否 |
Offset | 否 | Integer | 偏移量,默认为 0。 示例值:0 |
Limit | 否 | Integer | 返回数量,默认为 20,最大值为 100。 示例值:10 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 该实例注册过的注册码总数。 示例值:10 |
RegisterInstanceSet | Array of RegisterInstanceInfo | 被托管的实例信息的列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 根据Filters查询托管实例
根据Filters查询托管实例。
输入示例
POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegisterInstances
<公共请求参数>
{
"Filters": [
{
"Name": "instance-name",
"Values": [
"abc"
]
}
],
"Offset": 0,
"Limit": 0
}
输出示例
{
"Response": {
"TotalCount": 0,
"RegisterInstanceSet": [
{
"RegisterCodeId": "abc",
"InstanceId": "abc",
"InstanceName": "abc",
"MachineId": "abc",
"SystemName": "abc",
"HostName": "abc",
"LocalIp": "abc",
"PublicKey": "abc",
"Status": "abc",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"UpdatedTime": "2020-09-22T00:00:00+00:00"
}
],
"RequestId": "abc"
}
}
示例2 根据托管实例ID查询托管实例
根据托管实例ID查询托管实例。
输入示例
POST / HTTP/1.1
Host: tat.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRegisterInstances
<公共请求参数>
{
"InstanceIds": [
"abc"
],
"Offset": 0,
"Limit": 0
}
输出示例
{
"Response": {
"TotalCount": 0,
"RegisterInstanceSet": [
{
"RegisterCodeId": "abc",
"InstanceId": "abc",
"InstanceName": "abc",
"MachineId": "abc",
"SystemName": "abc",
"HostName": "abc",
"LocalIp": "abc",
"PublicKey": "abc",
"Status": "abc",
"CreatedTime": "2020-09-22T00:00:00+00:00",
"UpdatedTime": "2020-09-22T00:00:00+00:00"
}
],
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.InvalidFilter | Filter 无效。 |
InvalidParameterValue.InvalidRegisterInstanceId | 无效的托管实例ID。 |
ResourceNotFound.RoleNotFound | 角色不存在。 |
UnauthorizedOperation.AssumeRoleUnauthorized | 角色扮演未授权。 |