获取数据地图中给定数据表详情。是否返回业务元数据可选。
接口说明
- 需要购买 DataWorks 基础版及以上版本才能使用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:GetTable | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Id | string | 是 | ID，可参考 ListTables 接口返回结果，以及元数据实体相关概念说明。 格式为 说明
对于 maxcompute 和 dlf 类型，实例 ID 使用空字符占位。
说明
starrocks 类型的数据目录标识为目录名称，dlf 类型的数据目录标识为目录 ID, 其他类型不支持目录层级，可用空字符占位。
说明
对于 maxcompute 类型，数据库名称即为 maxcompute 项目名称，开启三层模型的项目需要提供模式名称，未开启的项目模式名称处使用空字符占位。
几种常用类型 ID 格式参考如下
说明
其中 instance_id: 实例 ID，对应数据源以实例模式注册时需要提供encoded_jdbc_url: JDBC 连接串的 URLEncode 编码,对应数据源以连接串方式注册时需要提供catalog_id: dlf 目录 IDproject_name: maxcompute 项目名称database_name: 数据库名称schema_name: schema 名称，对于 maxcompute 类型，仅所属项目开启三层模型后需要提供。若未开启则使用空字符占位table_name: 表名称
| maxcompute-table:::project_name:[schema_name]:table_name |
| IncludeBusinessMetadata | boolean | 否 | 是否包含业务元数据，默认为 false。 | true |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "7B3435F4-2D91-XXX",
"Success": true,
"Table": {
"Id": "dlf-table::catalog_id:database_name::table_name",
"Name": "table_name",
"Comment": "测试表",
"TableType": "TABLE",
"PartitionKeys": [
"ds"
],
"ParentMetaEntityId": "dlf-database::catalog_id:database_name",
"CreateTime": 1736852168000,
"ModifyTime": 1736852168000,
"TechnicalMetadata": {
"Owner": "test_user",
"Location": "oss://test-bucket/test_tbl",
"Compressed": false,
"InputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
"OutputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
"SerializationLibrary": "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
"Parameters": {
"key": "value"
}
},
"BusinessMetadata": {
"Readme": "## 使用说明",
"Tags": [
{
"Key": "tag_key",
"Value": "tag_value"
}
],
"Categories": [
[
{
"Id": "CATEGORY.456",
"Name": "测试类目",
"ParentId": "CATEGORY.123"
}
]
],
"UpstreamTasks": [
{
"Id": 123456,
"Name": "test_task"
}
],
"Extension": {
"ProjectId": 234,
"EnvType": "Dev",
"ViewCount": 0,
"ReadCount": 0,
"FavorCount": 0
}
}
}
}错误码
访问错误中心查看更多错误码。