有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

查询虚拟机部署组详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeGroup。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
GroupId String 部署组ID
示例值:group-oydzed8v

3. 输出参数

参数名称 类型 描述
Result VmGroup 虚拟机部署组详情
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
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
        }
    }
}

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