GetTable - 查询表

更新时间:
复制 MD 格式

获取表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Name

string

表名称

my_table

ClientToken

string

幂等 Token

1e9b8f60-3a2c-4d7e-9f1b-8c3d5e7a2b4f

Catalog

string

所属数据目录

my_catalog

Namespace

string

所属命名空间

my_namespace

返回参数

名称

类型

描述

示例值

object

Message

string

接口返回信息

Operation success

RequestId

string

请求 ID

34AD682D-5B91-5773-8132-AA38C130****

Code

string

返回码

200

Success

boolean

是否成功

true

Data Table

表详情信息

示例

正常返回示例

JSON格式

{
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Code": "200",
  "Success": true,
  "Data": {
    "Catalog": "my_catalog",
    "Namespace": "my_namespace",
    "Name": "my_table",
    "Comment": "测试事件表",
    "CreateTime": 1717948800000,
    "UpdateTime": 1717948800000,
    "RetentionPolicy": {
      "HotTTL": 7,
      "ColdTTL": 30
    },
    "Columns": [
      {
        "Name": "id",
        "Type": "bigint",
        "Comment": "主键ID"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

403 ServiceNotEnable Service not enable

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情