tencent cloud

Feedback

DescribeChcHosts

Last updated: 2022-08-26 10:50:49

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.

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: 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.
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
  • zone

  • Filter by the availability zone, such as ap-guangzhou-1.

    Type: String

    Optional

    Valid values: See Regions and Availability Zones


  • instance-name

  • Filter by the instance name.

    Type: String

    Optional


  • instance-state

  • Filter by the instance status. For status details, see InstanceStatus.

    Type: String

    Optional


  • device-type

  • Filter by the device type.

    Type: String

    Optional


  • vpc-id

  • Filter by the unique VPC ID.

    Type: String

    Optional


  • subnet-id

  • 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.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible instances
    ChcHostSet Array of ChcHost List of returned instances
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a CHC host by specifying the instance ID

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

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=DescribeChcHosts
    &ChcIds.0=chc-1a2b3c4d
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "ChcHostSet": [
                {
                    "ChcId": "chc-1a2b3c4d",
                    "InstanceName": "xx",
                    "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": "xxxx:xxxx:xxxx:xxxx",
                    "BmcMAC": "xxxx:xxxx:xxxx:xxx",
                    "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.

    Command Line Interface

    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
    AccountQualificationRestrictions Your account failed the qualification verification.
    InvalidFilter Invalid filter.
    InvalidParameter.AtMostOne Up to one parameter can be specified.
    InvalidParameterValue.ChcHostsNotFound Corresponding CHC hosts not found.
    InvalidParameterValue.IncorrectFormat Incorrect request parameter format.
    InvalidParameterValue.Range Invalid parameter value: invalid parameter value range.
    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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support