All Products
Search

This Product

    Database Autonomy Service:CreateQueryOptimizeTag

    Document Center

    Database Autonomy Service:CreateQueryOptimizeTag

    Last Updated:Sep 08, 2026

    Calls the CreateQueryOptimizeTag operation to add tags to target SQL statements.

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

    update

    *All Resource

    *

    		 None 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
    SqlIds

    string

    Yes

    The SQL template ID. You can call the GetQueryOptimizeDataStats operation to query SQL template IDs. You can specify multiple template IDs separated by commas (,) to add tags in batches.

    6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****
    Tags

    string

    Yes

    The SQL tag. You can specify multiple values separated by commas (,).

    • DAS_IMPORTANT: important SQL.

    • DAS_NOT_IMPORTANT: unimportant SQL.

    • USER_IGNORE: optimization not required.

    • DAS_IN_PLAN: scheduled for optimization.

    DAS_IN_PLAN,DAS_NOT_IMPORTANT
    Status

    integer

    Yes

    The status of the Tags request parameter.

    • 0: Clears all tags for the SQL template IDs specified by SqlIds and ignores the Tags parameter.

    • 1: Sets the tags for the SQL template IDs specified by SqlIds to the values specified by Tags.

    1
    Comments

    string

    No

    The remarks.

    The value must be 1 to 300 characters in length.

    Slow SQL from offline synchronization. No optimization needed.
    InstanceId

    string

    Yes

    The instance ID.

    rm-2ze1jdv45i7l6****

    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 that contains information 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

    boolean

    Indicates whether the tagging operation is successful. Valid values:

    • true: The tagging operation is successful.

    • false: The tagging operation fails.

    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. The request parameters are invalid.
    403 NoPermission You are not authorized to do this action. You do not have the permission to perform this operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.