1. 接口描述
接口请求域名： tsf.tencentcloudapi.com 。
获取部署组详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeContainerGroupDeployInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-26。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| GroupId | 是 | String | 部署组ID，可通过调用DescribeContainerGroups查询已创建的部署组列表或登录控制台进行查看；也可以调用CreateContainGroup创建新的部署组。 示例值：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": {
"ReadinessProbe": {
"InitialDelaySeconds": 10,
"PeriodSeconds": 10,
"Port": 8000,
"ActionType": "tcp",
"SuccessThreshold": 3,
"Type": "TCP",
"TimeoutSeconds": 3,
"FailureThreshold": 3
},
"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": {
"ReadinessProbe": {
"InitialDelaySeconds": 10,
"PeriodSeconds": 10,
"Port": 8000,
"ActionType": "tcp",
"SuccessThreshold": 3,
"Type": "TCP",
"TimeoutSeconds": 3,
"FailureThreshold": 3
},
"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"
}
},
"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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
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 | 示例：未指定language。 |
| ResourceNotFound.ClusterNotExist | 无法获取命名空间所属集群。 |
| ResourceNotFound.ContainergroupGroupNotFound | 无法找到该部署组。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 |
| UnauthorizedOperation.NoLicense | 缺少License，请参考购买指南购买TSF资源后重试。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。 |
