Use GetPartitionsHeatmap to query access frequency and hot data on partitions - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Operation description

We recommend that you do not call this operation because the response uses a special format that is complex to parse. Instead, use the heatmap feature of Database Autonomy Service (DAS) to view this data.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:GetPartitionsHeatmap

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConsoleContext	string	No	The reserved parameter.	None
InstanceId	string	No	The instance ID.	pxc-hzrciqy62c****
TimeRange	string	No	The query time range. Valid values: LAST_ONE_HOURS: the last hour. LAST_SIX_HOURS: the last six hours. LAST_ONE_DAYS: the last day. LAST_THREE_DAYS: the last three days. LAST_SEVEN_DAYS: the last seven days.	LAST_SIX_HOURS
Type	string	No	The data type to query. Valid values: READ_ROWS: the read rows. WRITTEN_ROWS: the written rows. READ_WRITTEN_ROWS: the read and written rows. UPDATE_ROWS: the updated rows. INSERTED_ROWS: the inserted rows. DELETED_ROWS: the deleted rows. READ_ROWS_WITH_DN: the read rows returned from a data node. WRITTEN_ROWS_WITH_DN: the written rows returned from a data node. READ_WRITTEN_ROWS_WITH_DN: the read and written rows returned from a data node.	WRITTEN_ROWS_WITH_DN

Response elements

Element	Type	Description	Example
	object	The response parameters.
Code	string	The HTTP status code.	200
Message	string	The response message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
Data	string	The partition hotspot data of the PolarDB-X 2.0 instance, in JSON format.	{ "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 ] }
RequestId	string	The request ID.	D00DB161-FEF6-5428-B37A-8D29A4C2****
Success	string	Whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.