Change Instance Name

Last updated: 2019-11-29 16:28:36

PDF

1. API Description

This API (ModifyRedisName) is used to modify the name of an instance.
Domain name for API request: redis.api.qcloud.com

Rule on instance name: It should have a length of 1-36 characters comprised of letters, numbers, "_" or "-".

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 ModifyRedisName.

Parameter Name Required Type Description
redisId Yes String ID of instance to work with. This can be obtained from redisId in the returned values of API DescribeRedis.
redisName Yes String Instance name. It should have a length of 1-36 characters comprised of letters, numbers, "_" or "-"

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.

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
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"
11211 InstanceNameExceedMaxLimit Length of instance name exceeds the limit
11212 InstanceNameRuleError Instance name does not conform to the rule: A length of 1-36 characters comprised of letters, numbers, "_", "-"

5. Example

https://redis.api.qcloud.com/v2/index.php?Action=ModifyRedisName
&redisId=crs-izbob1wh
&redisName=test_API

The returned results are as below:

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