操作指南

最佳实践

运维指南

API 文档

查看CDH实例列表

最近更新时间:2020-07-13 08:20:58

1. 接口描述

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

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeHosts。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter
  • zone

  • 按照【可用区】进行过滤。可用区形如:ap-guangzhou-1。

    类型:String

    必选:否

    可选项:可用区列表


  • project-id

  • 按照【项目ID】进行过滤,可通过调用DescribeProject查询已创建的项目列表或登录控制台进行查看;也可以调用AddProject创建新的项目。项目ID形如:1002189。

    类型:Integer

    必选:否


  • host-id

  • 按照【CDH ID】进行过滤。CDH ID形如:host-xxxxxxxx。

    类型:String

    必选:否


  • host-name

  • 按照【CDH实例名称】进行过滤。

    类型:String

    必选:否


  • host-state

  • 按照【CDH实例状态】进行过滤。(PENDING:创建中 | LAUNCH_FAILURE:创建失败 | RUNNING:运行中 | EXPIRED:已过期)

    类型:String

    必选:否


    每次请求的Filters的上限为10,Filter.Values的上限为5。
    Offset Integer 偏移量,默认为0。
    Limit Integer 返回数量,默认为20,最大值为100。

    3. 输出参数

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

    4. 示例

    示例1 查询CDH实例列表

    查询一个或多个CDH实例的详细信息

    输入示例

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

    输出示例

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

    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不存在。
    UnauthorizedOperation 未授权操作。
    目录