微服务平台 TSF 获取部署组详情

1. 接口描述

接口请求域名： tsf.tencentcloudapi.com 。

获取部署组详情

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeContainerGroupDeployInfo。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
GroupId	是	String	实例所属 groupId 示例值：group-gyqpkzda

3. 输出参数

参数名称	类型	描述
Result	ContainerGroupDeploy	获取部署组
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeContainerGroupDeployInfo

输入示例

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

{
    "GroupId": "group-gyqpkzda"
}

输出示例

{
    "Response": {
        "Result": {
            "GroupId": "group-gyqpkzda",
            "GroupName": "group-test",
            "InstanceNum": 0,
            "CurrentNum": 0,
            "Server": "ccr.tencent.com",
            "Reponame": "tsf_1038293xxxxx/nginx",
            "TagName": "latest",
            "CpuRequest": "0.5",
            "CpuLimit": "1",
            "MemRequest": "64",
            "MemLimit": "512",
            "AccessType": 0,
            "ProtocolPorts": [
                {
                    "Protocol": "tcp",
                    "Port": 8080,
                    "TargetPort": 8080,
                    "NodePort": 0,
                    "Name": "tcp-8080"
                }
            ],
            "UpdateType": 0,
            "UpdateIvl": 0,
            "JvmOpts": "-Xmx1024m -Xms128m",
            "SubnetId": "subnet-gyqpkzda",
            "AgentCpuRequest": "0.1",
            "AgentCpuLimit": "0.2",
            "AgentMemRequest": "32",
            "AgentMemLimit": "128",
            "IstioCpuRequest": "0.1",
            "IstioCpuLimit": "0.2",
            "IstioMemRequest": "32",
            "IstioMemLimit": "128",
            "Envs": [
                {
                    "Name": "host",
                    "Value": "metadata.host",
                    "ValueFrom": {
                        "FieldRef": {
                            "FieldPath": "metadata.host"
                        },
                        "ResourceFieldRef": {
                            "Resource": "resource"
                        }
                    }
                }
            ],
            "HealthCheckSettings": {
                "LivenessProbe": {
                    "ActionType": "Port",
                    "InitialDelaySeconds": 60,
                    "TimeoutSeconds": 30,
                    "PeriodSeconds": 30,
                    "SuccessThreshold": 1,
                    "FailureThreshold": 3,
                    "Scheme": "tcp",
                    "Port": 8080,
                    "Path": "/health",
                    "Command": [
                        "sh health.sh"
                    ],
                    "Type": "TCP"
                },
                "ReadinessProbe": {
                    "ActionType": "Port",
                    "InitialDelaySeconds": 180,
                    "TimeoutSeconds": 30,
                    "PeriodSeconds": 30,
                    "SuccessThreshold": 1,
                    "FailureThreshold": 3,
                    "Scheme": "tcp",
                    "Port": 8080,
                    "Path": "/health",
                    "Command": [
                        "sh health.sh"
                    ],
                    "Type": "TCP"
                }
            },
            "DeployAgent": true,
            "Alias": "group-alias",
            "DisableService": true,
            "HeadlessService": true,
            "TcrRepoInfo": {
                "Region": "ap-guangzhou",
                "RegistryId": "reg-gyqpkzda",
                "RegistryName": "presonal-registry",
                "Namespace": "default",
                "RepoName": "nginx"
            },
            "VolumeInfos": [
                {
                    "VolumeType": "HOST",
                    "VolumeName": "host",
                    "VolumeConfig": "host",
                    "ConfigMapOptions": [
                        {
                            "Key": "host",
                            "Path": "/host",
                            "Mode": "host"
                        }
                    ],
                    "EmptyDirOption": {
                        "EnableMemory": true,
                        "StorageCapacity": 0,
                        "StorageUnit": "sunit",
                        "SizeLimit": "64"
                    }
                }
            ],
            "VolumeMountInfos": [
                {
                    "VolumeMountName": "mount-name",
                    "VolumeMountPath": "/config",
                    "VolumeMountSubPath": "/conf",
                    "ReadOrWrite": "777"
                }
            ],
            "KubeInjectEnable": true,
            "RepoType": "tcr",
            "WarmupSetting": {
                "Enabled": true,
                "WarmupTime": 1,
                "Curvature": 1,
                "EnabledProtection": true
            },
            "GatewayConfig": {
                "Name": "gateway-config-test"
            },
            "ContainerName": "group-name-279128-28nsu82",
            "AdditionalContainerList": [
                {
                    "ContainerName": "agent",
                    "TagName": "v1",
                    "RepoName": "agent",
                    "RepoType": "tcr",
                    "TcrRepoInfo": {
                        "Region": "ap-guangzhou",
                        "RegistryId": "reg-gyqpkzda",
                        "RegistryName": "agent",
                        "Namespace": "default",
                        "RepoName": "agent"
                    },
                    "Server": "ccr.tencent.com",
                    "SecretName": "default-secret-name",
                    "JvmOpts": "-Xmx64m -Xms32m",
                    "CpuLimit": "1",
                    "CpuRequest": "0.1",
                    "MemRequest": "32",
                    "MemLimit": "128",
                    "HealthCheckSettings": {
                        "LivenessProbe": {
                            "ActionType": "tcp",
                            "InitialDelaySeconds": 180,
                            "TimeoutSeconds": 1,
                            "PeriodSeconds": 1,
                            "SuccessThreshold": 1,
                            "FailureThreshold": 1,
                            "Scheme": "http",
                            "Port": 1,
                            "Path": "/health",
                            "Command": [
                                "sh health.sh"
                            ],
                            "Type": "TCP"
                        }
                    },
                    "Envs": [
                        {
                            "Name": "host",
                            "Value": "metadata.host",
                            "ValueFrom": {
                                "FieldRef": {
                                    "FieldPath": "metadata.host"
                                },
                                "ResourceFieldRef": {
                                    "Resource": "metadata.host"
                                }
                            }
                        }
                    ],
                    "UserEnvs": [
                        {
                            "Name": "consul_ip",
                            "Value": "10.23.12.3"
                        }
                    ],
                    "VolumeMountInfoList": [
                        {
                            "VolumeMountName": "host",
                            "VolumeMountPath": "/host",
                            "VolumeMountSubPath": "/config",
                            "ReadOrWrite": "777"
                        }
                    ]
                }
            ],
            "InternalContainerList": [
                {
                    "ContainerName": "internal-container-test",
                    "TagName": "v1",
                    "RepoName": "nginx",
                    "RepoType": "tcr",
                    "TcrRepoInfo": {
                        "Region": "ap-guangzhou",
                        "RegistryId": "reg-6a79x94v",
                        "RegistryName": "nginx",
                        "Namespace": "default",
                        "RepoName": "nginx"
                    },
                    "Server": "ccr.ccs.tencent.com",
                    "SecretName": "default-secretName",
                    "JvmOpts": "-Xmx64m -Xms32m",
                    "CpuLimit": "1",
                    "CpuRequest": "0.1",
                    "MemRequest": "32",
                    "MemLimit": "128",
                    "HealthCheckSettings": {},
                    "VolumeMountInfoList": [
                        {
                            "VolumeMountName": "host",
                            "VolumeMountPath": "/host",
                            "VolumeMountSubPath": "/config",
                            "ReadOrWrite": "777"
                        }
                    ]
                }
            ]
        },
        "RequestId": "96561cf1-738a-47d6-943b-dec7ebbccabe"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

近期搜索热词

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

云函数

私有网络

批量计算

API 网关

专线接入

对象存储

微服务平台 TSF

文件存储

消息队列 CKafka 版

全站加速网络

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

数据传输服务

全球应用加速

腾讯云区块链服务平台 TBaaS

云拨测

访问管理

主机安全

标签

DDoS 防护

密钥管理系统

Web 应用防火墙

操作审计

域名注册

SSL 证书

数据万象

短信

NLP 技术

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

文字识别

流计算 Oceanus

腾讯云数据仓库 TCHouse-P

人脸识别

Elasticsearch Service

集团账号管理

口语评测（基础版）

图像识别

媒体处理

云直播

云联络中心

机器翻译

物联网通信

人脸融合

游戏数据库 TcaplusDB

弹性 MapReduce

游戏多媒体引擎

腾讯云 BI

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

分布式身份

数据加速器 GooseFS

腾讯云健康看板

统一 Catalog 服务

消息队列 RabbitMQ 版

声音复刻

文旅客情大数据

实时互动-工业能源版

腾讯健康组学平台

大模型图像创作引擎

云压测