DescribeWaitingSQLRecords - AnalyticDB - Alibaba Cloud Documentation Center

Queries the lock diagnostic records of an AnalyticDB for PostgreSQL instance.

Operation description

You can call this operation to query the lock diagnostics records only for an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode.

Limits

You can call this operation up to 1,000 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
gpdb:DescribeWaitingSQLRecords	get	DBInstance `acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance. Note You can call the DescribeDBInstances operation to query the instance IDs of all AnalyticDB for PostgreSQL instances in a specific region.	gp-bp12ga6v69h86****
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 50 100 Default value: 30.	30
PageNumber	integer	No	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.	1
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. If this parameter is not specified, all lock diagnostics records that are generated before the query end time are returned. If the query end time is not specified either, all lock diagnostics records are returned.	2022-08-15T06:59Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time. If this parameter is not specified, all lock diagnostics records that are generated after the query start time are returned. If the query start time is not specified either, all lock diagnostics records are returned.	2022-08-20T07:59Z
User	string	No	The name of the database account. If this parameter is not specified, the lock diagnostics records of all database accounts are queried.	testUser
Database	string	Yes	The name of the database.	test
QueryCondition	string	Yes	The filter condition on queries. Valid values: `{"Type":"maxCost","Value":"10"}`: filters the top 10 longest-waiting queries. `{"Type":"status","Value":"LockWaiting"}`: filters lock-waiting queries. `{"Type":"status","Value":"ResourceWaiting"}`: filters resource-waiting queries.	{"Type":"maxCost","Value":"10"}
Keyword	string	No	The keyword used to filter queries.	table
Order	string	No	The field used to sort lock diagnostics records and the sorting order. Default value: `{"Field":"StartTime","Type":"Desc"}`, which indicates that lock diagnostics records are sorted by the start time in descending order. No other values are supported.	{"Field":"StartTime","Type":"Desc"}

Response parameters

Parameter	Type	Description	Example
	object
Items	array<object>	The list of lock diagnostics records.
Item	object
PID	string	The ID of the process that uniquely identifies the query.	100
SessionID	string	The ID of the session that contains the query.	50
StartTime	long	The start time of the query. This value is in the timestamp format. Unit: milliseconds.	1660902033374
WaitingTime	long	The waiting period of the query. Unit: milliseconds.	26911000
Status	string	The waiting state of the query. Valid values: LockWaiting ResourceWaiting	LockWaiting
SQLStmt	string	The SQL statement of the query.	Select * from t1,t2 where t1.id=t2.id;
User	string	The database account that is used to perform the query.	testUser
Database	string	The name of the database.	test
RequestId	string	The ID of the request.	B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
TotalCount	integer	The total number of entries returned.	1
PageNumber	integer	The page number of the returned page.	1

Examples

Sample success responses

JSONformat

{
  "Items": [
    {
      "PID": 100,
      "SessionID": 50,
      "StartTime": 1660902033374,
      "WaitingTime": 26911000,
      "Status": "LockWaiting",
      "SQLStmt": "Select * from t1,t2 where t1.id=t2.id;",
      "User": "testUser",
      "Database": "test"
    }
  ],
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "TotalCount": 1,
  "PageNumber": 1
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-10-27	Add Operation	View Change Details