RenewDBInstances

Last updated:2026-01-13 21:48:04

RenewDBInstances

Last updated: 2026-01-13 21:48:04

1. API Description

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

This API is used to renew a monthly subscription TencentDB instance. Only monthly subscription instances are supported, while pay-as-you-go instances do not need to be renewed.

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: RenewDBInstances.
Version	Yes	String	Common Params. The value used for this API: 2019-07-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceIds.N	Yes	Array of String	Specifies the ID or IDs of one or multiple instances to be renewed. - It can be obtained through the response parameter InstanceId of the DescribeDBInstances API. - The maximum number of instances for each renewal request is 100.
InstanceChargePrepaid	Yes	InstanceChargePrepaid	The parameter setting for the prepaid mode (monthly subscription mode). This parameter can specify the renewal period, whether to set automatic renewal, and other attributes of the monthly subscription instance. This parameter is mandatory in monthly subscription.

3. Output Parameters

Parameter Name	Type	Description
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 Renewing monthly-subscribed instances

Input Example

https://mongodb.intl.tencentcloudapi.com/?Action=RenewDBInstances
&InstanceIds.0=cmgo-gzo03o75
&InstanceChargePrepaid.Period=1
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "b1886334-acfe-4445-8429-e11a6e7b3851"
    }
}

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

Tencent Cloud CLI 3.0

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
InvalidParameter.PermissionDenied	The current sub-account has no permission to perform this operation.
InvalidParameterValue.InvalidTradeOperation	Billing error. Corresponding purchase/renewal/configuration change operations are not allowed for the current instance.
InvalidParameterValue.NotFoundInstance	The instance was not found.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud