DescribeInstanceTypeConfigs

Last updated: 2020-08-14 10:09:06

1. API Description

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

This API is used to query the model configuration of an instance.

  • You can filter the query results with zone or instance-family. For more information on filtering conditions, see Filter.
  • If no parameter is defined, the model configuration of all the instances in the specified region will be returned.

A maximum of 40 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: DescribeInstanceTypeConfigs.
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


  • instance-family

  • Filter results by instance models. For example, instance models: S1, I1 and M1.

    Type: Integer

    Required: no


    Each request can have up to 10 Filters and 1 Filters.Values.

    3. Output Parameters

    Parameter Name Type Description
    InstanceTypeConfigSet Array of InstanceTypeConfig List of instance model families
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying a list of instance models

    This example shows you how to query instance types of the family I1 in Guangzhou Zone 2.

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=DescribeInstanceTypeConfigs
    &Filters.0.Name=zone
    &Filters.0.Values.0=ap-guangzhou-2
    &Filters.1.Name=instance-family
    &Filters.1.Values.0=I1
    &<Common request parameter>

    Output Example

    {
      "Response": {
        "InstanceTypeConfigSet": [
          {
            "Zone": "ap-guangzhou-2",
            "InstanceFamily": "I1",
            "InstanceType": "I1.MEDIUM4",
            "CPU": 2,
            "GPU": 0,
            "FPGA": 0,
            "Memory": 4
          },
          {
            "Zone": "ap-guangzhou-2",
            "InstanceFamily": "I1",
            "InstanceType": "I1.MEDIUM8",
            "CPU": 2,
            "GPU": 0,
            "FPGA": 0,
            "Memory": 8
          },
          {
            "Zone": "ap-guangzhou-2",
            "InstanceFamily": "I1",
            "InstanceType": "I1.MEDIUM16",
            "CPU": 2,
            "GPU": 0,
            "FPGA": 0,
            "Memory": 16
          },
          {
            "Zone": "ap-guangzhou-2",
            "InstanceFamily": "I1",
            "InstanceType": "I1.LARGE8",
            "CPU": 4,
            "GPU": 0,
            "FPGA": 0,
            "Memory": 8
          }
        ],
        "RequestId": "2f1fd71e-95ab-4f10-8adb-895e99d33ff5"
      }
    }

    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
    InternalServerError Internal error.
    InvalidFilter Invalid filter.
    InvalidFilterValue.LimitExceeded Filter
    InvalidParameterValue Invalid parameter value: parameter value is in the wrong format or is not supported.
    InvalidZone.MismatchRegion The specified zone does not exist.

    Was this page helpful?

    Was this page helpful?

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