获取虚拟机部署组列表

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

1. 接口描述

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

获取虚拟机部署组列表

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

接口更新时间：2026-02-04 22:45:48。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeGroups
Version 是 否 String 公共参数，本接口取值：2018-03-26
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Status 否 否 String 部署组状态过滤字段
示例值： Running、Waiting、Paused、Updating、RollingBack、Abnormal、Unknown
Offset 否 否 Int64 偏移量
示例值： 0
Limit 否 否 Int64 分页个数
示例值： 10
NamespaceId 否 否 String 命名空间ID
示例值： namespace-6a79x94v
GroupIdList 否 否 Array of String 无
示例值： ["group-6a79x94v"]
SearchWord 否 否 String 搜索字段
示例值： groupName
ApplicationId 否 否 String 应用ID
示例值： application-6a79x94v
OrderBy 否 否 String 排序字段
示例值： 1
OrderType 否 否 Int64 排序方式，0：升序，1：降序
示例值： group_name
ClusterId 否 否 String 集群ID
示例值： cluster-6a79x94v
GroupResourceTypeList 否 否 Array of String 部署组资源类型列表
示例值： ["GW"]

3. 输出参数

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

4. 错误码

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

错误码 描述
FailedOperation.GroupQueryFailed 事务分组查询失败。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
FailedOperation.GroupQueryFaild 部署组查询失败。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
FailedOperation.ClusterQueryFailed 查询集群失败。
MissingParameter.ClusterIdRequired 集群ID未填写。
InvalidParameter.ParamError 参数错误。
FailedOperation.TsfPrivilegeError TSF权限模块异常，请联系系统管理员。。
InternalError.UnhandledException [%s]模块未处理异常。。
InvalidParameterValue.GroupPageLimitInvalid 分组无效的分业参数。
UnauthorizedOperation.NoLicense 缺少License。。
InvalidParameterValue.GroupStatusInvalid 无效的部署组状态过滤字段。
FailedOperation.ApplicationQueryFailed 应用查询失败。
FailedOperation.NamespaceQueryFailed 命名空间查询失败。
FailedOperation.InstanceCommonError

5. 示例

示例1 获取虚拟机部署组列表

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeGroups
<Common Parameters>

{
  "Limit": 2
}

输出示例

{
  "Response": {
    "RequestId": "b1128c11-9b6d-4d06-814d-c3c561b79f6c",
    "Result": {
      "Content": [
        {
          "AgentProfileList": [],
          "Alias": "",
          "ApplicationId": "application-ydopqnxa",
          "ApplicationName": "shedfree-gw",
          "ApplicationType": "V",
          "ClusterId": "cluster-2vz3nd3a",
          "ClusterName": "shedfree",
          "CreateTime": "2024-12-23 16:27:02",
          "DeployDesc": "",
          "ForceStart": false,
          "GatewayConfig": "",
          "GroupDesc": "",
          "GroupId": "group-y4dz9x6y",
          "GroupName": "shed-scg-2021",
          "GroupResourceType": "DEF",
          "JdkName": "JDK",
          "JdkVersion": "8",
          "MicroserviceType": "G",
          "NamespaceId": "namespace-qab7bq9v",
          "NamespaceName": "shedfree_default",
          "OtAgentVersion": "none",
          "ServiceAgentVersion": "none",
          "ServiceSpecEncode": "",
          "StartScript": "",
          "StartupParameters": "-Xms1024m -Xmx4096m -XX:MetaspaceSize=1024m -XX:MaxMetaspaceSize=1024m -Dlogging.level.com.tsf.tsf.msgw.scg.filter=error -Dreactor.netty.pool.leasingStrategy=lifo  -Djdk.fiber.enabled=true",
          "Status": "status",
          "StopScript": "",
          "UpdateTime": "2024-12-24 09:21:23",
          "UpdateType": 0,
          "UpdatedTime": 1735003283000,
          "WarmupSetting": {
            "Curvature": 2,
            "Enabled": false,
            "EnabledProtection": true,
            "WarmupTime": 60
          }
        },
        {
          "AgentProfileList": [],
          "Alias": "",
          "ApplicationId": "application-ydopqnxa",
          "ApplicationName": "shedfree-gw",
          "ApplicationType": "V",
          "ClusterId": "cluster-2vz3nd3a",
          "ClusterName": "shedfree",
          "CreateTime": "2024-12-23 01:15:31",
          "DeployDesc": "desc",
          "ForceStart": false,
          "GatewayConfig": "",
          "GroupDesc": "desc",
          "GroupId": "group-yq9d6wev",
          "GroupName": "shed-zuul-3",
          "GroupResourceType": "DEF",
          "JdkName": "JDK",
          "JdkVersion": "8",
          "MicroserviceType": "G",
          "NamespaceId": "namespace-qab7bq9v",
          "NamespaceName": "shedfree_default",
          "OtAgentVersion": "none",
          "ServiceAgentVersion": "none",
          "ServiceSpecEncode": "",
          "StartScript": "",
          "StartupParameters": "-Xms1024m -Xmx4096m -XX:MetaspaceSize=1024m -XX:MaxMetaspaceSize=1024m",
          "Status": "status",
          "StopScript": "",
          "UpdateTime": "2024-12-23 01:30:25",
          "UpdateType": 0,
          "UpdatedTime": 1734888625000,
          "WarmupSetting": {
            "Curvature": 2,
            "Enabled": false,
            "EnabledProtection": true,
            "WarmupTime": 60
          }
        }
      ],
      "TotalCount": 660
    }
  }
}