查询服务pod节点信息
最近更新时间: 2026-09-17 00:05:51
1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.cn。
查询容器集群服务pod节点信息
默认接口请求频率限制:20次/秒。
接口更新时间:2025-09-12 15:20:30。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeServicePodNodeInfos |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例ID 示例值: tbds-aqy2cvg6 |
| ServiceGroup | 否 | 否 | Int64 | 服务组类型 示例值: 24 |
| ServiceType | 否 | 否 | Int64 | 服务节点类型 示例值: 50 |
| Offset | 否 | 否 | Int64 | 页编号,默认值为0,表示第一页 示例值: 0 |
| Limit | 否 | 否 | Int64 | 每页返回数量,默认值为10,最大值为10 示例值: 10 |
| OrderPairs | 否 | 否 | Array of OrderPair | LastRestartTime排序字段 示例值:查看 |
| Filters | 否 | 否 | Array of Filters | 筛选条件PodName HealthStatus PodStatus 示例值:查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 总数 示例值: 1 |
| ServicePodNodeList | Array of PodNodeDetailInfo | 服务节点详情 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.ServiceNodeNotFound | 服务节点没有找到。 |
| InvalidParameter.InvalidAppId | 无效参数,AppId。 |
| InternalError | 内部错误。 |
| ResourceNotFound.ServiceGroupNotFound | 无法找到该服务组件。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
5. 示例
示例1 查询服务pod节点信息
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeServicePodNodeInfos
<公共请求参数>
{
"ServiceType": 50,
"InstanceId": "tbds-aqy2cvg6",
"ServiceGroup": 24,
"Offset": 0,
"Limit": 10
}
输出示例
{
"Response": {
"RequestId": "d297d29c-53da-4715-a995-9954e0a1d675",
"ServicePodNodeList": [
{
"HealthStatus": {
"Code": 1,
"Desc": "Running",
"Text": "Running"
},
"LastRestartTime": "2025-05-19 00:00:16",
"PodIp": "172.16.3.27",
"PodName": "tbds-aqy2cvg6-knox-gateway-0",
"PodStatus": "Running",
"RestartCount": 0
}
],
"TotalCount": 1
}
}