PrevNext
search by keyword

Recent Pages

Documentation
Documentation

DescribeCvmZoneInstanceConfigInfos

Last updated: 2021-01-28 19:55:27

1. API Description

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

This API is used to get the model configuration information of the availability zone of BatchCompute.

A maximum of 5 requests can be initiated per second for this API.

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: DescribeCvmZoneInstanceConfigInfos.
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.
  • instance-type - String - Required: No - (Filter) Filter by model.
  • instance-charge-type - String - Required: No - (Filter) Filter by instance billing method. ( POSTPAID_BY_HOUR: pay-as-you-go | SPOTPAID: bidding.)

    • 3. Output Parameters

    Parameter Name Type Description
    InstanceTypeQuotaSet Array of InstanceTypeQuotaItem List of model configurations in 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 configuration information of pay-as-you-go models in Chongqing Zone 1

    Input Example

    https://batch.tencentcloudapi.com/?Action=DescribeCvmZoneInstanceConfigInfos
&Filters.0.Name=zone
&Filters.0.Values.0=ap-chongqing-1
&Filters.1.Name=instance-charge-type
&Filters.1.Values.0=POSTPAID_BY_HOUR
&<Common request parameters>

    Output Example

    {
  "Response": {
    "InstanceTypeQuotaSet": [
      {
        "Status": "SELL",
        "Zone": "ap-chongqing-1",
        "NetworkCard": 0,
        "Price": {
          "UnitPrice": 0.18,
          "ChargeUnit": "HOUR"
        },
        "InstanceFamily": "S3",
        "Externals": {},
        "Cpu": 1,
        "TypeName": "Standard S3",
        "InstanceChargeType": "POSTPAID_BY_HOUR",
        "Memory": 1,
        "LocalDiskTypeList": [],
        "InstanceType": "S3.SMALL1"
      },
      {
        "Status": "SELL",
        "Zone": "ap-chongqing-1",
        "NetworkCard": 0,
        "Price": {
          "UnitPrice": 0.26,
          "ChargeUnit": "HOUR"
        },
        "InstanceFamily": "S3",
        "Externals": {},
        "Cpu": 1,
        "TypeName": "Standard S3",
        "InstanceChargeType": "POSTPAID_BY_HOUR",
        "Memory": 2,
        "LocalDiskTypeList": [],
        "InstanceType": "S3.SMALL2"
      }
    ],
    "RequestId": "2fba5b9c-e4ee-47ad-a776-dabb79ff2c35"
  }
}

    5. Developer Resources

    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.
    InternalError.CallCvm An error is returned for the CVM API call.
    InvalidFilter The specified filter is not supported.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.LimitExceeded The number of filter parameter values exceeds the limit.
    InvalidParameterValue.UnsupportedBatchInstanceChargeType The model billing type is not supported by BatchCompute.
    InvalidZone.MismatchRegion The specified zone does not exist.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy