tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Virtual Machine
    Documentation

    DescribeHosts

    Last updated: 2024-10-22 19:33:40

      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.

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


    • 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

      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",
                "CageId": "",
                "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

      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
      FailedOperation.TagKeyReserved The tag key specified in the request is reserved for the system.
      InvalidFilter Invalid filter.
      InvalidFilterValue.LimitExceeded Filter
      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
      UnsupportedOperation Unsupported operation.
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy