获取部署组其他属性

最近更新时间: 2026-10-11 00:12:02

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.com。

获取部署组其他属性

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

接口更新时间：2026-02-04 23:07:49。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeGroupAttribute
Version 是 否 String 公共参数，本接口取值：2018-03-26
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId 是 否 String 部署组ID，按照【部署组ID】进行过滤，可通过调用DescribeGroups查询已创建的项目列表或登录控制台进行查看；也可以调用CreateGroup创建新的项目。部署组ID例如：group-ab958z6y
示例值：  

3. 输出参数

参数名称 类型 描述
Result VmGroupOther 虚拟机部署组信息
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
FailedOperation.GroupQueryFailed 事务分组查询失败。
FailedOperation.GroupQueryFaild 部署组查询失败。
FailedOperation.UnhandledException 模块未处理异常。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
ResourceNotFound.GroupNotExist 此部署组不存在，无法执行该操作。
InternalError.GroupCommonError 部署组通用异常。
InvalidParameter.ParamError 参数错误。
FailedOperation.TsfPrivilegeError TSF权限模块异常，请联系系统管理员。。
InternalError.UnhandledException [%s]模块未处理异常。。
InternalError.InstanceCommonError TSF节点管理通用错误信息。
UnauthorizedOperation.NoLicense 缺少License。。
InvalidParameter.RepoPackageParamError 请求参数有误。
FailedOperation.ApplicationQueryFailed 应用查询失败。
FailedOperation.ActionReadTimeout 模块请求未响应。

5. 示例

示例1 获取部署组其他属性

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=DescribeGroupAttribute
&GroupId=group-byxke4al
&<Common Parameters>

输出示例

{
  "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
    }
  }
}