GetQueryOptimizeShareUrl_数据库自治服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为60/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
hdm:GetQueryOptimizeShareUrl
Get
全部资源
*

请求参数

字段名称字段详情
Enginestring

数据库引擎,取值:展开详情

示例值:MySQL
InstanceIdsstring

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

示例值:rm-2ze1jdv45i7l6****参考取值来源:
    AddHDMInstance
    GetInstanceInspections
TagNamesstring

备用参数。

示例值:None
Keywordsstring

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

示例值:select update
LogicalOperatorstring

多个 SQL 文本关键词的逻辑关系。展开详情

示例值:or
Rulesstring

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

示例值:DAS_NOT_IMPORTANT
DbNamesstring

需要查询的数据库名。

示例值:testdb01
Timeinteger<int64>

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

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1642953600000
PageSizeinteger<int32>

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

示例值:10
PageNointeger<int32>

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

示例值:1
OrderBystring

排序字段,默认为 count展开详情

示例值:count
Ascboolean

是否升序排序,默认为 true展开详情

示例值:true
OnlyOptimizedSqlboolean

是否只查询待优化的 SQL,默认为 false展开详情

示例值:true
SqlIdsstring

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

示例值:6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****
Regionstring

实例所属地域,取值:展开详情

示例值:cn-china
Userstring

需要查询的数据库账号。

示例值:testUser

返回参数

字段名称字段详情
Codestring

返回的状态码。

示例值:200
Messagestring

请求返回消息。展开详情

示例值:Successful
RequestIdstring

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

示例值:B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring

请求是否执行成功:展开详情

示例值:true
Datastring

分享链接

示例值:https://hdm.console.aliyun.com/#/queryOptimize****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParams
The request parameters are invalid.诊断
403
NoPermission
You are not authorized to do this action.诊断

变更历史

暂无变更历史

相关示例