Help & DocumentationAPIsBatch ComputeConfiguration Viewing-related APIsDescribeInstanceCategories

DescribeInstanceCategories

Last updated: 2020-03-06 20:50:31

1. API Description

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

Currently, CVM instance families are classified into different category, and each category contains several instance families. This API is used to query the instance category information.

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.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeInstanceCategories.
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.

3. Output Parameters

Parameter Name Type Description
InstanceCategorySet Array of InstanceCategoryItem List of CVM instance categories
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying Instance Category Information

Query the category and category details of the current CVM instance family.

Input Example

https://batch.tencentcloudapi.com/?Action=DescribeInstanceCategories
&<Common request parameter>

Output Example

{
  "Response": {
    "InstanceCategorySet": [
      {
        "InstanceFamilySet": [
          "C3",
          "CN3"
        ],
        "InstanceCategory": "COMPUTE_3"
      },
      {
        "InstanceFamilySet": [
          "C2"
        ],
        "InstanceCategory": "COMPUTE_2"
      },
      {
        "InstanceFamilySet": [
          "S2",
          "S2ne",
          "I2",
          "D1",
          "M2"
        ],
        "InstanceCategory": "GENERAL_2"
      },
      {
        "InstanceFamilySet": [
          "S3",
          "SN3ne",
          "S4",
          "I3",
          "M3",
          "M4"
        ],
        "InstanceCategory": "GENERAL_3"
      }
    ],
    "RequestId": "166a2a24-888f-4fd5-82ef-f41e4754d994"
  }
}

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
InternalError Internal error
UnsupportedOperation This operation is prohibited.