文档

DescribeAnomalySQLList - 查询可疑 SQL 列表

更新时间:

查询诊断系统判定认为可能存在性能问题的 SQL 列表。

接口说明

为优化用户体验,云数据库对 SQL 诊断功能进行了升级,本接口已下线并由新的接口替代,详情请参见 【通知】云数据库诊断管理 API 接口下线

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

obsd23j4f****
TenantIdstring

租户 ID。

t4louaeei****
StartTimestring

查询可疑 SQL 参数的起始时间。
该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2021-06-13T15:40:43Z
EndTimestring

查询可疑 SQL 参数的结束时间。
该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2021-09-13T15:40:43Z
DbNamestring

数据库名称。

testdb
SearchKeyWordstring

关键字查询。

update
SearchParameterstring

参数查询。

cputime
SearchRulestring

查询规则。
该参数取值包括:"=",">", “>=”, “<”,“<="

>
SearchValuestring

查询值。

0.01
SQLIdstring

SQLID。

8D6E84****0B8FB1823D199E2CA1****
NodeIpstring

节点 IP。

i-bp19y05****pacyqnlrc
PageSizeinteger

分页查询时设置的每页行数。

  • 最大值:100。
  • 默认值:10。
10
PageNumberinteger

分页查询的页码。

  • 起始值:1。
  • 默认值:1。
1
FilterConditionobject

过滤条件。

说明
- OceanBase 的所有字段均支持过滤。
- 将参数的键值以 JSON 的格式写在 JSON 字符串中,以对该参数进行过滤。
枚举值:
  • UserNameUserName
  • EventEvent
  • SQLTypeSQLType
  • ClientIpClientIp
{ "UserName":testUser }
SortColumnstring

排序列。

cputime
SortOrderstring

排序规则。

枚举值:
  • { "dbname":test, "SQLType":null }{ "dbname":test, "SQLType":null }
desc
AcceptLanguagestring

支持的语言。取值:

  • 中文:zh-CN
  • 英文:en-US
zh-CN

返回参数

名称类型描述示例值
object

请求的返回结果。

TotalCountlong

总数量。

2
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
AnomalySQLListobject []

可疑 SQL 列表。

Keylong

返回数据序号

1
DiagnosisRulestring

诊断规则

全表扫描有索引未用
SQLTextstring

SQL 文本。

SELECT **** FROM **** WHERE **** = ? AND **** = ? ORDER BY **** ASC
Suggestionstring

建议。

请确认业务场景、数据分布变化、请求量突涨、执行计划变化等情况
DbNamestring

数据库名。

database1
RequestTimeUTCStringstring

请求时间(零时区)。

2022-01-11T07:08:00Z
CpuTimefloat

平均 CPU 时间。单位:毫秒。

50.13
SQLIdstring

SQLID。

99E9D3BF****B486239E6C7BC79B****
Diagnosisstring

诊断信息。

全表扫描有索引未用
RequestTimefloat

请求时间。单位:毫秒。

50.00
Executionslong

执行次数。

89043
UserNamestring

用户名。

tester

示例

正常返回示例

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错误码错误信息描述
2014InternalErrorThe request processing has failed due to some unknown error.内部错误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-21OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:2014
2023-07-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:2014
入参OpenAPI 入参发生变更
    新增入参:InstanceId
  • 本页导读 (0)