游戏数据库 TcaplusDB

产品动态

产品简介

购买指南

快速入门

操作指南

使用 TcaplusDB client

使用 TcaplusDB SDK

使用 TcaplusDB RESTful API

最佳实践

常见问题

API 文档

服务协议

词汇表

联系我们
输入关键词搜索相关文档
文档中心 > 游戏数据库 TcaplusDB > API 文档 > 表格相关接口 > 查询表详情

查询表详情

最近更新时间：2021-03-16 08:08:40

我的收藏

本页目录：

1. 接口描述

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

查询表详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTables。
Version 是 String 公共参数，本接口取值：2019-08-23。
Region 是 String 公共参数，详见产品支持的 地域列表。
ClusterId 否 String 待查询表格所属集群ID
TableGroupIds.N 否 Array of String 待查询表格所属表格组ID列表
SelectedTables.N 否 Array of SelectedTableInfoNew 待查询表格信息列表
Filters.N 否 Array of Filter 过滤条件，本接口支持：TableName，TableInstanceId
Offset 否 Integer 查询结果偏移量
Limit 否 Integer 查询结果返回记录数量

3. 输出参数

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

4. 示例

示例1 查询表列表

查询表列表

输入示例

POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTables
<公共请求参数>

{
    "ClusterId": "5674209986",
    "TableGroupIds": [
        "xx"
    ],
    "Filters": [
        {
            "Name": "xx",
            "Value": "xx"
        }
    ],
    "Offset": 0,
    "Limit": 0,
    "SelectedTables": [
        {
            "TableIdlType": "xx",
            "TableGroupId": "xx",
            "FileExtType": "xx",
            "TableInstanceId": "xx",
            "Memo": "xx",
            "TableName": "xx",
            "ReservedReadQps": 0,
            "ListElementNum": 0,
            "ReservedVolume": 0,
            "ReservedWriteQps": 0,
            "FileSize": 0,
            "FileContent": "xx",
            "FileName": "xx",
            "TableType": "xx"
        }
    ]
}

输出示例

{
  "Response": {
    "RequestId": "68821f04-f15b-46e6-b4ce-669341e6c848",
    "TableInfos": [
      {
        "ApiAccessId": "10",
        "ClusterName": "gz测试App",
        "ClusterId": "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,
        "TableGroupId": "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,
        "SortFieldNum": null,
        "SortRule": null,
        "TableGroupName": "test_zone_1"
      }
    ],
    "TotalCount": 1
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 接口操作鉴权错误。
FailedOperation 操作失败。
FailedOperation.RegionMismatch 请求的地域不匹配。
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
目录
中国站