修改实例名称

最近更新时间:2017-05-03 14:34:18

1. 接口描述

本接口(ModifyMongoDBName)用于修改实例名称。
接口请求域名:mongodb.api.qcloud.com

实例名称规则: 1-36个字母、数字、非符号中文、_、-

2. 输入参数

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

参数名称 是否必选 类型 描述
instanceId String 待操作的实例ID,可通过 DescribeMongoDBInstances 接口返回值中的 instanceId 获取。
instanceName String 实例名称,规则:1-36个字母、数字、非符号中文、_、-

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 错误信息描述, 成功时,该值为空
codeDesc String 业务侧错误码英文描述。成功时返回Success,错误时返回具体业务错误原因。

4. 错误码

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

错误代码 英文提示 错误描述
11050 InvalidParameter 业务参数错误
11056 InstanceNotExists 没有找到对应实例
11051 InstanceDeleted 实例到期已被回收
11052 InstanceIsolated 实例到期已被隔离
11054 InstanceNameExceedMaxLimit 实例名称长度超过最大限制
11055 InstanceNameRuleError 实例名称不符合规则:1-36个字母、数字、非符号中文、_、-

5. 示例


https://mongodb.api.qcloud.com/v2/index.php?Action=ModifyMongoDBName
&<公共请求参数>
&instanceId=cmgo-6ozqe0uh
&instanceName=test_API

返回示例如下:

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