如何使用GetTableProfile功能_数据湖构建(DLF)-阿里云帮助中心

获取表数据概况的详细信息。

接口说明

使用数据概况需要先将该表的 OSS Bucket 进行 Location 托管。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dlf:GetTableProfile		全部资源 ``	无	无

请求语法

GET /webapi/metastorehouse/catalog/database/tableprofile HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
CatalogId	string	否	数据目录 ID，默认填写主账号 ID	1344371
DatabaseName	string	是	元数据库名称	test_db
TableName	string	是	元数据表名称	test_tbl

返回参数

名称	类型	描述	示例值
	object	Response
Code	string	错误码	-
Message	string	错误信息	-
RequestId	string	请求 ID	97434FA4-A6B2-1AE4-A174-76964F29C759
Success	boolean	请求是否成功。取值如下： true：成功。 false：失败。	true
TableProfile	TableProfile	表数据概况

示例

正常返回示例

JSON格式

{
  "Code": "-",
  "Message": "-",
  "RequestId": "97434FA4-A6B2-1AE4-A174-76964F29C759",
  "Success": true,
  "TableProfile": {
    "PartitionCnt": 3,
    "FileCnt": 5,
    "ObjectCnt": 5,
    "FileSize": 31,
    "ObjectSize": 31,
    "RecordCnt": 2,
    "IsPartitioned": true,
    "LastModifyTime": "2023-08-16 18:02:25",
    "LastAccessTime": "2023-08-22 12:14:42",
    "DatabaseName": "test_db",
    "TableName": "test_tbl",
    "CreateTime": "2023-08-14 10:44:13",
    "Location": "oss://mybucket.cn-hangzhou.oss-dls.aliyuncs.com/test_db/test_tbl/",
    "AccessNum": 0,
    "AccessNumWeekly": 0,
    "AccessNumMonthly": 0,
    "LastAccessNumTime": "",
    "LatestDate": "2023-08-30 19:16:10",
    "LatestAccessNumDate": "",
    "LastDdlTime": "2023-08-16 18:02:24",
    "ObjectAccessNum": 0,
    "ObjectAccessNumWeekly": 18,
    "ObjectAccessNumMonthly": 18,
    "DataSourceType": "OSS_HDFS"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-08-31	OpenAPI 描述信息更新	查看变更详情