Release Notes and Announcements

Release Notes

Public Image Release Notes

Official End of Support Plan for the Operating System

Announcements

Product Introduction

CVM Overview

Strengths

Basic Concepts

Regions and Zones

Tutorial

Service Regions and Service Providers

Billing

Billing Overview

Billing Modes

Billing Items

Billing Mode Conversion Overview

Purchasing Instances

Configuration Adjustment Billing Guide

Overdue Payments

Getting Started

Purchasing a Customized Linux Instance

Purchasing a Customized Windows Instance

User Guide

Operation Guide Overview

Use Limits

Instances

Spot Instances

Reserved Instances

Images

Storage

Backup and Restoration

Network

Security

Passwords/Keys

Monitoring and Alarms

Ops Management

Convenience Features

Migrating a Server

Online Migration

Migration Consultation

Troubleshooting

CVM Login Failures

Windows Instance Login Failures

Linux Instance Login Failures

Other Login Failures

Instance Running Failures

Linux Instance Memory Failures

Network Failures

Use Cases

Suggestions on CVM Model Selection

Environment Building

Website Building

Application Building

Visual GUI Building

Uploading Local Files to CVM

Network Performance Test

DescribeHosts

Focus Mode

Font Size

Last updated: 2025-11-13 11:23:23

1. API Description

Domain name for API request: cvm.intl.tencentcloudapi.com.

This API is used to query the details of CDH instances.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeHosts.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
Filters.N	No	Array of Filter	zone Filter by the availability zone, such as `ap-guangzhou-6`. Type: String Optional Valid values: See Regions and Availability Zones project-id Filter by the project ID. You can query the list of created projects by calling `DescribeProject` or logging in to the CVM console. You can also call `AddProject` to create projects. The project ID is like 1002189. Type: Integer Optional host-id Filter by the CDH instance ID. Format: host-xxxxxxxx. Type: String Optional host-name Filter by the host name. Type: String Optional host-state Filter by the CDH instance status. (`PENDING`: Creating \| `LAUNCH_FAILURE`: Failed to create \| `RUNNING`: Running \| `EXPIRED`: Expired) Type: String Optional Each request can have up to 10 `Filters` and 5 `Filter.Values`.
Offset	No	Integer	Offset; default value: 0.
Limit	No	Integer	Number of results returned; default value: 20; maximum: 100.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of CDH instances meeting the query conditions
HostSet	Array of HostItem	Information on CDH instances
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the list of CDH instances

This example shows you how to query the details of one or more CDH instances.

Input Example

POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHosts
<Common request parameters>

{
    "Filters": [
        {
            "Name": "zone",
            "Values": [
                "ap-singapore-1"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 1
}

Output Example

{
  "Response": {
    "HostSet": [
      {
        "CageId": "",
        "CreatedTime": "2025-11-11T08:37:23Z",
        "ExpiredTime": null,
        "HostChargeType": "POSTPAID_BY_HOUR",
        "HostId": "host-hd25xn3s",
        "HostName": "Unnamed",
        "HostResource": {
          "CpuAvailable": 32,
          "CpuTotal": 32,
          "DiskAvailable": 1000,
          "DiskTotal": 1000,
          "DiskType": "LOCAL_SSD",
          "GpuAvailable": 0,
          "GpuTotal": 0,
          "MemAvailable": 96,
          "MemTotal": 96
        },
        "HostState": "RUNNING",
        "HostType": "HC20",
        "InstanceIds": [],
        "Placement": {
          "ProjectId": 0,
          "Zone": "ap-singapore-1"
        },
        "RenewFlag": "NOTIFY_AND_MANUAL_RENEW"
    ],
    "RequestId": "801f6cbc-d5eb-4263-90e0-2c568d437544",
    "TotalCount": 2
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.TagKeyReserved	The tag key specified in the request is reserved for the system.
InvalidFilter	Invalid filter.
InvalidFilterValue.LimitExceeded	The value of `Filter` exceeds the limit.
InvalidHostId.Malformed	Invalid CDH `ID`. The specified CDH `ID` has an invalid format. For example, `host-1122` has an invalid `ID` length.
InvalidParameterValue	Incorrect parameter value.
InvalidZone.MismatchRegion	The specified `zone` does not exist.
UnauthorizedOperation	Unauthorized operation.
UnsupportedOperation	Unsupported operation.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Cloud Virtual Machine