隔离云数据库实例

最近更新时间:2019-10-18 19:40:03

1. 接口描述

接口请求域名: mongodb.tencentcloudapi.com 。

本接口(IsolateDBInstance)用于隔离MongoDB云数据库按量计费实例。隔离后实例保留在回收站中,不能再写入数据。隔离一定时间后,实例会彻底删除,回收站保存时间请参考按量计费的服务条款。在隔离中的按量计费实例无法恢复,请谨慎操作。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:IsolateDBInstance
Version String 公共参数,本接口取值:2019-07-25
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: na-ashburn
InstanceId String 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同

3. 输出参数

参数名称 类型 描述
AsyncRequestId String 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 销毁按量计费的云数据库实例

输入示例

https://mongodb.tencentcloudapi.com/?Action=IsolateDBInstance
&InstanceId=cmgo-f555zzzz
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
    "AsyncRequestId": "28920"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue.InstanceHasBeenDeleted 实例已删除。
InvalidParameterValue.InstanceHasBeenIsolated 实例已隔离。
InvalidParameterValue.LockFailed 实例锁定失败。
InvalidParameterValue.NotFoundInstance 未找到实例。
InvalidParameterValue.PrePaidInstanceUnableToIsolate 预付费实例不支持销毁。