製品情報
パブリックイメージの更新情報
OSの公式サポート終了計画
製品に関するお知らせ
Domain name for API request: cvm.intl.tencentcloudapi.com.
This API is used to query the details of one or more CHC host.
Filter for more information.Limit and is 20 by default.A maximum of 20 requests can be initiated per second for this API.
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: DescribeChcHosts. |
| 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. |
| ChcIds.N | No | Array of String | CHC host ID. Up to 100 instances per request is allowed. ChcIds and Filters cannot be specified at the same time. |
| Filters.N | No | Array of Filter | Filter by the availability zone, such as Type: String Optional Valid values: See Regions and Availability Zones Filter by the instance name. Type: String Optional Filter by the instance status. For status details, see InstanceStatus. Type: String Optional Filter by the device type. Type: String Optional Filter by the unique VPC ID. Type: String Optional Filter by the unique VPC subnet ID. Type: String Optional |
| Offset | No | Integer | The offset. Default value: 0. For more information on Offset, see the relevant sections in API Introduction. |
| Limit | No | Integer | The number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant sections in API Introduction. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible instances |
| ChcHostSet | Array of ChcHost | List of returned 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. |
This example shows you how to query an instance by the CHC ID.
POST / HTTP/1.1
Host: cvm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeChcHosts
<Common request parameters>
{
"ChcIds": [
"chc-1a2b3c4d"
]
}{
"Response": {
"ChcHostSet": [
{
"ChcId": "chc-1a2b3c4d",
"InstanceName": "Hosted CVM instance",
"SerialNumber": "sn34asdfabd",
"InstanceState": "RUNNING",
"DeviceType": "CHC_HS1",
"Placement": {
"Zone": "ap-guangzhou-6"
},
"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": 1,
"RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AccountQualificationRestrictions | Your account failed the qualification verification. |
| InvalidFilter | Invalid filter. |
| InvalidFilterValue.LimitExceeded | The value of Filter exceeds the limit. |
| InvalidParameter.AtMostOne | Up to one parameter can be specified. |
| InvalidParameterValue.ChcHostsNotFound | Corresponding CHC hosts not found. |
| InvalidParameterValue.IncorrectFormat | Incorrect request parameter format. |
| InvalidParameterValue.NotEmpty | The parameter value is required. |
| InvalidParameterValue.Range | Invalid parameter value: invalid parameter value range. |
| InvalidParameterValue.SubnetIdMalformed | Invalid subnet ID. Please provide a subnet ID in the format of subnet-xxxxxxxx, where “x” can be a lowercase letter or number. |
| InvalidParameterValue.VpcIdMalformed | The VPC ID xxx is invalid. Please provide a VPC ID in the format of vpc-xxxxxxxx, where “x” can be a lowercase letter or number. |
| InvalidParameterValueLimit | The number of parameter values exceeds the limit. |
| InvalidParameterValueOffset | Invalid parameter value: invalid Offset. |
| InvalidZone.MismatchRegion | The specified zone does not exist. |
| MissingParameter | Missing parameter. |
フィードバック