获取虚拟机部署组列表

最近更新时间:2025-02-27 02:08:00

我的收藏

1. 接口描述

接口请求域名: tsf.tencentcloudapi.com 。

获取虚拟机部署组列表

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeGroups。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
SearchWord String 搜索字段
示例值:groupName
ApplicationId String 应用ID
示例值:application-6a79x94v
OrderBy String 排序字段
示例值:group_name
OrderType Integer 排序方式
示例值:DESC
Offset Integer 偏移量
示例值:0
Limit Integer 分页个数
示例值:10
NamespaceId String 命名空间ID
示例值:namespace-6a79x94v
ClusterId String 集群ID
示例值:cluster-6a79x94v
GroupResourceTypeList.N Array of String 部署组资源类型列表
示例值:["DEF"]
Status String 部署组状态过滤字段
示例值:RUNNING
GroupIdList.N Array of String
示例值:["group-6a79x94v"]

3. 输出参数

参数名称 类型 描述
Result TsfPageVmGroup 虚拟机部署组分页信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGroups
<公共请求参数>

{
    "Limit": 2
}

输出示例

{
    "Response": {
        "RequestId": "b1128c11-9b6d-4d06-814d-c3c561b79f6c",
        "Result": {
            "Content": [
                {
                    "Alias": "",
                    "ApplicationId": "application-ydopqnxa",
                    "ApplicationName": "shedfree-gw",
                    "ApplicationType": "V",
                    "ClusterId": "cluster-2vz3nd3a",
                    "ClusterName": "shedfree",
                    "CreateTime": "2024-12-23 16:27:02",
                    "DeployDesc": null,
                    "GroupDesc": null,
                    "GroupId": "group-y4dz9x6y",
                    "GroupName": "shed-scg-2021",
                    "GroupResourceType": "DEF",
                    "MicroserviceType": "G",
                    "NamespaceId": "namespace-qab7bq9v",
                    "NamespaceName": "shedfree_default",
                    "StartupParameters": "-Xms1024m -Xmx4096m -XX:MetaspaceSize=1024m -XX:MaxMetaspaceSize=1024m -Dlogging.level.com.tencent.tsf.msgw.scg.filter=error -Dreactor.netty.pool.leasingStrategy=lifo  -Dkona.fiber.enabled=true",
                    "UpdateTime": "2024-12-24 09:21:23",
                    "UpdatedTime": 1735003283000
                },
                {
                    "Alias": "",
                    "ApplicationId": "application-ydopqnxa",
                    "ApplicationName": "shedfree-gw",
                    "ApplicationType": "V",
                    "ClusterId": "cluster-2vz3nd3a",
                    "ClusterName": "shedfree",
                    "CreateTime": "2024-12-23 01:15:31",
                    "DeployDesc": null,
                    "GroupDesc": null,
                    "GroupId": "group-yq9d6wev",
                    "GroupName": "shed-zuul-3",
                    "GroupResourceType": "DEF",
                    "MicroserviceType": "G",
                    "NamespaceId": "namespace-qab7bq9v",
                    "NamespaceName": "shedfree_default",
                    "StartupParameters": "-Xms1024m -Xmx4096m -XX:MetaspaceSize=1024m -XX:MaxMetaspaceSize=1024m",
                    "UpdateTime": "2024-12-23 01:30:25",
                    "UpdatedTime": 1734888625000
                }
            ],
            "TotalCount": 660
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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