Asynchronously retrieve the number of execution errors for an SQL statement with GetAsyncErrorRequestStatResult - Database Autonomy Service

Call the GetAsyncErrorRequestStatResult operation to asynchronously obtain the number of execution errors for a specified SQL statement from the SQL Explorer results for a database instance.

Operation description

Note

An asynchronous call does not immediately return the complete result. If the isFinish parameter in the response is false, wait 1 s and call the operation again. The complete result is returned when isFinish is true.

This operation supports only ApsaraDB RDS for MySQL and PolarDB for MySQL instances. Ensure that DAS Enterprise Edition is enabled for the instance before you call this operation. For more information, see Purchase DAS Enterprise Edition.
When you use a software development kit (SDK) to call the DAS service, 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:GetAsyncErrorRequestStatResult

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****
NodeId	string	No	The node ID. Note Specify the node ID for PolarDB for MySQL instances.	pi-bp179lg03445l****
SqlIdList	string	No	The SQL ID. Separate multiple SQL IDs with commas (,). Call the GetAsyncErrorRequestListByCode operation to query the SQL IDs that generate MySQL error codes for an instance.	ad78a4e7d3ce81590c9dc2d5f4bc**,0f92feacd92c048b06a16617a633**
Start	integer	No	The start time of the query. This value is a UNIX timestamp. Unit: milliseconds. Note The start time must be within the storage duration of SQL Explorer for the database instance and can be up to 90 days before the current time.	1642556990714
End	integer	No	The end time of the query. This value is a UNIX timestamp. Unit: milliseconds. Note The end time must be later than the start time. The interval between the start time and the end time cannot exceed one day.	1642566830000
DbName	string	No	The database name.	testdb01

Response elements

Element	Type	Description	Example
	object	The returned data.
Code	integer	The status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message is returned.	Successful
Data	object	The returned data.	{ "fail": false, "data": { "ad78a4e7d3ce81590c9dc2d5f4bc**": { "sqlId": "ad78a4e7d3ce81590c9dc2d5f4bc", "instanceId": "rm-2ze8g2am97624", "count": 1 }, "0f92feacd92c048b06a16617a633": { "sqlId": "0f92feacd92c048b06a16617a633", "instanceId": "rm-2ze8g2am97624", "count": 2 } }, "resultId": "async__61f45ee381b2fa4e8a6545e3bee9**", "isFinish": true, "state": "SUCCESS", "complete": true, "timestamp": 1644558576717 }
fail	boolean	Indicates whether the request failed. true false	false
isFinish	boolean	Indicates whether the asynchronous request is complete. true false	true
resultId	string	The ID of the asynchronous request.	async__61f45ee381b2fa4e8a6545e3bee9****
state	string	The state of the asynchronous request. RUNNING SUCCESS FAIL	SUCCESS
timestamp	integer	The time when the request was made. This value is a UNIX timestamp. Unit: milliseconds.	1644558576717
complete	boolean	Indicates whether the asynchronous request is complete. true false	true
result	object	The data returned for the asynchronous request.
	object
sqlId	string
instanceId	string
count	integer
RequestId	string	The request ID.	3FC3F8EB-3564-5D1A-B187-3B03E5B0****
Success	boolean	Indicates whether the request was successful. true false	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "fail": false,
    "isFinish": true,
    "resultId": "async__61f45ee381b2fa4e8a6545e3bee9****",
    "state": "SUCCESS",
    "timestamp": 1644558576717,
    "complete": true,
    "result": {
      "key": {
        "sqlId": "",
        "instanceId": "",
        "count": 0
      }
    }
  },
  "RequestId": "3FC3F8EB-3564-5D1A-B187-3B03E5B0****",
  "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.