文档中心>云数据库 MongoDB

修改实例项目

最近更新时间:2024-10-12 11:58:26

我的收藏

1. 接口描述

本接口(ModifyMongoDBProject)用于修改实例所属项目。
接口请求域名:mongodb.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 页面。其中,此接口的 Action 字段为ModifyMongoDBProject。
参数名称
是否必选
类型
描述
instanceIds.n
String
一个或者多个实例 ID,n 表示从0开始的数组下标。实例 ID,可通过 DescribeMongoDBInstances 接口返回值中的 instanceId 获取。
projectId
Int
项目 ID,取值以用户账户 > 用户账户相关接口查询 > 项目列表 返回的 projectId 为准。

3. 输出参数

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

4. 错误码

以下错误码表列出了该接口的业务逻辑错误码。
错误代码
英文提示
错误描述
11050
InvalidParameter
业务参数错误
11056
InstanceNotExists
没有找到对应实例
11057
InstanceBeenLocked
实例正被其它流程锁定,暂时不能执行该操作
10702
InstanceStatusAbnormal
实例状态异常,暂时不能执行该操作(例如,流程中或已隔离或已删除)

5. 示例

https://mongodb.api.qcloud.com/v2/index.php?Action=ModifyMongoDBProject
&<公共请求参数>
&instanceIds.0=cmgo-6ozqe0uh
&projectId=1001
返回示例如下:
{
"code": 0,
"message": "",
"codeDesc": "Success"
}