调用GetQueryOptimizeShareUrl接口,获取查询治理的分享链接。
接口说明
使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
- 本接口适用的数据库引擎为:
RDS MySQL
PolarDB MySQL 版
RDS PostgreSQL
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
hdm:GetQueryOptimizeShareUrl |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Engine |
string |
是 |
数据库引擎,取值:
|
MySQL |
| InstanceIds |
string |
否 |
实例 ID,多个实例 ID 间用逗号分隔。 |
rm-2ze1jdv45i7l6**** |
| TagNames |
string |
否 |
备用参数。 |
None |
| Keywords |
string |
否 |
SQL 文本关键词,多个关键词以空格分隔。 |
select update |
| LogicalOperator |
string |
否 |
多个 SQL 文本关键词的逻辑关系。
|
or |
| Rules |
string |
否 |
需要过滤的规则,多个规则以逗号分隔。具体信息请参见查询治理。 |
DAS_NOT_IMPORTANT |
| DbNames |
string |
否 |
需要查询的数据库名。 |
testdb01 |
| Time |
integer |
是 |
查询数据的日期,格式为 Unix 时间戳,单位为毫秒。 |
1642953600000 |
| PageSize |
integer |
否 |
分页查询每页最大记录数,默认为 10。 |
10 |
| PageNo |
integer |
否 |
分页查询的页码,从 1 开始,默认为 1。 |
1 |
| OrderBy |
string |
否 |
排序字段,默认为 count。
|
count |
| Asc |
boolean |
否 |
是否升序排序,默认为 true。
|
true |
| OnlyOptimizedSql |
boolean |
否 |
是否只查询待优化的 SQL,默认为 false。
|
true |
| SqlIds |
string |
否 |
SQL 模板 ID,您可调用 GetQueryOptimizeDataStats 接口查询 SQL 模板 ID。 |
6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0**** |
| Region |
string |
否 |
实例所属地域,取值:
此参数只有在请求参数 InstanceIds 为空时有效。如果请求参数 InstanceIds 为空时,按照 Region 参数设置的地域获取数据,系统默认实例所属地域为cn-china;如果请求参数 InstanceIds 不为空时,即使设置了 Region 参数,也以 InstanceIds 所传入的第一个实例所在地域为准获取数据。 说明
在中国内地各地域创建的实例,传入此参数时,都为cn-china。 |
cn-china |
| User |
string |
否 |
需要查询的数据库账号。 |
testUser |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
返回的状态码。 |
200 |
| Message |
string |
请求返回消息。 说明
请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。 |
Successful |
| RequestId |
string |
阿里云为该请求生成的唯一标识符。 |
B6D17591-B48B-4D31-9CD6-9B9796B2**** |
| Success |
string |
请求是否执行成功:
|
true |
| Data |
string |
分享链接 |
https://hdm.console.alibabacloud.com/#/queryOptimize**** |
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "Successful",
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true",
"Data": "https://hdm.console.alibabacloud.com/#/queryOptimize****"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
| 403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。