DescribeTableAccessCount - 查询表的访问次数

更新时间:

查看指定日期内集群下目标表或所有表被访问次数。

接口说明

当前服务的接入地址请参见服务接入点

调试

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

授权信息

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

请求参数

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

企业版、基础版或湖仓版集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有集群的集群 ID。
amv-2ze627uzpkh8a8****
TableNamestring

目标表名。

说明 若该参数留空,则会返回当前日期内目标集群下所有表的使用频次数据。
CUSTOMER
StartTimestring

查询开始时间,UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。

说明 仅支持查看 30 天内的数据。
2022-09-25T12:10:00Z
Orderstring

将查询结果按指定字段进行排序。格式为 JOSN 字符串,例如[{"Field":"TableSchema","Type":"Asc"}]。其中:

  • Field表示排序字段。支持如下取值:
    • TableSchema:表所属的数据库名。
    • TableName:表名。
    • AccessCount:表被访问的次数。
  • Type表示排序方式。支持如下取值:
    • Asc:升序排序。
    • Desc: 降序排序。
说明 若不设置参数,默认按照目标表所属的数据库升序排列。
[{"Field":"TableSchema","Type":"Asc"}]
PageNumberinteger

页码,取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1

1
PageSizeinteger

每页记录数,取值:

  • 10(默认值)
  • 30
  • 50
  • 100
30
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

6B7D627B-DA23-572D-AD71-256F64698B7D
PageNumberinteger

页码。

1
PageSizeinteger

每页记录数。

30
TotalCountinteger

总记录数。

1
Itemsarray<object>

表使用详情。

Itemsobject

详情。

ReportDatestring

表使用日期。

2022-09-26
TableSchemastring

表所属的数据库。

tpch
AccessCountstring

表被访问的次数。

6
TableNamestring

表名称。

CUSTOMER
InstanceNamestring

表所属集群的集群 ID。

amv-2ze627uzpkh8a8****

示例

正常返回示例

JSON格式

{
  "RequestId": "6B7D627B-DA23-572D-AD71-256F64698B7D",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Items": [
    {
      "ReportDate": "2022-09-26",
      "TableSchema": "tpch",
      "AccessCount": 6,
      "TableName": "CUSTOMER",
      "InstanceName": "amv-2ze627uzpkh8a8****"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-13API 内部配置变更,不影响调用查看变更详情