GetDeadlockHistogram - Database Autonomy Service - Alibaba Cloud Documentation Center

Retrieves a time-series histogram of deadlock occurrences based on the full deadlock analysis of error logs within a specified time range.

Operation description

This API lets you query the number of deadlocks detected by Database Autonomy Service (DAS) over time. DAS periodically analyzes database error logs to parse and analyze deadlock occurrences. For more information, see Full deadlock analysis.

Before you call this operation, ensure that the following requirements are met:

Supported engines: The target database engine is RDS MySQL or PolarDB for MySQL.
DAS Edition: You have activated DAS Economy Edition or DAS Enterprise Edition.
SDK version: Use the latest version of the Alibaba Cloud SDK.
Region: If you call the API via the SDK, set the region ID to cn-shanghai.

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:GetDeadlockHistogram

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the database instance.	pc-bp1u5mas9exx7****
NodeId	string	No	The node ID. Note Required for PolarDB for MySQL cluster instances	pi-bp16v3824rt73****
StartTime	integer	Yes	The beginning of the time range to query. Specify the time in the UNIX timestamp format. Unit: milliseconds. Note The maximum query window is 7 days. Important This field is of the Long type. During serialization/deserialization, precision loss may occur. Make sure that the value does not exceed 9007199254740991.	1731983066000
EndTime	integer	Yes	The end of the time range to query. Specify the time in the UNIX timestamp format. Unit: milliseconds. Important This field is of the Long type. During serialization/deserialization, precision loss may occur. Make sure that the value does not exceed 9007199254740991.	1732069466000
Status	string	No	The status of the analysis task.	SUCCESS

Response elements

Element	Type	Description	Example
	object
Code	integer	The returned status code.	200
Message	string	The message returned. Note When the request is successful, this parameter returns Successful. When the request fails, this parameter returns exception information such as error codes.	Successful
RequestId	string	The unique request ID.	0A74B755-98B7-59DB-8724-1321B394****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed. 枚举值：执行成功 : true 执行失败 : false	true
Data	array<object>	The response data.
	object	A list of response parameters.
UserId	string	The user ID.	108************
InstanceId	string	The instance ID.	pc-bp1u5mas9exx7****
NodeId	string	The node ID, used for PolarDB MySQL clusters.	pi-bp16v3824rt73****
TaskId	string	The ID of the full deadlock analysis task.	B6D17591-B48B-4D31-9CD6-1321B394****
StartTime	string	The start time of the analysis task range.	1729994400000
EndTime	string	The end time of the analysis task range.	1729998000000
LockNumber	integer	The number of deadlocks.	2
Status	string	The task status: SUCCESS: The analysis was successful. FAILED: The analysis was abnormal or failed.	SUCCESS

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": true,
  "Data": [
    {
      "UserId": "108************",
      "InstanceId": "pc-bp1u5mas9exx7****",
      "NodeId": "pi-bp16v3824rt73****",
      "TaskId": "B6D17591-B48B-4D31-9CD6-1321B394****",
      "StartTime": "1729994400000",
      "EndTime": "1729998000000",
      "LockNumber": 2,
      "Status": "SUCCESS"
    }
  ]
}

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.