一、1. 接口描述
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数，本接口取值：OpenReadOnlyInstanceExclusiveAccess。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。 |
| ClusterId | 是 | String | 请使用 集群信息描述 获取 clusterId。示例值：cynosdbmysql-bdcl1n11 |
| InstanceId | 是 | String | 请使用 集群信息描述 获取 instanceId。示例值：cynosdbmysql-ins-foddsm11 |
| VpcId | 是 | String | 指定的 vpc ID，请使用 查询私有网络列表 获取 vpc ID。示例值：vpc-74h05211 |
| SubnetId | 是 | String | 指定的子网 ID，如果设置了 vpc ID，则 SubnetId 必填，请使用 查询子网列表 获取 SubnetId。示例值：subnet-d16fxg11 |
| Port | 是 | Integer | 用户自定义的端口。示例值：3306 |
| SecurityGroupIds.N | 否 | Array of String | 安全组 ID，请使用 查看安全组 获取 SecurityGroupId。示例值：["sg-nm4bjh11","sg-nm4bjh22"] |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| FlowId | Integer | 开通流程ID示例值：147284 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
四、示例1 ex:
任何场景
五、输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenReadOnlyInstanceExclusiveAccess
<公共请求参数>
{
"ClusterId": "cynosdbmysql-qwertyui",
"InstanceId": "cynosdbmysql-ins-asdfghjk",
"VpcId": "vpc-asdfghjk",
"SubnetId": "subnet-qwertyui",
"Port": 3306,
"SecurityGroupIds": [
"SecurityGroupIds1",
"SecurityGroupIds2"
]
}
六、输出示例
{
"Response": {
"FlowId": 12345,
"RequestId": "123123123123123"
}
}
七、腾讯云 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: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
十、命令行工具
·Tencent Cloud CLI 3.0
十一、6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
| FailedOperation.DatabaseAccessError | 数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.FlowCreateError | 创建流程失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.OperationFailedError | 操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InternalError.SystemError | 系统内部错误。 |
| InvalidParameterValue.ParamError | 参数错误。 |
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |