调用GetQueryOptimizeDataStats接口,获取查询治理模板数据。
接口说明
- 在使用阿里云 SDK 时,需要保证 aliyun-sdk-core 的版本大于 2.1.8,建议使用最新版本。
- 使用 DAS 的 SDK 的版本为 2.1.8 或以上。
- 在使用 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:GetQueryOptimizeDataStats | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Engine | string | 是 | 数据库引擎,取值:
| MySQL |
InstanceIds | string | 否 | 实例 ID,多个实例 ID 用逗号分隔。 | rm-2ze8g2am97624**** |
TagNames | string | 否 | 备用参数。 | None |
Keywords | string | 否 | SQL 文本关键词,多个关键词以空格分隔。 | select update |
LogicalOperator | string | 否 | 多个 SQL 文本关键词的逻辑关系。
| or |
Rules | string | 否 | 需要过滤的规则,多个规则以逗号分隔。具体信息请参见查询治理。 | DAS_NOT_IMPORTANT |
DbNames | string | 否 | 需要查询的数据库名。 | testdb01 |
Time | string | 是 | 查询数据的日期,格式为 Unix 时间戳,单位为毫秒。 | 1642953600000 |
PageSize | string | 否 | 分页查询每页最大记录数,默认为 10。 | 10 |
PageNo | string | 否 | 分页查询的页码,从 1 开始,默认为 1。 | 1 |
OrderBy | string | 否 | 排序字段,默认为 count。
| count |
Asc | string | 否 | 是否升序排序,默认为 true。
| true |
OnlyOptimizedSql | string | 否 | 是否只查询待优化的 SQL,默认为 false。
| false |
SqlIds | string | 否 | SQL 模板 ID,您可调用 GetQueryOptimizeExecErrorStats 接口查询 SQL 模板 ID。 | 2e8147b5ca2dfc640dfd5e43d96a**** |
Region | string | 否 | 实例所属地域,取值:
此参数只有在请求参数 InstanceIds 为空时有效。如果请求参数 InstanceIds 为空时,按照 Region 参数设置的地域获取数据,系统默认实例所属地域为cn-china;如果请求参数 InstanceIds 不为空时,即使设置了 Region 参数,也以 InstanceIds 所传入的第一个实例所在地域为准获取数据。 说明
在中国内地各地域创建的实例,传入此参数时,都为cn-china。
| cn-china |
User | string | 否 | 需要查询的数据库账号。 | testUser |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Message": "Successful",
"Data": {
"Total": 10,
"PageNo": 0,
"PageSize": 0,
"Extra": "None",
"List": [
{
"InstanceId": "rm-2ze8g2am97624****",
"Dbname": "testdb01",
"SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
"SqlType": "INSERT",
"Psql": "select 1",
"SqlSample": "select 2",
"Count": 100,
"MaxQueryTime": 1.1,
"AvgQueryTime": 1.1,
"MaxLockTime": 0.1,
"AvgLockTime": 0.1,
"MaxRowsExamined": 100000,
"AvgRowsExamined": 100.1,
"MaxRowsSent": 10000,
"AvgRowsSent": 100.1,
"MaxRowsAffected": 10000,
"AvgRowsAffected": 100.1,
"RuleList": [
{
"Name": "DAS_NOT_IMPORTANT",
"Type": "Predefined"
}
],
"User": "testUser"
}
]
},
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-04-04 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-03-29 | OpenAPI 入参发生变更 | 查看变更详情 |