文档

GetPartitionsHeatmap - 获取分区热度信息

更新时间:

调用GetPartitionsHeatmap接口,查看PolarDB-X 2.0分区访问热度和数据热点。

接口说明

该接口不建议用户自行调用,因为返回的数据格式比较特殊,自行解析会非常复杂,建议使用阿里云 DAS 的分区热力图功能查看该数据。

调试

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

授权信息

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

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

请求参数

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

备用参数。

None
InstanceIdstring

实例 ID。

pxc-hzrciqy62c****
TimeRangestring

需要查询的时间范围:

  • LAST_ONE_HOURS:过去一小时。
  • LAST_SIX_HOURS:过去六小时。
  • LAST_ONE_DAYS:过去一天。
  • LAST_THREE_DAYS:过去三天。
  • LAST_SEVEN_DAYS:过去七天。
LAST_SIX_HOURS
Typestring

需要查询的数据类型:

  • READ_ROWS:读行数。
  • WRITTEN_ROWS:写行数。
  • READ_WRITTEN_ROWS:读写行数。
  • UPDATE_ROWS:更新行数。
  • INSERTED_ROWS:插入行数。
  • DELETED_ROWS:删除行数。
  • READ_ROWS_WITH_DN:以 DN 视角返回的读行数。
  • WRITTEN_ROWS_WITH_DN:以 DN 视角返回的写行数。
  • READ_WRITTEN_ROWS_WITH_DN:以 DN 视角返回的读写行数。
WRITTEN_ROWS_WITH_DN

返回参数

名称类型描述示例值
object

返回信息列表。

Codestring

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
Datastring

分布式数据库的数据热点数据。返回 JSON 格式的文本。

{ "boundAxis": [ { "bound": "A,B,C,D", "labels": [ "L1", "L2", "L3", "L4" ], "rows": 3171 }, { "bound": "A,B,C,D", "labels": [ "L1", "L2", "L3", "L4" ], "rows": 277128 } ], "dataMap": { "READ_WRITTEN_ROWS": [ [ 0, 0, 0 ], [ 0, 0, 0 ] ] }, "timeAxis": [ 1671701056070, 1671701116551, 1671701177020 ] }
RequestIdstring

请求 ID。

D00DB161-FEF6-5428-B37A-8D29A4C2****
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "Data": "{\n    \"boundAxis\": [\n        {\n            \"bound\": \"A,B,C,D\",\n            \"labels\": [\n                \"L1\",\n                \"L2\",\n                \"L3\",\n                \"L4\"\n            ],\n            \"rows\": 3171\n        },\n        {\n            \"bound\": \"A,B,C,D\",\n            \"labels\": [\n                \"L1\",\n                \"L2\",\n                \"L3\",\n                \"L4\"\n            ],\n            \"rows\": 277128\n        }\n    ],\n    \"dataMap\": {\n        \"READ_WRITTEN_ROWS\": [\n            [\n                0,\n                0,\n                0\n            ],\n            [\n                0,\n                0,\n                0\n            ]\n        ]\n    },\n    \"timeAxis\": [\n        1671701056070,\n        1671701116551,\n        1671701177020\n    ]\n}",
  "RequestId": "D00DB161-FEF6-5428-B37A-8D29A4C2****",
  "Success": "true"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈