Help & DocumentationAPIsTencentDB for RedisInstance APIsRenewInstance

RenewInstance

Last updated: 2020-03-20 17:05:42

Contents：

1. API Description

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

This API is used to renew an instance.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

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: RenewInstance.
Version Yes String Common parameter. The value used for this API: 2018-04-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Period Yes Integer Length of purchase in months
InstanceId Yes String Instance ID

3. Output Parameters

Parameter Name Type Description
DealId String Transaction ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Request Example

Input Example

https://redis.tencentcloudapi.com/?Action=RenewInstance
&Period=12
&InstanceId=crs-5a4py64p
&<common request parameters>

Output Example

{
  "Response": {
    "DealId": "6954225",
    "RequestId": "495d8e9f-61bf-465e-aa4e-14be54a9095a"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InvalidParameter.EmptyParam The parameter is empty.
InvalidParameter.PermissionDenied The API has no CAM permissions.
LimitExceeded.PeriodExceedMaxLimit The requested length of purchase is more than 3 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.