GetAsyncErrorRequestStatResult - Database Autonomy Service

Asynchronously obtains the number of failed executions of SQL templates based on SQL Explorer data.

Operation description

Note GetAsyncErrorRequestStatResult is an asynchronous operation. After a request is sent, the complete results are not returned immediately. If the value of isFinish is false in the response, wait for 1 second and then send a request again. If the value of isFinish 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 Purchase DAS Enterprise Edition.
If you use an SDK to call API operations of DAS, you must set the region ID to cn-shanghai.

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:GetAsyncErrorRequestStatResult	Read	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 for PolarDB for MySQL instances.	pi-bp179lg03445l****
SqlIdList	string	No	The ID of the SQL template. Separate multiple SQL IDs with commas (,). You can call the GetAsyncErrorRequestListByCode operation to query the ID of the SQL query for which MySQL error code is returned.	ad78a4e7d3ce81590c9dc2d5f4bc**,0f92feacd92c048b06a16617a633**
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 beginning of the time range to query must be within the storage duration 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
DbName	string	No	The name of the database.	testdb01

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
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 request failed. Valid values: true false	false
isFinish	boolean	Indicates whether the asynchronous request was successful. Valid values: true false	true
resultId	string	The ID of the asynchronous request.	async__61f45ee381b2fa4e8a6545e3bee9****
state	string	The state of the asynchronous request. Valid values: RUNNING: The asynchronous request is running. SUCCESS: The asynchronous request is successful. FAIL: The asynchronous request fails.	SUCCESS
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.	1644558576717
complete	boolean	Indicates whether the asynchronous request was complete. true false	true
result	object []	The returned data of the asynchronous request.
	object	The data returned.
	object	The returned data of the asynchronous request.
sqlId	string	The SQL ID.	ad78a4e7d3ce81590c9dc2d5f4bc****
instanceId	string	The instance ID.	rm-2ze8g2am97624****
count	integer	The number of failed executions.	1
RequestId	string	The request ID.	3FC3F8EB-3564-5D1A-B187-3B03E5B0****
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,
    "isFinish": true,
    "resultId": "async__61f45ee381b2fa4e8a6545e3bee9****",
    "state": "SUCCESS",
    "timestamp": 1644558576717,
    "complete": true,
    "result": [
      {
        "key": {
          "sqlId": "ad78a4e7d3ce81590c9dc2d5f4bc****",
          "instanceId": "rm-2ze8g2am97624****",
          "count": 1
        }
      }
    ]
  },
  "RequestId": "3FC3F8EB-3564-5D1A-B187-3B03E5B0****",
  "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.