1. API Description
Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to renew an instance.
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.
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: RenewInstance. |
| Version |
Yes |
String |
Common Params. The value used for this API: 2018-04-12. |
| Region |
Yes |
String |
Common Params. For more information, please see the list of regions supported by the product. |
| Period |
Yes |
Integer |
Validity period in months |
| InstanceId |
Yes |
String |
Instance ID. Log in to the Redis console and copy it in the instance list. |
| ModifyPayMode |
No |
String |
The parameter used to determine whether to modify the billing mode. - If you want to change the billing mode from pay-as-you-go to monthly subscription, specify this parameter as prepaid.
- If the current instance is monthly subscribed, this parameter is not required.
|
3. Output Parameters
| Parameter Name |
Type |
Description |
| DealId |
String |
Transaction ID |
| 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 Request Example
POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RenewInstance
<Common request parameters>
{
"InstanceId": "crs-5a4py64p",
"Period": 12
}
Output Example
{
"Response": {
"DealId": "6954225",
"RequestId": "495d8e9f-61bf-465e-aa4e-14be54a9095a"
}
}
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.PayFailed |
Payment failed. |
| FailedOperation.SystemError |
Internal system error, which is irrelevant to the business. |
| InvalidParameter.EmptyParam |
The parameter is empty. |
| InvalidParameter.PermissionDenied |
The API has no CAM permissions. |
| LimitExceeded.PeriodExceedMaxLimit |
The requested length of purchase is more than three years and exceeds the maximum value. |
| LimitExceeded.PeriodLessThanMinLimit |
The length of purchase is invalid. It must be at least one month. |
| ResourceInUse.InstanceBeenLocked |
The instance is locked by another process. |
| ResourceNotFound.InstanceNotExists |
No Redis instance is found by the serialId. |
| ResourceUnavailable.AccountBalanceNotEnough |
The request order number does not exist. |
| ResourceUnavailable.InstanceDeleted |
The instance has already been repossessed. |