查询虚拟机部署组详情

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

1. 接口描述

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

查询虚拟机部署组详情

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

接口更新时间：2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeGroup
Version 是 否 String 公共参数，本接口取值：2018-03-26
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId 是 否 String 部署组ID
示例值：

3. 输出参数

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

4. 错误码

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

错误码 描述
InvalidParameter.ParamError 参数错误。
ResourceNotFound.GroupNotExist 此部署组不存在，无法执行该操作。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
FailedOperation.ApplicationQueryFailed 应用查询失败。
FailedOperation.GroupQueryFaild 部署组查询失败。
FailedOperation.NamespaceQueryFailed 命名空间查询失败。
FailedOperation.TsfPrivilegeError TSF权限模块异常，请联系系统管理员。。
InternalError.GroupCommonError 部署组通用异常。
InternalError.InstanceCommonError TSF节点管理通用错误信息。
InternalError.UnhandledException [%s]模块未处理异常。。
MissingParameter.GroupIdNull 分组ID不能为空。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
InvalidParameter.RepoPackageParamError 请求参数有误。

5. 示例

示例1 查询虚拟机部署组详情

输入示例

POST / HTTP/1.1
Host: tsf.api3.<no value>
Content-Type: application/json
X-TC-Action: DescribeGroup
<公共请求参数>

{
    "GroupId": "group-oydzed8v"
}

输出示例

{
    "Response": {
        "RequestId": "d303489f-e1a0-41d4-8044-dc8cd42a3ae6",
        "Result": {
            "ApplicationType": "V",
            "MicroserviceType": "N",
            "GroupId": "group-oydzed8v",
            "ClusterId": "cluster-by8n8rmy",
            "StartupParameters": "-Xms128m -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m",
            "ClusterName": "test",
            "PackageName": "travel-passenger-api-1.0-SNAPSHOT.jar",
            "RunInstanceCount": 1,
            "ApplicationName": "ruqitest_travel_clientapi",
            "NamespaceName": "test-connection-group",
            "GroupDesc": null,
            "PackageId": "pkg-b430b6a2",
            "UpdateTime": "2019-03-11 16:52:15",
            "PackageVersion": "20190529173949",
            "GroupStatus": "Updating",
            "GroupName": "ruqitest-clientapi-dep",
            "CreateTime": "2019-03-11 16:52:15",
            "NamespaceId": "namespace-6yogoqdv",
            "InstanceCount": 1,
            "ApplicationId": "application-6a7eog6y",
            "OffInstanceCount": 0,
            "UpdateType": 1,
            "DeployBetaEnable": false,
            "DeployBatch": [
                0.2,
                0.8
            ],
            "DeployExeMode": "auto/manual",
            "DeployWaitTime": 0,
            "DeployDesc": "desc",
            "GroupResourceType": "DEF",
            "UpdatedTime": 1602770765000
        }
    }
}