All Products
Search

This Product

    Database Autonomy Service:CreateQueryOptimizeTag

    Document Center

    Database Autonomy Service:CreateQueryOptimizeTag

    Last Updated:Dec 23, 2024

    Adds a tag to a SQL template.

    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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    hdm:CreateQueryOptimizeTagupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    EnginestringYes

    The database engine. Valid values:

    • MySQL: ApsaraDB RDS for MySQL
    • PolarDBMySQL: PolarDB for MySQL
    • PostgreSQL: ApsaraDB RDS for PostgreSQL
    		MySQL
    SqlIdsstringYes

    The SQL template IDs. You can call the GetQueryOptimizeExecErrorStats operation to obtain the SQL template ID. Separate multiple SQL template IDs with commas (,).

    		6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0e941
    TagsstringYes

    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
    StatusintegerYes

    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
    CommentsstringNo

    The remarks.

    The remarks can be 1 to 300 characters in length.

    		Slow SQL queries of offline synchronization. No optimization is required.
    InstanceIdstringYes

    The instance ID.

    		rm-2ze1jdv45i7l6****

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The HTTP status code returned.

    		200
    Messagestring

    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
    RequestIdstring

    The request ID.

    		B6D17591-B48B-4D31-9CD6-9B9796B2****
    Successstring

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    Databoolean

    Indicates whether the tags were added to the SQL templates.

    • true
    • false
    		true

    Examples

    Sample success responses

    JSONformat

    {
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": true
}

    Error codes

    HTTP status codeError codeError message
    400InvalidParamsThe request parameters are invalid.
    403NoPermissionYou are not authorized to do this action.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history