tencent cloud

All product documents
Cloud Virtual Machine
DocumentationCloud Virtual MachineAPI DocumentationInstance APIsDescribeReservedInstancesConfigInfos
DescribeReservedInstancesConfigInfos
Download PDF
Last updated: 2025-03-13 10:54:19
DescribeReservedInstancesConfigInfos
Last updated: 2025-03-13 10:54:19
Download PDF

1. API Description

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

This API is used to describe reserved instance (RI) offerings.

A maximum of 20 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 Params. The value used for this API: DescribeReservedInstancesConfigInfos.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. 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 value: 31536000 (1 year)

    3. Output Parameters

    Parameter Name Type Description
    ReservedInstanceConfigInfos Array of ReservedInstanceConfigInfoItem Static configurations of the reserved instance.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying reserved instance configurations

    Input Example

    GET https://cvm.intl.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",
                        "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

    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.
    InvalidZone.MismatchRegion The specified zone does not exist.
    UnsupportedOperation.InvalidPermissionNonInternationalAccount The current operation is supported only for Tencent Cloud users.
    UnsupportedOperation.ReservedInstanceInvisibleForUser Purchasing reserved instances is not supported for the current user.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon