Use CreateQueryOptimizeTag to add tags to SQL templates - Database Autonomy Service

Operation description

If you use Alibaba Cloud SDK or Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call 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:CreateQueryOptimizeTag

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Engine	string	Yes	The database engine. Valid values: MySQL: ApsaraDB RDS for MySQL PolarDBMySQL: PolarDB for MySQL PostgreSQL: ApsaraDB RDS for PostgreSQL	MySQL
SqlIds	string	Yes	The SQL template IDs. You can call the GetQueryOptimizeExecErrorStats operation to obtain the SQL template ID. Separate multiple SQL template IDs with commas (,).	6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****
Tags	string	Yes	The SQL tags. Separate multiple SQL tags with commas (,). Valid values: DAS_IMPORTANT: The SQL template is important. DAS_NOT_IMPORTANT: The SQL template is unimportant. USER_IGNORE: The scheduling of the SQL template does not need to be optimized. DAS_IN_PLAN: The scheduling of the SQL template needs to be optimized.	DAS_IN_PLAN,DAS_NOT_IMPORTANT
Status	integer	Yes	The status of Tags. Valid values: 0: removes all tags added to the SQL templates that are specified by SqlIds and leaves Tags empty. 1: adds the tags specified by Tags to the SQL templates that are specified by SqlIds.	1
Comments	string	No	The remarks. The remarks can be 1 to 300 characters in length.	离线同步类慢SQL，无需优化。
InstanceId	string	Yes	The instance ID.	rm-2ze1jdv45i7l6****

Response elements

Element	Type	Description	Example
	object
Code	string	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
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true false	true
Data	boolean	Indicates whether the tags were added to the SQL templates. true false	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": 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.