云服务器查看CDH实例列表

1. 接口描述

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

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

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

推荐使用 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 必选：否 host-type 按照【CDH机型】进行过滤。类型：String 必选：否 tag-key 按照【标签键】进行过滤。类型：String 必选：否 tag-value 按照【标签值】进行过滤。类型：String 必选：否 tag:tag-key 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例。每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。示例值：[ { "Name": "tag-key", "Values": [ "myTag" ] } ]
Offset	否	Integer	偏移量，默认为0。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。示例值：20

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合查询条件的cdh实例总数示例值：1
HostSet	Array of HostItem	cdh实例详细信息列表示例值：[ { "Placement": { "Zone": "ap-guangzhou-5", "ProjectId": 0 }, "HostId": "host-8th3ybbw", "HostType": "HM50", "HostName": "myHost", "CageId": "", "HostChargeType": "PREPAID", "RenewFlag": "NOTIFY_AND_AUTO_RENEW", "CreatedTime": "2024-09-30T03:17:49Z", "ExpiredTime": "2024-11-30T03:17:51Z", "InstanceIds": [ "ins-flx4u4ck", "ins-p5s3wcq2" ], "HostState": "RUNNING", "Tags": [], "HostResource": { "CpuTotal": 336, "CpuAvailable": 18, "MemTotal": 700, "MemAvailable": 40, "DiskTotal": 0, "DiskAvailable": 0, "DiskType": "", "GpuTotal": 0, "GpuAvailable": 0 } } ]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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-5",
                    "ProjectId": 0
                },
                "HostId": "host-8th3ybbw",
                "HostType": "HM50",
                "HostName": "myHost",
                "CageId": "",
                "HostChargeType": "PREPAID",
                "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
                "CreatedTime": "2024-09-30T03:17:49Z",
                "ExpiredTime": "2024-11-30T03:17:51Z",
                "InstanceIds": [
                    "ins-flx4u4ck",
                    "ins-p5s3wcq2"
                ],
                "HostState": "RUNNING",
                "Tags": [],
                "HostResource": {
                    "CpuTotal": 336,
                    "CpuAvailable": 18,
                    "MemTotal": 700,
                    "MemAvailable": 40,
                    "DiskTotal": 0,
                    "DiskAvailable": 0,
                    "DiskType": "",
                    "GpuTotal": 0,
                    "GpuAvailable": 0
                }
            }
        ],
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.TagKeyReserved	请求中指定的标签键为系统预留标签，禁止创建
InvalidFilter	无效的过滤器。
InvalidFilterValue.LimitExceeded	`Filter`。
InvalidHostId.Malformed	无效CDH `ID`。指定的CDH `ID`格式错误。例如`ID`长度错误`host-1122`。
InvalidParameterValue	参数取值错误。
InvalidZone.MismatchRegion	指定的`zone`不存在。
UnauthorizedOperation	未授权操作。
UnsupportedOperation	操作不支持。

查看CDH实例列表

本页目录：