Help & DocumentationTencentDB for RedisAPI DocumentationRedis API 2017Instance APIUpgrade CRS Instance

Upgrade CRS Instance

Last updated: 2019-11-29 17:15:47

PDF

Contents：

1. API Description

This API (UpgradeRedis) is used to upgrade an instance.
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. The Action field for this API is UpgradeRedis.

Parameter Name Required Type Description
redisId Yes String Instance ID. It can be queried with the API Query CRS Instance List
memSize Yes UInt The capacity of upgraded instance, which should be an integral multiple of 1024 (in MB)

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed.
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.
data Array Returned array

Array data is composed as follows:

Parameter Name Type Description
data.dealId String Unique order ID

4. Error Codes

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

Error Code Error Message Error Description
10701 InstanceNotExists No instance can be found for the serialId
10703 InvalidMemSize The requested capacity is not included in the supported specifications (memSize (in MB) should be an integral multiple of 1024)
11063 MemSizeNotInRange The requested capacity is not within the range of supported capacities (please use the API Query Supported Specifications to query the limits on the capacity)
10702 InstanceStatusAbnormal The operation is impossible due to an abnormal instance status. For example, the instance has a status of "in process" or "isolated" or "deleted"
11057 ReduceCapacityNotAllowed The requested capacity is less than the actual capacity of the instance. Reduction of capacity is not supported currently
100207 OperationConstraints.AccountBalanceNotEnough Insufficient account balance. Please top it up.

5. Example

Input

https://redis.api.qcloud.com/v2/index.php?Action=UpgradeRedis
&redisId=crs-ifmymj41
&memSize=2048

Output

{
    "code":"0",
    "message":"",
    "codeDesc": "Success",
    "data":{
        "dealId":"432587"
    }
}