调用GetInstanceSqlOptimizeStatistic接口,获取指定时间段内自动SQL优化任务的统计数据,包括任务总数和最大收益等。
接口说明
使用该接口需满足以下前提条件:
使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
数据库引擎为 RDS MySQL 或 PolarDB MySQL 版。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
hdm:GetInstanceSqlOptimizeStatistic |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
数据库实例 ID。 说明
仅支持 RDS MySQL、PolarDB MySQL 版数据库实例。 |
pc-wz90h9560rvdz**** |
| StartTime |
string |
是 |
查询开始时间,格式为 Unix 时间戳(UTC 时间),单位为毫秒。 |
1661308902060 |
| EndTime |
string |
是 |
查询结束时间,格式为 Unix 时间戳(UTC 时间),单位为毫秒。 |
1662518540764 |
| NodeId |
string |
否 |
节点 ID。 说明
对于 RDS MySQL 集群系列数据库实例或 PolarDB MySQL 版数据库实例,需要提供节点 ID。 |
pi-bp12v7243x012**** |
| Threshold |
string |
否 |
自动 SQL 优化事件的持续时间阈值。 设置此参数后,只会统计持续时间不超过阈值的自动 SQL 优化事件。 说明
此参数为备用参数,当前暂不生效。 |
None |
| FilterEnable |
string |
否 |
是否过滤开启了 DAS 企业版的数据库实例:
说明
取值为 true 时,只统计未开启 DAS 企业版的数据库实例;取值为 false 时,统计所有数据库实例。 |
false |
| UseMerging |
string |
否 |
是否合并事件:
说明
此参数为备用参数,当前暂不生效。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回信息列表。 |
||
| Code |
string |
返回的状态码。 |
200 |
| Message |
string |
请求返回消息。 说明
请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。 |
Successful |
| Data |
object |
详细信息列表。 |
|
| count |
integer |
自动 SQL 优化事件总数。 |
16 |
| improvement |
number |
返回的自动 SQL 优化事件中,SQL 优化后的最大收益倍数。 |
1003 |
| RequestId |
string |
请求 ID。 |
B6D17591-B48B-4D31-9CD6-9B9796B2**** |
| Success |
string |
请求是否执行成功:
|
true |
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "Successful",
"Data": {
"count": 16,
"improvement": 1003
},
"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. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。