GetAsyncErrorRequestListByCode - 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 Cost-efficient 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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:GetAsyncErrorRequestListByCode	get	All Resources *	none	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	long	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	long	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 parameters

Parameter	Type	Description	Example
	object
Code	long	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	boolean	Indicates whether the asynchronous request failed. Valid values: true false	false
result	array<object>	The instance ID.
list	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	long	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

Sample success responses

JSONformat

{
  "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
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.

Change history

Change time	Summary of changes	Operation

No change history