获取部署组详情

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

1. 接口描述

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

获取部署组详情

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

接口更新时间:2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeContainerGroupDeployInfo
Version String 公共参数,本接口取值:2018-03-26
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId String 实例所属 groupId
示例值:

3. 输出参数

参数名称 类型 描述
Result ContainerGroupDeploy 获取部署组
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter.ParamError 参数错误。
ResourceNotFound.ClusterNotExist 无法获取命名空间所属集群。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
FailedOperation.TsfPrivilegeError TSF权限模块异常,请联系系统管理员。。
InternalError.ContainergroupSqlFailed 容器应用SQL错误。
InvalidParameterValue.ContainergroupGroupidNull 部署组ID不能为空。
ResourceNotFound.ContainergroupGroupNotFound 无法找到该部署组。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense 缺少License。。
MissingParameter.SystemParameterRequired 未指定%s。。

5. 示例

示例1 DescribeContainerGroupDeployInfo

输入示例

POST / HTTP/1.1
Host: tsf.api3.<no value>
Content-Type: application/json
X-TC-Action: DescribeContainerGroupDeployInfo
<公共请求参数>

{
    "GroupId": "group-gyqpkzda"
}

输出示例

{
    "Response": {
        "Result": {
            "HealthCheckSettings": {
                "ReadinessProbe": {
                    "TimeoutSeconds": 1, 
                    "InitialDelaySeconds": 1, 
                    "PeriodSeconds": 1, 
                    "ActionType": "xx", 
                    "Path": "xx", 
                    "Command": [
                        "xx"
                    ], 
                    "SuccessThreshold": 1, 
                    "Scheme": "xx", 
                    "Type": "xx", 
                    "Port": 1, 
                    "FailureThreshold": 1
                }, 
                "LivenessProbe": {
                    "TimeoutSeconds": 1, 
                    "InitialDelaySeconds": 1, 
                    "PeriodSeconds": 1, 
                    "ActionType": "xx", 
                    "Path": "xx", 
                    "Command": [
                        "xx"
                    ], 
                    "SuccessThreshold": 1, 
                    "Scheme": "xx", 
                    "Type": "xx", 
                    "Port": 1, 
                    "FailureThreshold": 1
                }
            }, 
            "InstanceNum": 1, 
            "AgentMemLimit": "xx", 
            "HeadlessService": true, 
            "CurrentNum": 0, 
            "MemRequest": "xx", 
            "IstioCpuRequest": "xx", 
            "AccessType": 2, 
            "UpdateIvl": 10, 
            "JvmOpts": "xx", 
            "IstioCpuLimit": "xx", 
            "SubnetId": "xx", 
            "AgentCpuRequest": "xx", 
            "MemLimit": "xx", 
            "CpuLimit": "xx", 
            "Envs": [
                {
                    "ValueFrom": {
                        "FieldRef": {
                            "FieldPath": "xx"
                        }, 
                        "ResourceFieldRef": {
                            "Resource": "xx"
                        }
                    }, 
                    "Name": "xx", 
                    "Value": "xx"
                }
            ], 
            "ProtocolPorts": [
                {
                    "TargetPort": 30032, 
                    "Protocol": "xx", 
                    "Port": 30032, 
                    "NodePort": 0
                }
            ], 
            "AgentMemRequest": "xx", 
            "IstioMemLimit": "xx", 
            "UpdateType": 1, 
            "Server": "xx", 
            "GroupName": "xx", 
            "TcrRepoInfo": {
                "RegistryName": "xx", 
                "Namespace": "xx", 
                "Region": "xx", 
                "RegistryId": "xx", 
                "RepoName": "xx"
            }, 
            "DisableService": true, 
            "IstioMemRequest": "xx", 
            "Alias": "xx", 
            "DeployAgent": true, 
            "AgentCpuLimit": "xx", 
            "Reponame": "xx", 
            "CpuRequest": "xx", 
            "GroupId": "xx", 
            "TagName": "xx"
        }, 
        "RequestId": "xx"
    }
}