文档中心 游戏数据库 TcaplusDB API文档 表实例相关接口 查询表详情

查询表详情

最近更新时间：2019-11-26 22:11:23

查看pdf

在这篇文章中：

1. 接口描述

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

查询表详情

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTables
Version 是 String 公共参数，本接口取值：2019-08-23
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-hongkong, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-siliconvalley
ApplicationId 否 String 待查询表所属应用实例ID
LogicZoneIds.N 否 Array of String 待查询表所属大区列表
SelectedTables.N 否 Array of SelectedTableInfo 待查询表信息列表
Filters.N 否 Array of Filter 过滤条件，本接口支持：TableName，TableInstanceId
Offset 否 Integer 偏移量
Limit 否 Integer 结果列表数量

3. 输出参数

参数名称 类型 描述
TotalCount Integer 表数量
TableInfos Array of TableInfo 表详情结果列表
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询表列表

查询表列表

输入示例

https://tcaplus.tencentcloudapi.com/?Action=DescribeTables
&ApplicationId=5674209986
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "68821f04-f15b-46e6-b4ce-669341e6c848",
    "TableInfos": [
      {
        "ApiAccessId": "10",
        "AppName": "gz测试App",
        "ApplicationId": "5674209986",
        "CreatedTime": "2019-08-29 22:03:27",
        "Error": null,
        "IdlFiles": [
          {
            "FileContent": null,
            "FileExtType": "proto",
            "FileId": 551,
            "FileName": "tb_example",
            "FileSize": 266,
            "FileType": "PROTO"
          }
        ],
        "IndexStruct": null,
        "KeyStruct": null,
        "ListElementNum": 1,
        "LogicZoneId": "101",
        "Memo": "pb测试表1",
        "ReservedReadQps": 80,
        "ReservedVolume": 1,
        "ReservedWriteQps": 26,
        "ShardingKeySet": "key",
        "Status": "RUNNING",
        "TableIdlType": "PROTO",
        "TableInstanceId": "tcaplus-1f224454",
        "TableName": "tb_example",
        "TableSize": 48566336,
        "TableType": "GENERIC",
        "UpdatedTime": "",
        "ValueStruct": null,
        "ZoneName": "test_zone_1"
      }
    ],
    "TotalCount": 1
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力，能显著降低使用云 API 的难度，推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。

游戏数据库 TcaplusDB 相关文档