Change Name

Last updated: 2017-12-14 10:17:09

PDF

1. API Description

This API (ModifyCdbInstanceName) is used to modify the name of Cloud Database instances. The length of instance name should be limited to 60 characters. Modifying instance name is an asynchronous process, and you can use API "Query Task Details" to query the task progress.
Domain for API request: cdb.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is ModifyCdbInstanceName.

Parameter Name Required Type Description
cdbInstanceId Yes String Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the Cloud Database console page and can be obtained using API Query List of Instances. Its value equals to the uInstanceId field value in the output parameter.
cdbInstanceName Yes String Instance name. Naming rule: The name contains 1-60 characters, including letters, numbers, "_", "-"

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
message String Module error message description depending on API.
codeDesc String Error description
data Object Data

Parameter data is composed of the following parameters:

Parameter Name Type Description
jobId Int Task ID

4. Error Codes

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

Error Code Error Message Error Description
9572 InstanceNotExists Instance does not exist
9003 InvalidParameter Incorrect parameter: Instance name does not conform to the standard

5. Example

Input

https://cdb.api.qcloud.com/v2/index.php?Action=ModifyCdbInstanceName
&<Common request parameters>
&cdbInstanceId=cdb-oy5wjit0
&cdbInstanceName=newname

Output

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "jobId": 194
    }
}