游戏数据库 TcaplusDB 上传并校验创建表格文件

1. 接口描述

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

上传并校验创建表格文件，返回校验合法的表格定义

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：VerifyIdlFiles。
Version	是	String	公共参数，本接口取值：2019-08-23。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	待创建表格的集群ID 示例值：176567
TableGroupId	否	String	待创建表格的表格组ID 示例值：15452
ExistingIdlFiles.N	否	Array of IdlFileInfo	曾经上传过的IDL文件信息列表，与NewIdlFiles至少有一者示例值：{}
NewIdlFiles.N	否	Array of IdlFileInfo	待上传的IDL文件信息列表，与ExistingIdlFiles至少有一者示例值：{}

3. 输出参数

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

4. 示例

示例1 创建表格文件校验

选中已上传的创建表格IDL文件并校验

输入示例

https://tcaplus.tencentcloudapi.com/?Action=VerifyIdlFiles
&ClusterId=5674209986
&TableGroupId=101
&ExistingIdlFiles.0.FileName=tb_example
&ExistingIdlFiles.0.FileSize=261
&ExistingIdlFiles.0.FileExtType=proto
&ExistingIdlFiles.0.FileId=551
&ExistingIdlFiles.0.FileType=PROTO
&<公共请求参数>

输出示例

{
    "Response": {
        "IdlFiles": [
            {
                "FileContent": "content",
                "FileExtType": "proto",
                "FileId": 564,
                "FileName": "tb_example",
                "FileSize": 261,
                "FileType": "PROTO"
            }
        ],
        "RequestId": "70707604-2031-4c7e-a85f-a52daf354eb0",
        "TableInfos": [
            {
                "IndexKeySet": "{\"Num\":0}",
                "KeyFields": "{\"KeyField\":[{\"Label\":\"required\",\"Name\":\"uin\",\"Type\":\"int64\"},{\"Crypto\":false,\"Label\":\"required\",\"Name\":\"name\",\"Type\":\"string\"}],\"Num\":2}",
                "TableGroupId": "212412",
                "OldKeyFields": "",
                "OldValueFields": "",
                "ShardingKeySet": "",
                "SumKeyFieldSize": 1022,
                "SumValueFieldSize": 262144,
                "TableIdlType": "PROTO",
                "TableInstanceId": "",
                "TableName": "tb_example",
                "TableType": "GENERIC",
                "TdrVersion": 1,
                "ListElementNum": 1024,
                "SortFieldNum": 1,
                "SortRule": 1,
                "ValueFields": "{\"Num\":2,\"ValueField\":[{\"Label\":\"required\",\"Name\":\"gamesvrid\",\"Type\":\"int32\"},{\"Crypto\":false,\"Label\":\"optional\",\"Name\":\"logintime\",\"Type\":\"string\"}]}"
            }
        ],
        "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: 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	操作失败。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
MissingParameter	缺少参数错误。
ResourceNotFound	资源不存在。

上传并校验创建表格文件

本页目录：