API 文档

有奖调研

隔离云数据库实例

最近更新时间:2021-10-21 11:18:30

我的收藏

1. 接口描述

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

本接口(IsolateDBInstance)用于隔离云数据库实例,隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离,请尽快进行充值。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:IsolateDBInstance。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 查询实例列表 接口获取,其值为输出参数中字段 InstanceId 的值。

3. 输出参数

参数名称 类型 描述
AsyncRequestId String 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。(该返回字段目前已废弃,可以通过 DescribeDBInstances 接口查询实例的隔离状态)
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 隔离云数据库实例

输入示例

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

输出示例

{
  "Response": {
    "AsyncRequestId": "e48eb1e9-0ca0ecae-c0dac9c7-60d12864",
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CdbInstanceLockFailError 实例互斥操作锁定失败,请稍后重试。
InternalError.DBError 数据库异常。
InternalError.HttpError Http请求异常。
InternalError.TradeError 交易系统错误。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
InvalidParameter.JsonUnmarshalError Json反序列化错误。
OperationDenied 操作被拒绝。
OperationDenied.ActionNotSupport 不支持的操作。
OperationDenied.InstanceLockerConflict 实例锁冲突,请稍后重试。
OperationDenied.InstanceStatusError 实例状态异常。
OperationDenied.UnSupportRefundError 该实例暂不支持退款。
OperationDenied.WrongStatus 后端任务状态非法。
ResourceNotFound.CdbInstanceNotFoundError 未找到数据库实例,请确认您的实例状态是否正常。
目录