tencent cloud

1. API Description

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

This API is used to query the details of one or more CHC host.

• You can filter the query results with the instance ID, name or device type. See Filter for more information.
• If no parameter is defined, a certain number of instances under the current account will be returned. The number is specified by Limit and is 20 by default.

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

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.

3. Output Parameters

4. Example

Example1 Querying an instance by the CHC ID

This example shows you how to query an instance by the CHC ID.

Input Example

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

{
    "ChcIds": [
        "chc-1a2b3c4d"
    ]
}

Output Example

{
    "Response": {
        "ChcHostSet": [
            {
                "ChcId": "chc-1a2b3c4d",
                "InstanceName": "Hosted CVM instance",
                "SerialNumber": "sn34asdfabd",
                "InstanceState": "RUNNING",
                "DeviceType": "CHC_HS1",
                "Placement": {
                    "Zone": "ap-guangzhou-2"
                },
                "BmcVirtualPrivateCloud": {
                    "SubnetId": "subnet-a2676p0e",
                    "VpcId": "vpc-g7wzcv7n"
                },
                "BmcIp": "10.12.10.34",
                "BmcSecurityGroupIds": [
                    "sg-1a2b3c4d"
                ],
                "DeployVirtualPrivateCloud": {
                    "SubnetId": "subnet-a26734fs",
                    "VpcId": "vpc-g7wz234f"
                },
                "DeployIp": "10.12.20.34",
                "DeploySecurityGroupIds": [
                    "sg-1a2b34af"
                ],
                "CvmInstanceId": "ins-1a2bafst",
                "CreatedTime": "2020-03-10T02:43:51Z",
                "HardwareDescription": "50C 128G 12*4T",
                "Memory": 128,
                "DeployMAC": "52:54:00:68:CC:00",
                "BmcMAC": "52:54:00:68:CC:01",
                "Disk": "12*4T",
                "CPU": 50
            }
        ],
        "TotalCount": 2,
        "RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
    }
}

5. Developer Resources

SDK

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

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

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.