Last updated: 2021-10-27 15:54:36

1. API Description

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

This API is used to purchase one or more specific Reserved Instances.

A maximum of 10 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: PurchaseReservedInstancesOffering.
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.
InstanceCount Yes Integer The number of the Reserved Instance you are purchasing.
ReservedInstancesOfferingId Yes String The ID of the Reserved Instance.
DryRun No Boolean Dry run
ClientToken No String A unique string supplied by the client to ensure that the request is idempotent. Its maximum length is 64 ASCII characters. If this parameter is not specified, the idempotency of the request cannot be guaranteed.
For more information, see Ensuring Idempotency.
ReservedInstanceName No String Reserved instance name.
  • The RI name defaults to “unnamed” if this parameter is left empty.
  • You can enter any name within 60 characters (including the pattern string).
  • 3. Output Parameters

    Parameter Name Type Description
    ReservedInstanceId String The ID of the Reserved Instance purchased.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Purchasing a reserved instance

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=PurchaseReservedInstancesOffering
    &<Common request parameters>

    Output Example

      "Response": {
        "ReservedInstanceId": "13d8e599-b8dc-4e8a-80b4-7dce9eb27043",
        "RequestId": "b333ddb8-4aed-4def-a0d9-617043c2614e"

    5. Developer Resources


    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.TradeUnknownError Internal error.
    InvalidAccount.InsufficientBalance Insufficient account balance.
    InvalidClientToken.TooLong The specified ClientToken exceeds the maximum length of 64 bytes.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Range Invalid parameter value: invalid parameter value range.
    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.
    UnsupportedOperation.ReservedInstanceOutofQuata You’ve used up your quota for Reserved Instances.