TDSQL-C MySQL 版隔离实例-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cynosdb.tencentcloudapi.com 。

本接口(IsolateInstance)用于隔离实例。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：IsolateInstance。
Version	是	String	公共参数，本接口取值：2019-01-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
ClusterId	是	String	集群ID 示例值：cynosdbmysql-ins-bzkxxrmt
InstanceIdList.N	是	Array of String	实例ID数组，例如["cynosdbbmysql-ins-asd","cynosdbmysql-ins-zxc"] 示例值：["cynosdbmysql-ixgbd0di\n"]
DbType	否	String	该参数已废弃示例值：MYSQL
IsolateReasonTypes.N	否	Array of Integer	实例退还原因类型示例值：[1,2,3]
IsolateReason	否	String	实例退还原因补充示例值：退还原因

3. 输出参数

参数名称	类型	描述
FlowId	Integer	任务流id 示例值：123
DealNames	Array of String	隔离实例的订单id（预付费实例）注意：此字段可能返回 null，表示取不到有效值。示例值：["1234"]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 隔离实例

隔离实例

输入示例

POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: IsolateInstance
<公共请求参数>

{
    "InstanceIdList": [
        "cynosdbmysql-ixgbd0di"
    ],
    "ClusterId": "cynosdbmysql-ins-bzkxxrmt"
}

输出示例

{
    "Response": {
        "RequestId": "128046",
        "DealNames": [
            "23456"
        ],
        "FlowId": 123
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.DatabaseAccessError	数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.FlowCreateError	创建流程失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.OperationFailedError	操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.TradeCreateOrderError	创建并支付订单失败，请稍后重试。如果持续不成功，请联系客服进行处理。
InvalidParameter.IsolateNotAllowed	当前实例不可隔离。
InvalidParameterValue.InstanceNotFound	实例不存在。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
OperationDenied.ClusterOpNotAllowedError	由于操作禁止，当前集群不允许该操作。
ResourceNotFound.InstanceNotFoundError	实例不存在。
ResourceNotFound.ResourceError	参数对应资源不存在。
ResourceUnavailable.InstanceLockFail	锁定实例失败，暂时不可操作。
ResourceUnavailable.InstanceStatusAbnormal	实例状态异常，暂时不可操作。
UnauthorizedOperation.PermissionDenied	CAM鉴权不通过。