用于查看表元数据信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| adb:DescribeAdbMySqlTableMeta | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。 说明
您可以调用 DescribeRegions 接口查看地域 ID。
| cn-hangzhou |
| DBClusterId | string | 是 | AnalyticDB MySQL 湖仓版集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 湖仓版集群的详情，包括集群 ID。
| am-bp11q28kvl688**** |
| Schema | string | 是 | 数据库名称。 | adb_demo |
| TableName | string | 是 | 目标表名。 说明
若该参数留空，则会返回当前日期内目标集群下所有表的使用频次数据。
| test |
返回参数
示例
正常返回示例
JSON格式
{
"Message": "Success",
"RequestId": "2FED790E-FB61-4721-8C1C-07C627FA5A19",
"Success": true,
"TableMeta": {
"TableSchema": "tpch",
"TableName": "external_supplier",
"TableType": "fact_table",
"DistributeType": "hash",
"DistributeColumn": "customer_id",
"PartitionType": "value",
"PartitionColumn": "DATE_FORMAT(login_time, '%Y%m%d')",
"PrimaryKeyColumn": "login_time,customer_id,phone_num",
"TableEngine": "XUANWU",
"IsDictEncode": true,
"IsHidden": true,
"IsAllIndex": false,
"IsFullTextDict": true,
"CreateTime": "2025-03-14 02:18:08.0",
"UpdateTime": "2024-07-25 02:07:23.0"
}
}错误码
访问错误中心查看更多错误码。