游戏数据库 TcaplusDB 上传并校验改表文件

1. 接口描述

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

选中目标表格，上传并校验改表文件，返回是否允许修改表格结构的结果。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CompareIdlFiles。
Version	是	String	公共参数，本接口取值：2019-08-23。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	待修改表格所在集群ID 示例值：187676
SelectedTables.N	是	Array of SelectedTableInfoNew	待修改表格列表示例值：{}
ExistingIdlFiles.N	否	Array of IdlFileInfo	选中的已上传IDL文件列表，与NewIdlFiles必选其一示例值：{}
NewIdlFiles.N	否	Array of IdlFileInfo	本次上传IDL文件列表，与ExistingIdlFiles必选其一示例值：{}

3. 输出参数

参数名称	类型	描述
IdlFiles	Array of IdlFileInfo	本次上传校验所有的IDL文件信息列表示例值：{}
TotalCount	Integer	本次校验合法的表格数量示例值：10
TableInfos	Array of ParsedTableInfoNew	读取IDL描述文件后,根据用户指示的所选中表格解析校验结果示例值：{}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 上传并校验修改表格结构文件

上传并校验修改表格结构文件

输入示例

https://tcaplus.tencentcloudapi.com/?Action=CompareIdlFiles
&ClusterId=5674209986
&NewIdlFiles.0.FileName=tb_example_modify
&NewIdlFiles.0.FileType=PROTO
&NewIdlFiles.0.FileExtType=proto
&NewIdlFiles.0.FileSize=287
&NewIdlFiles.0.FileContent=syntax%3d%22proto2%22%3bpackage+myTcaplusTable%3bimport+%22tcaplusservice.optionv1.proto%22%3bmessage+tb_example%7boption(tcaplusservice.tcaplus_primary_key)%3d%22uin%2cname%22%3brequired+int64+uin+%3d+1%3brequired+string+name+%3d+2%3brequired+int32+gamesvrid+%3d+3%3boptional+string+logintime+%3d+4%3boptional+int32+add_v1+%3d+5%3b%7d
&SelectedTables.0.TableInstanceId=tcaplus-1f224454
&SelectedTables.0.TableGroupId=101
&SelectedTables.0.TableName=tb_example
&SelectedTables.0.TableIdlType=PROTO
&<公共请求参数>

输出示例

{
    "Response": {
        "IdlFiles": [
            {
                "FileName": "filename",
                "FileType": "PROTO",
                "FileExtType": "proto",
                "FileSize": 0,
                "FileId": 0,
                "FileContent": "content"
            }
        ],
        "TotalCount": 1,
        "TableInfos": [
            {
                "TableIdlType": "PROTO",
                "TableInstanceId": "tcaplus-12132",
                "TableName": "name",
                "TableType": "proto",
                "KeyFields": "keyfield",
                "OldKeyFields": "oldkey",
                "ValueFields": "value",
                "OldValueFields": "oldvalue",
                "TableGroupId": "",
                "SumKeyFieldSize": 120,
                "SumValueFieldSize": 3320,
                "IndexKeySet": "indexkeyset",
                "ShardingKeySet": "shardingkey",
                "TdrVersion": 0,
                "Error": {
                    "Code": "",
                    "Message": ""
                },
                "ListElementNum": 0,
                "SortFieldNum": 0,
                "SortRule": 0
            }
        ],
        "RequestId": "435341"
    }
}

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	操作失败。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
ResourceNotFound	资源不存在。

上传并校验改表文件

本页目录：