DescribeHosts

Last updated: 2020-10-16 18:38:38

1. API Description

Domain name for API request: cvm.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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeHosts.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Filters.N No Array of Filter
  • zone

  • Filter results by availability zones. For example, availability zone: ap-guangzhou-1;

    Type: String

    Required: no

    Valid values: list of availability zones


  • project-id

  • Filter results by project ID. You can query the existing project list through the DescribeProject API or CVM console, or create a project by calling the AddProject API. For example, project ID: 1002189;

    Type: Integer

    Required: no


  • host-id

  • Filter results by CDH ID. For example, CDH ID: host-xxxxxxxx;

    Type: String

    Required: no


  • state

  • Filter results by CDH instance name.

    Type: String

    Required: no


  • state

  • Filter results by CDH instance status . (PENDING: creating | LAUNCH_FAILURE: creation failed | RUNNING: running | EXPIRED: expired)

    Type: String

    Required: no


    Each request can have up to 10 Filters and 5 Filters.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, which is returned for each request. 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

    GET https://cvm.tencentcloudapi.com/?Action=DescribeHosts
    &Filters.0.Name=zone
    &Filters.0.Values.0=ap-guangzhou-2
    &Offset=0
    &Limit=20
    &<common request parameters>

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "HostSet": [
          {
            "Placement": {
              "Zone": "ap-guangzhou-2",
              "ProjectId": 0
            },
            "HostId": "host-ey16rkyg",
            "HostType": "HS1",
            "HostName": "bibibibib-111",
            "HostChargeType": "PREPAID",
            "RenewFlag": "NOTIFY_AND_AUTO_RENEW",
            "CreatedTime": "2018-01-04T09:45:39Z",
            "ExpiredTime": "2025-05-04T09:45:42Z",
            "InstanceIds": [],
            "HostState": "RUNNING",
            "HostResource": {
              "CpuTotal": 24,
              "CpuAvailable": 24,
              "MemTotal": 56.0,
              "MemAvailable": 56.0,
              "DiskTotal": 1200,
              "DiskAvailable": 1200,
              "DiskType": "LOCAL_BASIC"
            }
          }
        ],
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help