DescribeReservedInstancesOfferings

Last updated: 2020-10-16 18:38:33

1. API Description

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

This API is used to describe Reserved Instance offerings that are available for purchase.

A maximum of 10 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: DescribeReservedInstancesOfferings.
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.
DryRun No Boolean Dry run. Default value: false.
Offset No Integer The offset. Default value: 0. For more information on Offset, see the relevant sections in API Introduction.
Limit No Integer The number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant sections in API Introduction.
MaxDuration No Integer The maximum duration as a filter,
in seconds.
Default value: 94608000.
MinDuration No Integer The minimum duration as a filter,
in seconds.
Default value: 2592000.
Filters.N No Array of Filter
  • zone

  • Filters by the availability zones in which the Reserved Instances can be purchased, such as ap-guangzhou-1.

    Type: String

    Required: no

    Valid values: please see Availability Zones


  • duration

  • Filters by the duration of the Reserved Instance, in seconds. For example, 31536000.

    Type: Integer

    Unit: second

    Required: no

    Valid values: 31536000 (1 year) | 94608000 (3 years)


  • instance-type

  • Filters by type of the Reserved Instance, such as S3.MEDIUM4.

    Type: String

    Required: no

    Valid values: please see Instance Types


  • offering-type

  • Filters by payment term, such as All Upfront.

    Type: String

    Required: no

    Valid value: All Upfront


  • product-description

  • Filters by the platform description (operating system) of the Reserved Instance, such as linux.

    Type: String

    Required: no

    Valid value: linux


  • reserved-instances-offering-id

  • Filters by Reserved Instance ID, in the form of 650c138f-ae7e-4750-952a-96841d6e9fc1.

    Type: String

    Required: no


    Each request can have up to 10 Filters and 5 Filter.Values.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of Reserved Instances that meet the condition.
    ReservedInstancesOfferingsSet Array of ReservedInstancesOffering The list of Reserved Instances that meet the condition.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Describing Reserved Instance offerings

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=DescribeReservedInstancesOfferings
    &Filters.0.Name=zone
    &Filters.0.Values.0=ap-guangzhou-1
    &Offset=0
    &Limit=1
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "ReservedInstancesOfferingsSet": [
          {
            "Zone": "ap-guangzhou-1",
            "CurrencyCode": "USD",
            "Duration": 31536000,
            "FixedPrice": 4000.0,
            "InstanceType": "S3.MEDIUM4",
            "OfferingType": "All Upfront",
            "ReservedInstancesOfferingId": "noew0342-324f-f3ab-9uut-wrlnth53dcee",
            "ProductDescription": "linux",
            "UsagePrice": 0.0
          }
        ],
        "RequestId": "b813c959-cc89-41d5-9cc4-ceb7d853dcaa"
      }
    }

    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
    InvalidParameter A parameter error occurred.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    UnsupportedOperation.InvalidPermissionNonInternationalAccount The current operation is only supported for Tencent Cloud International users.
    UnsupportedOperation.ReservedInstanceInvisibleForUser Purchasing reserved instances is not supported for the current user.

    Was this page helpful?

    Was this page helpful?

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