Pinpoint SQL Errors Fast with Async DAS API Queries - Database Autonomy Service

Asynchronously queries the IDs of SQL statements that generate a MySQL error code in the SQL Explorer results of a database instance.

Operation description

Note

GetAsyncErrorRequestListByCode is an asynchronous operation. After a request is sent, the complete results are not returned immediately. If the value of the isFinish parameter is false in the response, wait for 1 second and then send a request again. If the value of the isFinish parameter is true, the complete results are returned.

This API operation supports only ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters for which Database Autonomy Service (DAS) Enterprise Edition is enabled. For more information, see Enable and manage DAS Economy Edition and DAS Enterprise Edition.
If you use an SDK to call the API operations of DAS, you must set the region ID to cn-shanghai.
When you call this operation, the value of the SqlId parameter changes due to the optimization of the SQL template algorithm starting from September 1, 2024. For more information, see [Notice] Optimization of the SQL template algorithm.

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:GetAsyncErrorRequestListByCode

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 This parameter must be specified if the database instance is a PolarDB for MySQL cluster.	pi-wz9s658475e58****
Start	integer	No	The beginning 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. Note The start time must be within the storage duration of the SQL Explorer feature of the database instance, and can be up to 90 days earlier than the current time.	1642556990714
End	integer	No	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. Note The end time must be later than the start time. The interval between the start time and the end time cannot exceed 24 hours.	1642566830000
ErrorCode	string	No	The error code. You can call the GetAsyncErrorRequestStatByCode operation to query the MySQL error codes that may be generated in the SQL Explorer results of an instance.	1064

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code returned.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
Data	object	The data returned.	{ "fail": false, "data": [ { "sqlId": "ad78a4e7d3ce81590c9dc2d5f4bc**", "instanceId": "rm-2ze8g2am97624" }, { "sqlId": "0f92feacd92c048b06a16617a633", "instanceId": "rm-2ze8g2am97624" } ], "resultId": "async__c39d43ece52d35267cc4b92a0c26**", "isFinish": true, "state": "SUCCESS", "complete": true, "timestamp": 1644559407740 }
fail	boolean	Indicates whether the asynchronous request failed. Valid values: true false	false
result	array<object>	The instance ID.
	object
sqlId	string	SQL ID.	ad78a4e7d3ce81590c9dc2d5f4bc****
instanceId	string	The instance ID	rm-2ze8g2am97624****
resultId	string	The ID of the asynchronous request.	async__c39d43ece52d35267cc4b92a0c26****
isFinish	boolean	Indicates whether the asynchronous request was complete. Valid values: true false	true
state	string	The state of the asynchronous request. Valid values: RUNNING SUCCESS FAIL	SUCCESS
complete	boolean	Indicates whether the asynchronous request was complete. true false	true
timestamp	integer	The time when the asynchronous request was made. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1644559407740
RequestId	string	The request ID.	9CB97BC4-6479-55D0-B9D0-EA925AFE****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "fail": false,
    "result": [
      {
        "sqlId": "ad78a4e7d3ce81590c9dc2d5f4bc****",
        "instanceId": "rm-2ze8g2am97624****"
      }
    ],
    "resultId": "async__c39d43ece52d35267cc4b92a0c26****",
    "isFinish": true,
    "state": "SUCCESS",
    "complete": true,
    "timestamp": 1644559407740
  },
  "RequestId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
  "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.