文档

GetTableProfile - 获取表数据概况

更新时间:

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

接口说明

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

调试

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

授权信息

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

请求语法

GET /webapi/metastorehouse/catalog/database/tableprofile

请求参数

名称类型必填描述示例值
CatalogIdstring

数据目录 ID,默认填写主账号 ID

1344371
DatabaseNamestring

元数据库名称

test_db
TableNamestring

元数据表名称

test_tbl

返回参数

名称类型描述示例值
object

Response

Codestring

错误码

-
Messagestring

错误信息

-
RequestIdstring

请求 ID

97434FA4-A6B2-1AE4-A174-76964F29C759
Successboolean

请求是否成功。取值如下:

  • true:成功。
  • false:失败。
true
TableProfileTableProfile

表数据概况

示例

正常返回示例

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-31OpenAPI 描述信息更新查看变更详情