GetQueryOptimizeShareUrl - 获取查询治理的分享链接

调用GetQueryOptimizeShareUrl接口,获取查询治理的分享链接。

接口说明

  • 使用阿里云或 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:GetQueryOptimizeShareUrlget
*全部资源
*

请求参数

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

数据库引擎,取值:

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

实例 ID,多个实例 ID 间用逗号分隔。

rm-2ze1jdv45i7l6****
TagNamesstring

备用参数。

None
Keywordsstring

SQL 文本关键词,多个关键词以空格分隔。

select update
LogicalOperatorstring

多个 SQL 文本关键词的逻辑关系。

  • or:或。
  • and:与。
or
Rulesstring

需要过滤的规则,多个规则以逗号分隔。具体信息请参见查询治理

DAS_NOT_IMPORTANT
DbNamesstring

需要查询的数据库名。

testdb01
Timelong

查询数据的日期,格式为 Unix 时间戳,单位为毫秒。

1642953600000
PageSizeinteger

分页查询每页最大记录数,默认为 10。

10
PageNointeger

分页查询的页码,从 1 开始,默认为 1。

1
OrderBystring

排序字段,默认为 count

  • count:执行次数。
  • maxQueryTime:最大执行时间。
  • avgQueryTime:平均执行时间。
  • maxLockTime:最大锁等待时间。
  • avgLockTime:平均锁等待时间。
  • maxRowsExamined:最大扫描行数。
  • avgRowsExamined:平均扫描行数。
  • maxRowsSent:最大返回行数。
  • avgRowsSent:平均返回行数。
count
Ascboolean

是否升序排序,默认为 true

  • true:是。
  • false:否。
true
OnlyOptimizedSqlboolean

是否只查询待优化的 SQL,默认为 false

  • true:是。
  • false:否。
true
SqlIdsstring

SQL 模板 ID,您可调用 GetQueryOptimizeDataStats 接口查询 SQL 模板 ID。

6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****
Regionstring

实例所属地域,取值:

  • cn-china:中国内地。
  • cn-hongkong:中国香港。
  • ap-southeast-1:新加坡。

此参数只有在请求参数 InstanceIds 为空时有效。如果请求参数 InstanceIds 为空时,按照 Region 参数设置的地域获取数据,系统默认实例所属地域为cn-china;如果请求参数 InstanceIds 不为空时,即使设置了 Region 参数,也以 InstanceIds 所传入的第一个实例所在地域为准获取数据。

说明 在中国内地各地域创建的实例,传入此参数时,都为cn-china
cn-china
Userstring

需要查询的数据库账号。

testUser

返回参数

名称类型描述示例值
object
Codestring

返回的状态码。

200
Messagestring

请求返回消息。

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

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

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

请求是否执行成功:

  • true:执行成功。

  • false:执行失败。

true
Datastring

分享链接

https://hdm.console.aliyun.com/#/queryOptimize****

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": "https://hdm.console.aliyun.com/#/queryOptimize****"
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史