1. 接口描述
接口请求域名: tsf.tencentcloudapi.com 。
获取部署组其他属性
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeGroupAttribute。 | 
| Version | 是 | String | 公共参数,本接口取值:2018-03-26。 | 
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 | 
| GroupId | 是 | String | 部署组ID,可通过调用DescribeContainerGroups查询已创建的部署组列表或登录控制台进行查看;也可以调用CreateContainGroup创建新的部署组。 示例值:group-6a79x94v | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Result | VmGroupOther | 虚拟机部署组信息 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 获取部署组其他属性
输入示例
https://tsf.tencentcloudapi.com/?Action=DescribeGroupAttribute
&GroupId=group-byxke4al
&<公共请求参数>输出示例
{
    "Response": {
        "RequestId": "0bd33701-90d0-413f-9ae9-3a89df2fa6ad",
        "Result": {
            "InstanceCount": 1,
            "GroupId": "group-byxke4al",
            "PackageId": "pkg-278c1954",
            "PackageVersion": "1.12.0_E",
            "PackageName": "consumer-demo-1.12.0-Edgware-SNAPSHOT.jar",
            "RunInstanceCount": 0,
            "GroupStatus": "Updating",
            "OffInstanceCount": 1,
            "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"
                }
            },
            "IsNotEqualServiceConfig": false
        }
    }
}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.GroupQueryFaild | 部署组查询失败。 | 
| FailedOperation.GroupQueryFailed | 部署组查询失败。 | 
| FailedOperation.TsfPrivilegeError | TSF权限模块异常,请联系系统管理员。 | 
| FailedOperation.UnhandledException | 模块未处理异常。 | 
| InternalError.GroupCommonError | 部署组通用异常。 | 
| InternalError.InstanceCommonError | TSF节点管理通用错误信息。 | 
| InternalError.UnhandledException | 模块未处理异常。 | 
| InvalidParameter.ParamError | 参数错误。 | 
| InvalidParameter.RepoPackageParamError | 请求参数有误。 | 
| ResourceNotFound.GroupNotExist | 此部署组不存在,无法执行该操作。 | 
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线。 | 
| UnauthorizedOperation.NoLicense | 缺少License,请参考购买指南购买TSF资源后重试。 |