获取部署组实例列表

最近更新时间: 2026-10-11 00:12:02

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.com。

获取部署组实例列表

默认接口请求频率限制：10000次/秒。

接口更新时间：2026-04-14 19:09:33。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribePodInstances
Version 是 否 String 公共参数，本接口取值：2018-03-26
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
TaskId 否 否 String 实例所属任务ID，登录控制台进行查看。
示例值： task-byx57oal
GroupId 是 否 String 实例所属部署组ID，按照【部署组ID】进行过滤，可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看；也可以调用CreateGroup创建新的项目。部署组ID例如：group-9yn2q8yd。部署组所在集群必须是活跃状态的。
示例值： group-byx57oal
Offset 否 否 Int64 偏移量，取值从0开始
示例值： 0
Limit 否 否 Int64 分页个数，默认为20， 取值应为1~50
示例值： 10
PodNameList 否 否 Array of String 用于通过PodName字段过滤返回结果。
示例值： []
DeployVersion 否 否 String 新老版本pod批次标识，old表示老版本，new表示新版本。
示例值： []

3. 输出参数

参数名称 类型 描述
Result GroupPodResult 查询的权限数据对象
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码 描述
FailedOperation.GroupQueryFailed 事务分组查询失败。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
FailedOperation.ContainergroupKuberneteConnectError 连接 kube-api-sever 失败。
FailedOperation.GroupQueryFaild 部署组查询失败。
InternalError.ContainergroupKuberneteConnectError 连接TKE服务失败。
InvalidParameterValue.ContainergroupLimitValueInvalid limit最大数量，默认 20, 最大值 50。
ResourceNotFound.ContainergroupGroupNamespaceClusterNotFound 无法找到该部署组所属集群和命名空间。
InvalidParameterValue.ContainergroupGroupidNull 部署组ID不能为空。
FailedOperation.ContainergroupKubernetesConnectError 调用 kube-api-server 失败。
ResourceNotFound.ClusterNotExist 无法获取命名空间所属集群。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
InvalidParameter.ParamError 参数错误。
FailedOperation.TsfPrivilegeError TSF权限模块异常，请联系系统管理员。。
InternalError.UnhandledException [%s]模块未处理异常。。
FailedOperation.InstanceQueryFailed 查询机器实例部分失败。
UnauthorizedOperation.NoLicense 缺少License。。

5. 示例

示例1 DescribePodInstances

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=DescribePodInstances
&GroupId=group-6a73w4v5
&Offset=0
&Limit=20
&<Common Parameters>

输出示例

{
    "Response": {
        "Result": {
            "Content": [
                {
                    "Status": "Running", 
                    "ReadyCount": 2, 
                    "RestartCount": 0, 
                    "ServiceInstanceStatus": "Running", 
                    "PodId": "pod-sss", 
                    "Ip": "10.0.1.1", 
                    "Reason": "failed", 
                    "InstanceAvailableStatus": "Running", 
                    "PodName": "pod-sss", 
                    "InstanceStatus": "Running", 
                    "NodeIp": "10.0.1.0", 
                    "Runtime": "runtime", 
                    "NodeInstanceId": "id", 
                    "CreatedAt": "time"
                }
            ], 
            "TotalCount": 1
        }, 
        "RequestId": "6d7e580e-4b1c-49a7-8ffd-21551f865643"
    }
}