接口功能介绍
调用modifyDBInstanceDescription接口修改实例名称。
接口约束
无
URI
POST /v1/openApi/modifyDBInstanceDescription
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| prodInstId | *必填 | String | 文档数据库对外的实例标识 | a649077e15f349cb8b4cde6f7285a568 |
| prodInstName | *必填 | String | 新实例名称 | test002 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查询XXX信息成功 |
请求示例
请求头header
无
请求体body
{
"prodInstId":"a649077e15f349cb8b4cde6f7285a568",
"prodInstName":"test002"
}
响应示例
{
"statusCode": 800,
"message": "修改mongoDB实例名称成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
