获取虚拟机部署组列表

最近更新时间: 2026-09-17 00:04:01

1. 接口描述

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

获取虚拟机部署组列表

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

接口更新时间：2025-08-22 14:56:50。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeGroups
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
SearchWord	否	否	String	搜索字段示例值：
ApplicationId	否	否	String	应用ID 示例值：
OrderBy	否	否	String	排序字段示例值：
OrderType	否	否	Int64	排序方式示例值：
Offset	否	否	Int64	偏移量示例值：
Limit	否	否	Int64	分页个数示例值：
NamespaceId	否	否	String	命名空间ID 示例值：
ClusterId	否	否	String	集群ID 示例值：
GroupResourceTypeList	否	否	Array of String	部署组资源类型列表示例值：
Status	否	否	String	部署组状态过滤字段示例值：
GroupIdList	否	否	Array of String	无示例值：

3. 输出参数

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

4. 错误码

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

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

5. 示例

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

输入示例

https://tsf.api3.<no value>/?Action=DescribeGroups
&ApplicationId=application-xxxxxxx
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "4bf8bc01-2786-4341-be2b-c6610556026e",
    "Result": {
      "TotalCount": 1,
      "Content": [
        {
          "ApplicationType": "V",
          "MicroserviceType": "N",
          "GroupId": "group-xxxxxxx",
          "ClusterId": "cluster-xxxxxxx",
          "Operator": null,
          "StartupParameters": "-Xms128m -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m",
          "ClusterName": "test",
          "Action": "DescribeGroups",
          "ApplicationName": "test1",
          "NamespaceName": "test2",
          "GroupDesc": null,
          "UpdateTime": "2019-03-11 16:51:55",
          "GroupName": "test",
          "NamespaceId": "namespace-xxxxxxx",
          "CreateTime": "2019-03-11 16:51:55",
          "ApplicationId": "application-xxxxxxx",
          "ProjectId": null
        }
      ]
    }
  }
}