查看指定日期内集群下目标表或所有表被访问次数。
接口说明
当前服务的接入地址请参见服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 企业版、基础版或湖仓版集群 ID。 说明
您可以调用 DescribeDBClusters 接口查看目标地域下所有集群的集群 ID。
| amv-2ze627uzpkh8a8**** |
TableName | string | 否 | 目标表名。 说明
若该参数留空,则会返回当前日期内目标集群下所有表的使用频次数据。
| CUSTOMER |
StartTime | string | 是 | 查询开始时间,UTC 时间,格式:yyyy-MM-ddTHH:mm:ssZ。 说明
仅支持查看 30 天内的数据。
| 2022-09-25T12:10:00Z |
Order | string | 否 | 将查询结果按指定字段进行排序。格式为 JOSN 字符串,例如
说明
若不设置参数,默认按照目标表所属的数据库升序排列。
| [{"Field":"TableSchema","Type":"Asc"}] |
PageNumber | integer | 否 | 页码,取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1。 | 1 |
PageSize | integer | 否 | 每页记录数,取值:
| 30 |
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
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-13 | API 内部配置变更,不影响调用 | 查看变更详情 |