Help & DocumentationAPIsTencentDB for RedisInstance APIsRenewInstance

RenewInstance

Last updated: 2019-09-09 12:20:53

Contents：

1. API Description

API domain name: redis.tencentcloudapi.com.

This API renews an instance.

Default API request rate limit: 20 requests/sec.

Note: This API supports financial availability zones. Because financial availability zones and non-financial availability zones are isolated, if the common parameter Region specifies a financial availability zone (e.g., ap-shanghai-fsi), you need to specify a domain name with the financial availability zone as well, which preferably in the same region as the specified Region, for example: vod.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: RenewInstance
Version Yes String Common parameter; the version of this API: 2018-04-12
Region Yes String Common parameters; for details, 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 Deal ID
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Sample 1. Request Example

Input Sample Code

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

Output Sample Code

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

5. Developer Resources

API Explorer

API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) that support various programming languages to make it easier for you to call the APIs.

TCCLI

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter.EmptyParam The specified parameter is not allowed to have an empty value.
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 found by the specified serialId.
ResourceUnavailable.AccountBalanceNotEnough The request order number does not exist.
ResourceUnavailable.InstanceDeleted The instance has already been reclaimed.