Help & DocumentationAPIsBatch ComputeConfiguration Viewing-related APIsDescribeAvailableCvmInstanceTypes

DescribeAvailableCvmInstanceTypes

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

1. API Description

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

This API is used to view the information of available CVM model configurations.

A maximum of 2 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: DescribeAvailableCvmInstanceTypes.
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 Filter.
  • zone - String - Required: No - (Filter) Filter by availability zone.
  • instance-family - String - Required: No - (Filter) Filter by model family such as S1, I1, and M1.
    		•

    3. Output Parameters

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

    4. Example

    Example1 Querying GN2 Series Models in Guangzhou Zone 3

    Input Example

    https://batch.tencentcloudapi.com/?Action=DescribeAvailableCvmInstanceTypes
&Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-3
&Filters.1.Name=instance-family
&Filters.1.Values.0=GN2
&<Common request parameter>

    Output Example

    {
  "Response": {
    "InstanceTypeConfigSet": [
      {
        "Mem": 56,
        "Cpu": 28,
        "InstanceType": "GN2.7XLARGE56",
        "Zone": "ap-guangzhou-3",
        "InstanceFamily": "GN2"
      },
      {
        "Mem": 112,
        "Cpu": 56,
        "InstanceType": "GN2.14XLARGE112",
        "Zone": "ap-guangzhou-3",
        "InstanceFamily": "GN2"
      }
    ],
    "RequestId": "59f5b671-c492-4536-bbed-e5fbf78619dd"
  }
}

    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
    InvalidFilter The specified filter is not supported.
    InvalidParameterValue Invalid parameter value.
    InvalidParameterValue.LimitExceeded The number of filter parameter values exceeds the limit.
    InvalidZone.MismatchRegion The specified zone does not exist.