Call GetQueryOptimizeTag to query tags for a SQL statement - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Operation description

When using the Alibaba Cloud or DAS SDK, use the latest version.
When calling DAS by using the SDK, set the region to cn-shanghai.
This operation supports the following database engines:
- RDS MySQL
- PolarDB for MySQL
- RDS 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:GetQueryOptimizeTag

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Engine	string	Yes	The database engine. Valid values: MySQL: RDS MySQL PolarDBMySQL: PolarDB for MySQL PostgreSQL: RDS PostgreSQL	MySQL
SqlId	string	Yes	The SQL template ID. You can call the GetQueryOptimizeDataStats operation to query the SQL template ID.	29d9fef63e347d39c3436658a5fe****
InstanceId	string	Yes	The instance ID.	rm-2ze8g2am97624****

Response elements

Element	Type	Description	Example
	object
Code	string	The returned status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
RequestId	string	The unique ID generated by Alibaba Cloud for the request.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
Data	object	The returned SQL tag data.
SqlId	string	The SQL template ID.	29d9fef63e347d39c3436658a5fe****
Tags	string	The SQL tags. Multiple tags are separated by commas (,).	DAS_IN_PLAN,DAS_NOT_IMPORTANT
Comments	string	The remarks.	Slow SQL from offline synchronization. No optimization needed.

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "SqlId": "29d9fef63e347d39c3436658a5fe****",
    "Tags": "DAS_IN_PLAN,DAS_NOT_IMPORTANT",
    "Comments": "Slow SQL from offline synchronization. No optimization needed."
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permissions to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.