查询虚拟机部署组详情

最近更新时间:2019-08-29 21:04:24

1. 接口描述

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

查询虚拟机部署组详情

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tsf.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
Result VmGroup 虚拟机部署组详情
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeGroup
&GroupId=group-oydzed8v
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "d303489f-e1a0-41d4-8044-dc8cd42a3ae6",
    "Result": {
      "ApplicationType": "V",
      "MicroserviceType": "N",
      "GroupId": "group-oydzed8v",
      "ClusterId": "cluster-by8n8rmy",
      "Operator": null,
      "StartupParameters": "-Xms128m -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m",
      "ClusterName": "出行测试集群",
      "Action": "DescribeGroup",
      "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",
      "ProjectId": null,
      "OffInstanceCount": 0
    }
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码