1. 接口描述
接口请求域名： cdwch.tencentcloudapi.com 。
获取实例节点信息列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstanceNodes。 |
| Version | 是 | String | 公共参数，本接口取值：2020-09-15。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群实例ID 示例值：cdwch-12345678 |
| NodeRole | 否 | String | 集群角色类型，默认为 "data"数据节点 示例值：DATA |
| Offset | 否 | Integer | 分页参数，第一页为0，第二页为10 示例值：0 |
| Limit | 否 | Integer | 分页参数，分页步长，默认为10 示例值：100 |
| DisplayPolicy | 否 | String | 展现策略，All时显示所有 示例值：All |
| ForceAll | 否 | Boolean | 当true的时候返回所有节点，即Limit无限大 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数 示例值：2 |
| InstanceNodesList | Array of InstanceNode | 实例节点总数 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取实例节点信息列表
获取实例节点信息列表
输入示例
https://cdwch.tencentcloudapi.com/?Action=DescribeInstanceNodes
&InstanceId=cdwch-12345678
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "f510b0e8-4bc7-44c7-a191-79e467b556c4",
"TotalCount": 2,
"InstanceNodesList": [
{
"Ip": "172.31.1.5",
"Spec": "CVM.SA2",
"Core": 16,
"Memory": 32,
"DiskType": "CLOUD_PREMIUM",
"DiskSize": 1000,
"Cluster": "default-cluster"
},
{
"Ip": "172.31.1.4",
"Spec": "CVM.SA2",
"Core": 16,
"Memory": 32,
"DiskType": "CLOUD_PREMIUM",
"DiskSize": 1000,
"Cluster": "default-cluster"
}
]
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。