查询诊断系统判定认为可能存在性能问题的 SQL 列表。
接口说明
为优化用户体验，云数据库对 SQL 诊断功能进行了升级，本接口已下线并由新的接口替代，详情请参见 【通知】云数据库诊断管理 API 接口下线。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | OceanBase 集群 ID。 | obsd23j4f**** |
| TenantId | string | 是 | 租户 ID。 | t4louaeei**** |
| StartTime | string | 是 | 查询可疑 SQL 参数的起始时间。 | 2021-06-13T15:40:43Z |
| EndTime | string | 是 | 查询可疑 SQL 参数的结束时间。 | 2021-09-13T15:40:43Z |
| DbName | string | 否 | 数据库名称。 | testdb |
| SearchKeyWord | string | 否 | 关键字查询。 | update |
| SearchParameter | string | 否 | 参数查询。 | cputime |
| SearchRule | string | 否 | 查询规则。 | > |
| SearchValue | string | 否 | 查询值。 | 0.01 |
| SQLId | string | 否 | SQLID。 | 8D6E84****0B8FB1823D199E2CA1**** |
| NodeIp | string | 否 | 节点 IP。 | i-bp19y05****pacyqnlrc |
| PageSize | integer | 否 | 分页查询时设置的每页行数。
| 10 |
| PageNumber | integer | 否 | 分页查询的页码。
| 1 |
| FilterCondition | object | 否 | 过滤条件。 说明
- OceanBase 的所有字段均支持过滤。 - 将参数的键值以 JSON 的格式写在 JSON 字符串中，以对该参数进行过滤。 枚举值：
| { "UserName":testUser } |
| SortColumn | string | 否 | 排序列。 | cputime |
| SortOrder | string | 否 | 排序规则。 枚举值：
| desc |
| AcceptLanguage | string | 否 | 支持的语言。取值：
| zh-CN |
返回参数
示例
正常返回示例
JSON格式
{
"TotalCount": 2,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"AnomalySQLList": [
{
"Key": 1,
"DiagnosisRule": "全表扫描有索引未用",
"SQLText": "SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC",
"Suggestion": "请确认业务场景、数据分布变化、请求量突涨、执行计划变化等情况",
"DbName": "database1",
"RequestTimeUTCString": "2022-01-11T07:08:00Z",
"CpuTime": 50.13,
"SQLId": "99E9D3BF****B486239E6C7BC79B****",
"Diagnosis": "全表扫描有索引未用",
"RequestTime": 50,
"Executions": 89043,
"UserName": "tester"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 2014 | InternalError | The request processing has failed due to some unknown error. | 内部错误 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-08-21 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-07-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||
|