1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
获取部署组其他字段-用于前端并发调用
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeContainerGroupAttribute。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| GroupId | 是 | String | 部署组ID,可通过调用DescribeContainerGroups查询已创建的部署组列表或登录控制台进行查看;也可以调用CreateContainGroup创建新的部署组。 示例值:group-ab958z6y | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | ContainerGroupOther | 部署组列表-其它字段 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 部署组列表
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeContainerGroupAttribute
<公共请求参数>
{
    "GroupId": "group-ab958z6y"
}输出示例
{
    "Response": {
        "RequestId": "d1b09f98-d331-4de4-8560-d8915775fa37",
        "Result": {
            "ClusterIp": "9.166.255.154",
            "CurrentNum": 1,
            "Envs": [
                {
                    "Name": "JAVA_TOOL_OPTIONS",
                    "Value": " -Xloggc:/data/tsf_apm/monitor/jvm-metrics/gclog.log ",
                    "ValueFrom": null
                },
                {
                    "Name": "SERVICE_AGENT_VERSION",
                    "Value": "none",
                    "ValueFrom": null
                },
                {
                    "Name": "OT_AGENT_VERSION",
                    "Value": "none",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_app_id",
                    "Value": "1300555551",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_application_id",
                    "Value": "application-vz6mr4pa",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_cluster_id",
                    "Value": "cls-n6e3qw5s",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_namespace_id",
                    "Value": "namespace-vkoezbka",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_group_id",
                    "Value": "group-ab958z6y",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_prog_version",
                    "Value": "20230410145308",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_token",
                    "Value": "MFM-p5wTm0Hj__K_ri4Nui4QV-W51_ETokA1toi_AV8=",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_region",
                    "Value": "ap-guangzhou",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_ratelimit_master_ip",
                    "Value": "169.254.0.77",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_ratelimit_master_port",
                    "Value": "7000",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_consul_ip",
                    "Value": "169.254.0.77",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_consul_port",
                    "Value": "8000",
                    "ValueFrom": null
                },
                {
                    "Name": "JAVA_OPTS",
                    "Value": "-Xms128m -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_event_master_ip",
                    "Value": "169.254.0.77",
                    "ValueFrom": null
                },
                {
                    "Name": "tsf_event_master_port",
                    "Value": "15200",
                    "ValueFrom": null
                }
            ],
            "HealthCheckSettings": {
                "LivenessProbe": null,
                "ReadinessProbe": null
            },
            "InstanceNum": 1,
            "IsNotEqualServiceConfig": false,
            "LbDns": "dns.com",
            "LbIp": "119.29.122.212",
            "Message": "this is a  msg",
            "NodePort": 30111,
            "Status": "Running",
            "SubnetId": ""
        }
    }
}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.ApplicationQueryFailed | 应用查询失败。 | 
| FailedOperation.CdiStatusFailed | 调用CDI状态接口失败 | 
| FailedOperation.CdiStatusInvalid | 调用CDI状态返回数据异常 | 
| FailedOperation.ContainergroupKubernetesConnectError | 调用 kube-api-server 失败。 | 
| FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。 | 
| InternalError.ContainergroupKubernetesConnectError | 连接TKE服务失败。 | 
| InternalError.ContainergroupSqlFailed | 容器应用SQL错误。 | 
| InternalError.UnhandledException | 模块未处理异常。 | 
| ResourceNotFound.ClusterNotExist | 无法获取命名空间所属集群。 | 
| ResourceNotFound.ContainergroupGroupNamespaceClusterNotFound | 无法找到该部署组所属集群和命名空间。 | 
| ResourceNotFound.ContainergroupGroupNotFound | 无法找到该部署组。 | 
| ResourceNotFound.GroupApplicationNotExist | 无法获取分组所属应用。 | 
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 | 
| UnauthorizedOperation.NoLicense | 缺少License,请参考购买指南购买TSF资源后重试。 | 
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。 |