Use GetErrorRequestSample to query failed SQL queries - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Asynchronously queries information about failed SQL queries in SQL Explorer data. You can query up to 20 failed SQL queries within the specific time range.

Operation description

Note

GetErrorRequestSample 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.

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

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 You must specify the node ID if your database instance is a PolarDB for MySQL cluster.	pi-bp179lg03445l****
SqlId	string	No	The SQL query ID. You can call the GetAsyncErrorRequestListByCode operation to query the ID of the SQL query for which MySQL error code is returned.	2cd4432556c3dab9d825ba363637****
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 cannot exceed 24 hours.	1642566830000
DbName	string	No	The name of the database.	testdb01

Response elements

Element	Type	Description	Example
	object	The response parameters.
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	array<object>	The returned data.	[ { "sqlId": "2cd4432556c3dab9d825ba363637**", "database": "dbgateway", "originHost": "172.16.1", "tables": [ "meter_" ], "instanceId": "rm-2ze8g2am97624", "errorCode": "1062", "user": "dbgat", "sql": "insert into meter_\n ( \n \n )\n values (now(), now(), 'bbbc8624-5e19-455a-9714-8466f688**', '2022-02-10 14:00:00', '{\"endTime\":\"2022-02-10 14:00:00\",\"endTimestamp\":1644472800,\"startTime\":\"2022-02-10 13:00:00\",\"startTimestamp\":1644469200}', null, null)", "timestamp": 1644476100435 }]
	object
sqlId	string	The SQL query ID.	2cd4432556c3dab9d825ba363637****
database	string	The database name.	dbgateway
originHost	string	The IP address of the client that executes the SQL statement.	172.16.1****
tables	array	The table information.
	string	The table name.	meter_****
instanceId	string	The instance ID.	rm-2ze8g2am97624****
errorCode	string	The error code that is returned.	1062
user	string	The username of the account that is used to log on to the database.	dbgat****
sql	string	The SQL statement.	insert into meter_****
timestamp	integer	The time when the SQL query was executed. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1644476100435
RequestId	string	The request ID.	7172BECE-588A-5961-8126-C216E16B****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "Data": [
    {
      "sqlId": "2cd4432556c3dab9d825ba363637****",
      "database": "dbgateway",
      "originHost": "172.16.1****",
      "tables": [
        "meter_****"
      ],
      "instanceId": "rm-2ze8g2am97624****",
      "errorCode": "1062",
      "user": "dbgat****",
      "sql": "insert into meter_****",
      "timestamp": 1644476100435
    }
  ],
  "RequestId": "7172BECE-588A-5961-8126-C216E16B****",
  "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.