tencent cloud

RenewDBInstance
Last updated: 2025-08-27 17:19:20
RenewDBInstance
Last updated: 2025-08-27 17:19:20

1. API Description

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

This API is used to renew instances. For pay-as-you-go instances, the billing method will change to monthly subscription after renewal. You can call the InquiryPriceRenewDBInstance API for the renewal price of pay-as-you-go instances.

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: RenewDBInstance.
Version Yes String Common Params. The value used for this API: 2018-03-28.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID. For example, mssql-j8kv137v.
Period No Integer Renewal duration, in months. Value range: 1~48. Default value: 1.
AutoVoucher No Integer Whether to automatically use voucher. 0: no, 1: yes. Default value: no.
VoucherIds.N No Array of String Array of voucher IDs (currently, only one voucher can be used per order).
AutoRenewFlag No Integer Renewal flag. 0: normal renewal; 1: automatic renewal. This parameter is valid only for pay-as-you-go instances changing to monthly subscription ones.

3. Output Parameters

Parameter Name Type Description
DealName String Order name.
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 Renew Instance

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=RenewDBInstance
&InstanceId=mssql-j8kv137v
&Period=2
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
        "DealName": "201806261980"
    }
}

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
FailedOperation.CreateOrderFailed Failed to create order.
InternalError.DBError Database error
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
InvalidParameter.PayOrderFailed Failed to make order payment.
InvalidParameterValue.IllegalSpec Incorrect instance specification information.
ResourceNotFound.InstanceNotFound The instance does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication error.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback