文档中心 API 中心 云数据库 MySQL 实例相关接口 下线隔离状态的云数据库实例

下线隔离状态的云数据库实例

最近更新时间:2019-07-24 15:08:53

1. 接口描述

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

本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态,即通过 查询实例列表 接口查询到 Status 值为 5 的实例。

该接口为异步操作,部分资源的回收可能存在延迟。您可以通过使用 查询实例列表 接口,指定实例 InstanceId 和状态 Status 为 [5,6,7] 进行查询,若返回实例为空,则实例资源已全部释放。

注意,实例下线后,相关资源和数据将无法找回,请谨慎操作。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cdb.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:OfflineIsolatedInstances
Version String 公共参数,本接口取值:2017-03-20
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 下线隔离状态的云数据库实例

输入示例

https://cdb.tencentcloudapi.com/?Action=OfflineIsolatedInstances
&InstanceIds.0=cdb-70zdmgg1
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。