Query blocking data for SQL Server by calling GetBlockingDetailList - Database Autonomy Service

Queries the blocking data of an ApsaraDB RDS for SQL Server instance.

Operation description

This operation is applicable only to ApsaraDB RDS for SQL Server instances.
If you use an Alibaba Cloud SDK or Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call the API operations of DAS, you must 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:GetBlockingDetailList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the database instance.	rm-t4nfalp2ap421****
StartTime	string	Yes	The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1679429913757
EndTime	string	Yes	The end of the time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1682490480548
PageNo	string	No	The page number. The value must be an integer that is greater than 0. Default value: 1.	1
PageSize	string	No	The number of entries per page. The value must be an integer that is greater than 0. Default value: 10.	10
QueryHash	string	No	The hash value of the SQL statement. The hash values of SQL statements of the same type are the same.	DC08B955CAD25E7B
DbNameList	string	No	The name of the database. Separate multiple database names with commas (,).	testdb1,testdb2

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code returned.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. Otherwise, an error message such as an error code is returned.	Successful
Data	object	The returned data.
List	array<object>	The details of the data returned.
	object	The details of the data returned.
BatchId	integer	The batch ID.	1683530096156
ClientAppName	string	The client name.	.Net SqlClient Data Provider
DataBase	string	The name of the database.	testdb1
HostName	string	The client hostname.	ALLBNMGTAPPRD01
LoginId	string	The username that is used for the logon.	Testuser
QueryHash	string	The hash value of the SQL statement.	DC08B955CAD25E7B
Spid	string	The session ID.	1717
SqlText	string	The SQL statement.	select * from test1
StartTime	string	The time when the execution started. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1608888296000
WaitTimeMs	integer	The duration of the blocking. Unit: milliseconds.	30000
WaitType	string	The wait type. For more information about wait types, see sys.dm_os_wait_stats (Transact-SQL).	MISCELLANEOUS
CurrentCollectionTime	integer	The time when the blocking data was collected. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1700065800000
PageNo	integer	The page number of the page returned.	1
PageSize	integer	The number of entries returned on each page.	10
Total	integer	The total number of entries returned.	19
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "List": [
      {
        "BatchId": 1683530096156,
        "ClientAppName": ".Net SqlClient Data Provider",
        "DataBase": "testdb1",
        "HostName": "ALLBNMGTAPPRD01",
        "LoginId": "Testuser",
        "QueryHash": "DC08B955CAD25E7B",
        "Spid": "1717",
        "SqlText": "select * from test1",
        "StartTime": "1608888296000",
        "WaitTimeMs": 30000,
        "WaitType": "MISCELLANEOUS",
        "CurrentCollectionTime": 1700065800000
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "Total": 19
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "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.