1. 接口描述
接口请求域名: tcaplusdb.tencentcloudapi.com 。
根据用户选定的表定义IDL文件,批量修改指定的表
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyTables。 |
Version | 是 | String | 公共参数,本接口取值:2019-08-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 待修改表格所在集群ID 示例值:123 |
IdlFiles.N | 是 | Array of IdlFileInfo | 选中的改表IDL文件 示例值:null |
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=ModifyTables
&ClusterId=5674209986
&IdlFiles.0.FileName=tb_example_modify
&IdlFiles.0.FileType=PROTO
&IdlFiles.0.FileExtType=proto
&IdlFiles.0.FileSize=292
&IdlFiles.0.FileId=600
&SelectedTables.0.TableInstanceId=tcaplus-1f224454
&SelectedTables.0.TableGroupId=101
&SelectedTables.0.TableName=tb_example
&SelectedTables.0.TableIdlType=PROTO
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "007a279d-fd19-452c-842e-46a804e8564b",
"TableResults": [
{
"Error": null,
"TableGroupId": "101",
"TableIdlType": "PROTO",
"TableInstanceId": "tcaplus-1f224454",
"TableName": "tb_example",
"TableType": "GENERIC",
"TaskId": "5674209986-1200",
"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 | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
ResourceNotFound | 资源不存在。 |