查看CDH实例列表

最近更新时间:2018-11-15 19:13:20

查看pdf

1. 接口描述

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

本接口 (DescribeHosts) 用于获取一个或多个CDH实例的详细信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeHosts
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
Filters.N Array of Filter 过滤条件。
  • zone - String - 是否必填:否 - (过滤条件)按照可用区过滤。
  • project-id - Integer - 是否必填:否 - (过滤条件)按照项目ID过滤。可通过调用 DescribeProject 查询已创建的项目列表或登录控制台进行查看;也可以调用 AddProject 创建新的项目。
  • host-id - String - 是否必填:否 - (过滤条件)按照CDH ID过滤。CDH ID形如:host-11112222。
  • host-name - String - 是否必填:否 - (过滤条件)按照CDH实例名称过滤。
  • host-state - String - 是否必填:否 - (过滤条件)按照CDH实例状态进行过滤。(PENDING:创建中|LAUNCH_FAILURE:创建失败|RUNNING:运行中|EXPIRED:已过期)
  • Offset Integer 偏移量,默认为0。
    Limit Integer 返回数量,默认为20,最大值为100。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合查询条件的cdh实例总数
    HostSet Array of HostItem cdh实例详细信息列表
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询CDH实例列表

    输入示例

    https://cvm.tencentcloudapi.com/?Action=DescribeHosts
    &Filters.0.Name=zone
    &Filters.0.Values.0=ap-guangzhou-2
    &Offset=0
    &Limit=20
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "HostSet": [
          {
            "CreatedTime": "2018-01-04T09:45:39Z",
            "ExpiredTime": "2025-05-04T09:45:42Z",
            "HostChargeType": "PREPAID",
            "HostId": "host-ey16rkyg",
            "HostName": "bibibibib-111",
            "HostResource": {
              "CpuAvailable": 24,
              "CpuTotal": 24,
              "DiskAvailable": 1200,
              "DiskTotal": 1200,
              "MemAvailable": 56.0,
              "MemTotal": 56.0
            },
            "HostState": "RUNNING",
            "HostType": "HS1",
            "InstanceIds": [],
            "Placement": {
              "ProjectId": 0,
              "Zone": "ap-guangzhou-2"
            },
            "RenewFlag": "NOTIFY_AND_AUTO_RENEW"
          }
        ],
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidHostId.Malformed 无效CDH ID。指定的CDH ID格式错误。例如ID长度错误host-1122
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidZone.MismatchRegion 指定的zone不存在。