1. 接口描述
接口请求域名： tcss.tencentcloudapi.com 。
查询集群节点信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusterNodes。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ClusterId | 否 | String | 集群Id,不输入表示查询所有 示例值：cls-as2mkd13 |
| Offset | 否 | Integer | 偏移量 示例值：3 |
| Limit | 否 | Integer | 每次查询的最大记录数量 示例值：10 |
| Filters.N | 否 | Array of ComplianceFilters | Name 可取值： DefendStatus（防护状态）: Defended 已防护 UnDefended 未防护 AgentStatus (容器agent状态): OFFLINE 离线 ONLINE 在线 UNINSTALL 未安装 InstanceState (节点状态): Running 运行中 Ready 准备 Notready 未准备好 Initializing 初始化 Failed 失败 Error 错误 InstanceRole (节点角色) WORKER 工作节点 MASTER_ETCD 主节点 SUPER 超级节点 |
| By | 否 | String | 排序字段 |
| Order | 否 | String | 排序方式 asc,desc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数 示例值：20 |
| ClusterNodeList | Array of ClusterNodeInfo | 节点列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群节点信息
查询集群节点信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterNodes
<公共请求参数>
{
"ClusterId": "abc",
"Offset": 1,
"Limit": 1,
"Filters": [
{
"Name": "abc",
"Values": [
"abc"
],
"ExactMatch": true
}
],
"By": "abc",
"Order": "abc"
}输出示例
{
"Response": {
"TotalCount": 1,
"ClusterNodeList": [
{
"InstanceId": "abc",
"PrivateIpAddresses": "abc",
"InstanceRole": "abc",
"InstanceState": "abc",
"NodeName": "abc",
"AgentStatus": "abc",
"PublicIP": "abc",
"HostID": "abc",
"MachineType": "abc",
"NodeType": "abc"
}
],
"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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |