调用此API可以获取数据湖中表的基本信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dms:ListDataLakeTablebaseInfo | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DataRegion | string | 是 | 数据湖所属的地域。 | cn-hangzhou |
| Rows | integer | 否 | 分页查询时每页的行数。 | 10 |
| Page | integer | 否 | 分页查询时列表的页码。 | 1 |
| SearchKey | string | 否 | 搜索表名称的关键字。 | test |
| DbName | string | 是 | 表所在的数据库的名称。 | default |
| CatalogName | string | 是 | 查询的数据目录名称。 | hive |
| Tid | long | 否 | 租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。 | 3*** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "B43AD641-49C2-5299-9E06-1B37EC1B****",
"Success": true,
"ErrorCode": "400",
"ErrorMessage": "Specified parameter Rows is not valid.",
"TablebaseInfoList": {
"TablebaseInfo": [
{
"Owner": "test",
"ViewOriginalText": "\"\"",
"TableType": "EXTERNAL_TABLE",
"Parameters": {
"test": "test",
"test2": 1
},
"Description": "\"table\"",
"CreatorId": 0,
"CreateTime": 1731586286,
"LastAccessTime": 1608707407,
"Retention": 30000,
"Name": "100g_customer",
"OwnerType": "ROLE ",
"ViewExpandedText": "\"\"",
"DbId": 19,
"DbName": "100g_customer",
"CatalogName": "hive",
"PartitionKeys": {
"Column": [
{
"Comment": "from deserializer",
"Type": "string",
"Name": "col"
}
]
},
"ModifierId": 1410769,
"Location": "oss://xxx"
}
]
},
"TotalCount": "100"
}错误码
访问错误中心查看更多错误码。