DescribeReservedInstancesConfigInfos

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

1. API Description

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

This API is used to describe reserved instance (RI) offerings. Currently, RIs are only offered to beta users.

A maximum of 20 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: DescribeReservedInstancesConfigInfos.
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 zone
Filters by the availability zones in which the reserved instance can be purchased, such as ap-guangzhou-1.
Type: String
Required: no
Valid values: list of regions/availability zones

product-description
Filters by the platform description (operating system) of the reserved instance, such as linux.
Type: String
Required: no
Valid value: linux

duration
Filters by the validity of the reserved instance, which is the purchased usage period. For example, 31536000.
Type: Integer
Unit: second
Required: no
Valid values: 31536000 (1 year), 94608000 (3 years)

3. Output Parameters

Parameter Name Type Description
ReservedInstanceConfigInfos Array of ReservedInstanceConfigInfoItem Static configurations of the reserved instance.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying reserved instance configurations

Input Example

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

Output Example

{
  "Response": {
    "ReservedInstanceConfigInfos": [
      {
        "Type": "C",
        "TypeName": "Compute",
        "Order": 400,
        "InstanceFamilies": [
          {
            "InstanceFamily": "C3",
            "TypeName": "Compute C3",
            "Order": 402,
            "InstanceTypes": [
              {
                "InstanceType": "C3.LARGE8",
                "Cpu": 4,
                "Memory": 8,
                "Gpu": 0,
                "Fpga": 0,
                "StorageBlock": 0,
                "NetworkCard": 0,
                "MaxBandwidth": 2.5,
                "Frequency": "3.2 GHz",
                "CpuModelName": "Intel Xeon Skylake 6146",
                "Pps": 60,
                "Externals": {},
                "Remark": "",
                "Prices": [
                  {
                    "ReservedInstancesOfferingId": "de06832b-1961-4efd-a470-efee242812a8",
                    "OfferingType": "All Upfront",
                    "FixedPrice": 200.99,
                    "UsagePrice": 0
                  },
                  {
                    "ReservedInstancesOfferingId": "daa72710-c529-4ab3-afca-917e192ea49d",
                    "OfferingType": "Partial Upfront",
                    "FixedPrice": 100.99,
                    "UsagePrice": 1.99
                  },
                  {
                    "ReservedInstancesOfferingId": "d81353d7-fe7d-43d0-a361-fb5633a9a7e5",
                    "OfferingType": "No Upfront",
                    "FixedPrice": 0,
                    "UsagePrice": 2.99
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "RequestId": "87eccd3e-9e7a-4b42-be3a-87eccd3e"
  }
}

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
InvalidFilter Invalid filter.
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