Use GetQueryOptimizeExecErrorSample to query failed SQL statements for a SQL template - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Queries the failed SQL statements under a SQL template.

Operation description

If you use Alibaba Cloud SDK, make sure that the aliyun-sdk-core version is later than V2.1.8. We recommend that you use the latest version.
The version of your Database Autonomy Service (DAS) SDK must be V2.1.8 or later.
If you use an SDK to call API operations of DAS, you must set the region ID to cn-shanghai.
This operation supports the following database engines:
- ApsaraDB RDS for MySQL
- PolarDB for MySQL
- ApsaraDB RDS for PostgreSQL

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Engine	string	Yes	The database engine. Valid values: MySQL PolarDBMySQL PostgreSQL	MySQL
InstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****
SqlId	string	Yes	The SQL template ID. You can call the GetQueryOptimizeExecErrorStats operation to obtain the SQL template ID.	2e8147b5ca2dfc640dfd5e43d96a****
Time	string	Yes	The date 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.	1642953600000

Response elements

Element	Type	Description	Example
	object	The response parameters.
Code	string	The HTTP status code returned.	200
Message	string	The returned message.	Successful
Data	object	The detailed information.
Total	integer	The total number of entries returned.	2
PageNo	integer	A reserved parameter.	None
PageSize	integer	A reserved parameter.	None
Extra	string	A reserved parameter.	None
List	array<object>	The queried data.
	object
OrigHost	string	The IP address of the client that executes the SQL statement.	100.104.XX.XX
User	string	The username of the client that executes the SQL statement.	test01
Dbname	string	The name of the database.	testdb01
SqlId	string	The SQL template ID.	2e8147b5ca2dfc640dfd5e43d96a****
SqlText	string	The content of the SQL statement that failed to be executed.	select * from test1
ErrorCode	string	The error code returned.	1146
Timestamp	integer	The point in time when the failed SQL statement was executed. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1643020306739
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 2,
    "PageNo": 0,
    "PageSize": 0,
    "Extra": "None",
    "List": [
      {
        "OrigHost": "100.104.XX.XX",
        "User": "test01",
        "Dbname": "testdb01",
        "SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
        "SqlText": "select * from test1",
        "ErrorCode": "1146",
        "Timestamp": 1643020306739
      }
    ]
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "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.