修改名称

最近更新时间:2017-12-14 10:17:09

1. 接口描述

本接口(ModifyCdbInstanceName)用于修改云数据库实例名称,实例名称最大支持60个字符,修改实例名称是异步处理过程,您可使用查询任务详情接口查询任务处理状态。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为ModifyCdbInstanceName。

参数名称 必选 类型 描述
cdbInstanceId String 实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
cdbInstanceName String 实例名称,规则:1-60个字母、数字、非符号中文、_、-

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误描述
data Object 数据

其中, data 参数构成如下:

参数名称 类型 描述
jobId Int 任务ID

4. 错误码表

以下错误码表列出了该接口的业务逻辑错误码。

错误代码 英文提示 错误描述
9572 InstanceNotExists 实例不存在
9003 InvalidParameter 参数错误:实例名称不符合规则

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=ModifyCdbInstanceName
&<公共请求参数>
&cdbInstanceId=cdb-oy5wjit0
&cdbInstanceName=newname

输出

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