1. 接口描述
接口请求域名: tiems.tencentcloudapi.com 。
获取节点列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstances。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-16。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Filters.N | 否 | Array of Filter | 筛选选项 |
Offset | 否 | Integer | 偏移量,默认为0 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为200 |
Order | 否 | String | 输出列表的排列顺序。取值范围:ASC:升序排列 DESC:降序排列 |
OrderField | 否 | String | 排序的依据字段, 取值范围 "CREATE_TIME", "UPDATE_TIME", "NAME" |
ResourceGroupId | 否 | String | 要查询的资源组 ID |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 资源组下节点总数 |
Instances | Array of Instance | 资源组下节点列表 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 展示用户当前地域下所有节点
输入示例
https://tiems.tencentcloudapi.com/?Action=DescribeInstances
&<公共请求参数>
输出示例
{
"Response": {
"Instances": [
{
"AbnormalReason": "",
"Cpu": 24,
"CpuRequested": 0,
"Created": "2019-11-06T16:18:22+08:00",
"DeadlineTime": "2020-02-06T16:18:36+08:00",
"Gpu": 0,
"GpuRequested": 0,
"Id": "ins-19a065ev",
"InstanceChargeType": "PREPAID",
"InstanceType": "sv_tiems_instance_24c48g",
"Memory": 48,
"MemoryRequested": 0,
"Region": "ap-beijing",
"RenewFlag": "DISABLE_NOTIFY_AND_MANUAL_RENEW",
"ResourceGroupId": "fl2hrhgp97jcg8pf",
"State": "Running",
"Updated": "2019-11-07T20:50:34+08:00",
"Zone": "ap-beijing-2"
},
{
"AbnormalReason": "",
"Cpu": 24,
"CpuRequested": 0,
"Created": "2019-11-06T16:18:22+08:00",
"DeadlineTime": "2020-02-06T16:18:29+08:00",
"Gpu": 0,
"GpuRequested": 0,
"Id": "ins-19a066i9",
"InstanceChargeType": "PREPAID",
"InstanceType": "sv_tiems_instance_24c48g",
"Memory": 48,
"MemoryRequested": 0,
"Region": "ap-beijing",
"RenewFlag": "DISABLE_NOTIFY_AND_MANUAL_RENEW",
"ResourceGroupId": "pf2kdwlmn9s2wq5m",
"State": "Running",
"Updated": "2019-11-07T20:50:34+08:00",
"Zone": "ap-beijing-2"
}
],
"RequestId": "675e9ba8-f0ad-4727-83cc-384ee8089ac6",
"TotalCount": 2
}
}
示例2 展示用户当前地域下某资源组的所有节点
输入示例
https://tiems.tencentcloudapi.com/?Action=DescribeInstances
&ResourceGroupId=pf2kdwlmn9s2wq5m
&<公共请求参数>
输出示例
{
"Response": {
"Instances": [
{
"AbnormalReason": "",
"Cpu": 24,
"CpuRequested": 0,
"Created": "2019-11-06T16:18:22+08:00",
"DeadlineTime": "2020-02-06T16:18:29+08:00",
"Gpu": 0,
"GpuRequested": 0,
"Id": "ins-19a066i9",
"InstanceChargeType": "PREPAID",
"InstanceType": "sv_tiems_instance_24c48g",
"Memory": 48,
"MemoryRequested": 0,
"Region": "ap-beijing",
"RenewFlag": "DISABLE_NOTIFY_AND_MANUAL_RENEW",
"ResourceGroupId": "pf2kdwlmn9s2wq5m",
"State": "Running",
"Updated": "2019-11-07T20:50:34+08:00",
"Zone": "ap-beijing-2"
}
],
"RequestId": "6c6ebb92-5ede-491e-ab88-d49cb3dc22a1",
"TotalCount": 1
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
ResourceNotFound | 资源不存在。 |