1. 接口描述
接口请求域名： tcaplusdb.tencentcloudapi.com 。
根据给定的表信息，清除表数据。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ClearTables。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ClusterId | 是 | String | 表所属集群实例ID 示例值：123 |
| SelectedTables.N | 是 | Array of SelectedTableInfoNew | 待清理表信息列表 示例值：null |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 清除表结果数量 示例值：0 |
| TableResults | Array of TableResultNew | 清除表结果列表 示例值：null |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 清除表
清除表
输入示例
https://tcaplus.tencentcloudapi.com/?Action=ClearTables
&ClusterId=5674209986
&SelectedTables.0.TableInstanceId=tcaplus-1f224454
&SelectedTables.0.TableGroupId=101
&SelectedTables.0.TableName=tb_example
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "122bb375-7464-4536-a3c5-8ddbdd6f4ce4",
"TableResults": [
{
"Error": null,
"TableGroupId": "101",
"TableIdlType": null,
"TableInstanceId": "tcaplus-1f224454",
"TableName": "tb_example",
"TableType": null,
"TaskId": "5674209986-1199",
"TaskIds": null
}
],
"TotalCount": 1
}
}示例2 clearTable
clearTable-test
输入示例
POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ClearTables
<公共请求参数>
{
"ClusterId": "19090249266",
"SelectedTables": [
{
"TableGroupId": "1",
"TableName": "auto_proto2_gene_0_27110510",
"TableIdlType": "TDR",
"TableType": "GENERIC"
}
]
}输出示例
{
"Response": {
"RequestId": "0488b016-9c9e-44d5-9bd1-55f8f59cc0d0",
"TableResults": [
{
"ApplicationId": null,
"Error": {
"Code": "MissingParameter",
"Message": "Missing parameter TableInstanceId"
},
"TableGroupId": null,
"TableIdlType": null,
"TableInstanceId": null,
"TableName": null,
"TableType": null,
"TaskId": null,
"TaskIds": null
}
],
"TotalCount": 1
}
}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.UnauthorizedOperation | 接口操作鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
