首页 数据库自治服务 开发参考 API参考 API目录 查询治理 CreateQueryOptimizeTag - 对目标SQL进行打标

CreateQueryOptimizeTag - 对目标SQL进行打标

更新时间: 2024-12-02 10:32:21

调用CreateQueryOptimizeTag接口,对目标SQL进行打标。

接口说明

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
  • 本接口适用的数据库引擎为:
    • RDS MySQL
    • PolarDB MySQL 版
    • RDS PostgreSQL

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:CreateQueryOptimizeTagupdate
*全部资源
*

请求参数

名称类型必填描述示例值
Enginestring

数据库引擎,取值:

  • MySQL:RDS MySQL
  • PolarDBMySQL:PolarDB MySQL 版
  • PostgreSQL:RDS PostgreSQL
MySQL
SqlIdsstring

SQL 模板 ID,您可以调用 GetQueryOptimizeDataStats 接口查询 SQL 模板 ID。支持英文逗号(,)分隔传入多个模板 ID,进行批量打标。

6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****
Tagsstring

SQL 标签。支持英文逗号(,)分隔传入多个值。

  • DAS_IMPORTANT:重要 SQL。
  • DAS_NOT_IMPORTANT:不重要 SQL。
  • USER_IGNORE:无需优化。
  • DAS_IN_PLAN:排期优化。
DAS_IN_PLAN,DAS_NOT_IMPORTANT
Statusinteger

设置请求参数 Tags 的状态:

  • 0:清空请求参数 SqlIds 对应的全部标签,忽略请求参数 Tags 设置。
  • 1:设置请求参数 SqlIds 对应的标签为请求参数 Tags 的值。
1
Commentsstring

备注。

长度为 1~300 个字符。

离线同步类慢SQL,无需优化。
InstanceIdstring

实例 ID。

rm-2ze1jdv45i7l6****

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

阿里云为该请求生成的唯一标识符。

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

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true
Databoolean

打标操作是否执行成功:

  • true:打标成功。
  • false:打标失败。
true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: 查询治理 下一篇: GetQueryOptimizeExecErrorStats - 获取执行失败的模板数据
阿里云首页 数据库自治服务 相关技术圈