获取部署组实例列表

最近更新时间: 2026-09-17 00:03:55

1. 接口描述

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

获取部署组实例列表

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

接口更新时间：2025-08-22 15:09:37。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribePodInstances
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId	是	否	String	实例所属groupId 示例值：
Offset	否	否	Int64	偏移量，取值从0开始示例值：
Limit	否	否	Int64	分页个数，默认为20，取值应为1~50 示例值：
PodNameList	否	否	Array of String	过滤字段示例值：
DeployVersion	否	否	String	变更批次 -- test 示例值：
TaskId	否	否	String	TaskId -- test 示例值：

3. 输出参数

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

4. 错误码

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

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

5. 示例

示例1 DescribePodInstances

输入示例

https://tsf.api3.<no value>/?Action=DescribePodInstances
&GroupId=group-6a73w4v5
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "Content": [
                {
                    "Status": "xx", 
                    "ReadyCount": 2, 
                    "RestartCount": 0, 
                    "ServiceInstanceStatus": "xx", 
                    "PodId": "xx", 
                    "Ip": "xx", 
                    "Reason": "xx", 
                    "InstanceAvailableStatus": "xx", 
                    "PodName": "xx", 
                    "InstanceStatus": "xx", 
                    "NodeIp": "xx", 
                    "Runtime": "xx", 
                    "NodeInstanceId": "xx", 
                    "CreatedAt": "xx"
                }
            ], 
            "TotalCount": 1
        }, 
        "RequestId": "xx"
    }
}