Help & DocumentationCloud Virtual MachineAPI DocumentationInstance APIsDescribeZoneInstanceConfigInfos

DescribeZoneInstanceConfigInfos

Last updated: 2020-04-03 11:28:16

PDF

1. API Description

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

This API is used to query the configurations of models in an availability zone.

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

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: DescribeZoneInstanceConfigInfos.
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 Filters.

  • zone - String - Optional - Filter results by availability zone.


  • instance-family - String - Optional - Filter results by instance model family, such as S1, I1, and M1.


  • instance-type - String - Optional - Filter results by model. Different instance models have different configurations. You can call DescribeInstanceTypeConfigs to query the latest configuration list or refer to the documentation on instance types. If this parameter is not specified, S1.SMALL1 will be used by default.


  • instance-charge-type - String - Optional - Filter results by instance billing method. POSTPAID_BY_HOUR: pay-as-you-go | CDHPAID: you are only billed for CDH instances, not the CVMs running on the CDH instances.
    		•

    3. Output Parameters

    Parameter Name Type Description
    InstanceTypeQuotaSet Array of InstanceTypeQuotaItem List of model configurations for the availability zone.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the configurations of models in an availability zone

    This example shows you how to query a list of instance configurations using availability zone and billing method as filters.

    Input Example

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

    Output Example

    {
  "Response": {
    "InstanceTypeQuotaSet": [
      {
        "Status": "SELL",
        "InstanceQuota": 1999,
        "Zone": "ap-guangzhou-2",
        "NetworkCard": 0,
        "Price": {
          "UnitPrice": 0.15,
          "DiscountThirdStep": "100.000000",
          "UnitPriceThirdStep": 0.05,
          "DiscountSecondStep": "100.000000",
          "Discount": "100.000000",
          "UnitPriceDiscountThirdStep": 0.05,
          "UnitPriceSecondStep": 0.07,
          "UnitPriceDiscount": 0.15,
          "UnitPriceDiscountSecondStep": 0.07,
          "ChargeUnit": "HOUR"
        },
        "InstanceFamily": "S2",
        "Externals": {},
        "InstanceType": "S2.SMALL1",
        "TypeName": "Standard S2",
        "InstanceChargeType": "POSTPAID_BY_HOUR",
        "Memory": 1,
        "LocalDiskTypeList": [],
        "Cpu": 1
      }
    ],
    "RequestId": "c28559ca-d3cf-40f0-9664-2ab303484efa"
  }
}

    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
    InvalidInstanceType.Malformed The specified InstanceType parameter has an invalid format.
    InvalidRegion.NotFound The region cannot be found.
    InvalidZone.MismatchRegion The specified zone does not exist.