GetBlockingDetailList - Database Autonomy Service - Alibaba Cloud Documentation Center

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.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:GetBlockingDetailList	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the database instance.	rm-t4nfalp2ap421312z
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 (,).	school1,school2

Response parameters

Parameter	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.
List	object	The details of the data returned.
BatchId	long	The batch ID.	1683530096156
ClientAppName	string	The client name.	.Net SqlClient Data Provider
DataBase	string	The name of the database.	school
HostName	string	The client hostname.	ALLBNMGTAPPRD01
LoginId	string	The username that is used for the logon.	Cheney603
QueryHash	string	The hash value of the SQL statement.	6977DD06CD9CAFF2
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	long	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	long	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	long	The page number of the page returned.	1
PageSize	long	The number of entries returned on each page.	10
Total	long	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

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "List": [
      {
        "BatchId": 1683530096156,
        "ClientAppName": ".Net SqlClient Data Provider",
        "DataBase": "school",
        "HostName": "ALLBNMGTAPPRD01",
        "LoginId": "Cheney603",
        "QueryHash": "6977DD06CD9CAFF2",
        "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
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

For a list of error codes, visit the Service error codes.