HandleActiveSQLRecord - AnalyticDB - Alibaba Cloud Documentation Center

Processes active queries.

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:HandleActiveSQLRecord	get	DBInstance `acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	gp-bp***************
Pids	string	Yes	The process IDs. A process ID is a unique identifier of a query.	"3003925,3003928"
OperateType	integer	No	The type of the operation on the process ID. Valid values: 0: cancel. 1: terminate. 2: forcefully terminate.	0

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Status	string	Indicates whether the request was successful. Valid values: false true	true
DBInstanceId	string	The instance ID.	gp-bp***************
Results	array<object>	The processing result of the active query.
result	object
Status	string	Indicates whether the processing was successful. Valid values: false true	true
Pid	string	The process ID, which is a unique identifier of the query.	3003925

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": true,
  "DBInstanceId": "gp-bp***************",
  "Results": [
    {
      "Status": true,
      "Pid": 3003925
    }
  ]
}

Error codes

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