DescribeInstanceTypeConfigs

Last Updated At: 2026-08-02 00:05:20

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

This API (DescribeInstanceTypeConfigs) is used to query the instance model configurations.

  • You can query the instance model configuration by using zone and instance-family. For filtering criteria, see Filter.
  • If no parameter is defined, all instance model configurations in the specified region will be returned.

Default interface request rate limit: 40 times per second.

Interface update time: 2020-09-05 07:35:08.

The interface only verifies the signature but does not authenticate.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeInstanceTypeConfigs
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
Filters No No Array of Filter Filtering criteria. For details, see the table below: Instance Filtering Criteria Table. A maximum of 10 Filters per request are allowed, and a maximum of 1 Filter.Values per request is allowed.
Example:View

3. Output Parameters

Parameter name Type Description
InstanceTypeConfigSet Array of InstanceTypeConfig List of instance model configurations.
Example:View
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InvalidFilterValue.LimitExceeded The number of Filter parameter values exceeds the limit.
InvalidFilter Invalid filter.
InvalidZone.MismatchRegion The specified zone does not exist.
InternalServerError Internal operation error.
InvalidParameterValue Invalid parameter value. The format of the parameter value is incorrect or not supported, etc.