Deadlock Analysis Overview via Histogram API - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Queries the trend of deadlock counts based on full deadlock analysis of error logs within a specified time range.

Operation description

This operation queries the number of deadlocks based on full deadlock analysis within a specified time range. Database Autonomy Service (DAS) periodically analyzes error logs, parses deadlock information, and calculates the trend of deadlock counts. For details, see Full deadlock analysis.

Before you invoke this operation, ensure that the following prerequisites are met:

The target database engine is ApsaraDB RDS for MySQL or PolarDB for MySQL, and DAS Alibaba Cloud Managed Services (formerly DAS Economy Edition) is activated.
If you use the Alibaba Cloud SDK or DAS SDK, use the latest version.
When you use an SDK to invoke DAS, set the region 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 instance ID.	pc-bp1u5mas9exx7****
NodeId	string	No	The node ID. Note For a PolarDB for MySQL instance, you must specify the node ID.	pi-bp16v3824rt73****
StartTime	integer	Yes	The start time of the query. The format is a UNIX timestamp in milliseconds. Note The start time cannot be more than 7 days earlier than the end time. Important This field is of the Long type. Precision loss may occur during serialization or deserialization. Ensure that the value does not exceed 9007199254740991.	1731983066000
EndTime	integer	Yes	The end time of the query. The format is a UNIX timestamp in milliseconds. Important This field is of the Long type. Precision loss may occur during serialization or deserialization. Ensure that the value does not exceed 9007199254740991.	1732069466000
Status	string	No	The analysis status of the task.	SUCCESS

Response elements

Element	Type	Description	Example
	object
Code	integer	The returned status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
RequestId	string	The 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. Valid values: 执行成功 : true 执行失败 : false	true
Data	array<object>	The returned data.
	object	The list of returned information.
UserId	string	The user ID.	108************
InstanceId	string	The instance ID.	pc-bp1u5mas9exx7****
NodeId	string	The node ID. This parameter is used for PolarDB for 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. The time is a UNIX timestamp in milliseconds.	1729994400000
EndTime	string	The end time of the analysis task range. The time is a UNIX timestamp in milliseconds.	1729998000000
LockNumber	integer	The number of deadlocks.	2
Status	string	The task status. Valid values: SUCCESS: The analysis was successful. FAILED: The analysis is 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.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permission to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.