Set CRS Auto-Renewal

Last updated: 2017-12-06 16:20:23

1. API Description

This API (SetRedisAutoRenew) is used to set auto renewal.
Domain name for API request: redis.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters are also needed when the API is called. For more information, please see Common Request Parameters. The Action field for this API is SetRedisAutoRenew.

Parameter Name Required Type Description
redisIds.n Yes String An array of instance IDs, with the array subscript starting with 0
isAutoRenew Yes UInt Set auto renewal flag: 0 - Do not set auto renewal; a notification will be given upon expiration of instance; 1 - Set auto renewal; instance will be automatically renewed upon expiration; 2 - Neither renewal nor notification will be made upon the expiration of instance

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please see Common Error Codes on the Error Codes page.
message String Error message description. A null value indicates a success
codeDesc String Description of error code at business side. For a successful operation, "Success" will be returned. In case of an error, a message describing the reason for the error will be returned.

4. Error Codes

The following error codes include the business logic error codes for this API.

Error Code Error Message Error Description
11201 InvalidParameter Incorrect business parameter
10701 InstanceNotExists No instance can be found for the serialId
11055 InstanceDeleted The instance has been deleted upon expiration
11061 InstanceIsolated The instance has been isolated upon expiration
11060 IsAutoRenewError Error with auto renewal flag (0 - Do not set auto renewal; a notification will be given upon expiration of instance; 1 - Set auto renewal; instance will be automatically renewed upon expiration; 2 - Neither renewal nor notification will be made upon the expiration of instance)

5. Example

Input


https://redis.api.qcloud.com/v2/index.php?Action=SetRedisAutoRenew
&<Common Request Parameters>
&redisIds.0=crs-ifmymj41
&isAutoRenew=1

Output

{
    "code":"0",
    "message":"",
    "codeDesc": "Success"
}