1. 接口描述
接口请求域名： tcaplusdb.tencentcloudapi.com 。
当restful api为关闭状态时，可以通过此接口开启restful api。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：EnableRestProxy。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 集群 ID。 示例值：5674209986 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RestProxyStatus | Integer | RestProxy的状态，0为关闭，1为开启中，2为开启，3为关闭中 示例值：1 |
| TaskId | String | TaskId由 AppInstanceId-taskId 组成，以区分不同集群的任务 示例值：838418134-44 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 开启restful api
制定clusterid，开启restful api
输入示例
https://tcaplusdb.tencentcloudapi.com/?Action=EnableRestProxy
&ClusterId=5674209986
&<公共请求参数>输出示例
{
"Response": {
"RestProxyStatus": 1,
"RequestId": "request-xxx123",
"TaskId": "838418134-44"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 接口操作鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidAppName | 应用名不合法。 |
| InvalidParameterValue.InvalidClusterName | 集群名称不合法。 |
| InvalidParameterValue.InvalidTableGroupName | 非法的表格组名称。 |
| InvalidParameterValue.InvalidTimeValue | 非法的时间格式。 |
| InvalidParameterValue.InvalidZoneName | 非法的大区名称。 |
| InvalidParameterValue.UnsupportIdlType | 不支持的应用数据描述类型。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
