文档

DescribeDiagnosisRecords - 查询诊断记录

更新时间:

查看目标AnalyticDB MySQL版集群中符合指定检索条件的SQL语句摘要信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeDiagnosisRecordsRead
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

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

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 集群的详情,包括集群 ID。
am-bp1r053byu48p****
StartTimestring

查询开始时间,格式为 Unix 时间戳,单位:毫秒。

说明 仅支持查看 14 天内的数据。
1632931200000
EndTimestring

查询结束时间,格式为 Unix 时间戳,单位:毫秒。

说明
  • 查询结束时间需晚于查询开始时间。
  • 开始时间与结束时间的间隔不能超过 24 小时。
  • 1633017540000
    RegionIdstring

    地域 ID。

    说明 您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息,包括地域 ID。
    cn-hangzhou
    QueryConditionstring

    指定 SQL 的查询条件,格式为 JSON 字符串,包含TypeValueMinMax等字段。其中Type 表示查询维度(当前仅支持 3 个取值:maxCoststatuscost),ValueMinMax表示该维度下的查询范围。具体支持的取值范围如下:

    • {"Type":"maxCost","Value":"100"}:表示查看执行耗时最长的前 100 条 SQL 详情,当前Value的取值仅支持设置为 100。
    • {"Type":"status","Value":"finished"}:表示查看已完成的 SQL 详情。您也可以将Value设置为runningfailed来查询正在执行或执行失败的 SQL 详情。
    • {"Type":"cost","Min":"10","Max":"200"}:表示查看执行耗时为 10 毫秒~200 毫秒的 SQL 详情,您也可以自定义执行耗时的最大值与最小值,单位:毫秒。
    {"Type":"status","Value":"finished"}
    Keywordstring

    查询关键字。

    select
    MinPeakMemorylong

    SQL 语句的最小峰值内存,单位:Byte。

    0
    MaxPeakMemorylong

    SQL 语句的最大峰值内存,单位:Byte。

    89000000
    MinScanSizelong

    SQL 语句的最小扫描量,单位:Byte。

    0
    MaxScanSizelong

    SQL 语句的最大扫描量,单位:Byte。

    104428198
    ResourceGroupstring

    SQL 语句所属的资源组。

    说明 您可以调用 DescribeDiagnosisDimensions 接口查看符合指定检索条件的 SQL 语句所属的资源组、数据库名、用户名以及访问源地址信息。
    user_default
    UserNamestring

    执行 SQL 语句的用户名。

    说明 您可以调用 DescribeDiagnosisDimensions 接口查看符合指定检索条件的 SQL 语句所属的资源组、数据库名、用户名以及访问源地址信息。
    test_user
    Databasestring

    执行 SQL 语句的数据库。

    说明 您可以调用 DescribeDiagnosisDimensions 接口查看符合指定检索条件的 SQL 语句所属的资源组、数据库名、用户名以及访问源地址信息。
    adb_demo
    ClientIpstring

    访问源地址。

    说明 您可以调用 DescribeDiagnosisDimensions 接口查看符合指定检索条件的 SQL 语句所属的资源组、数据库名、用户名以及访问源地址信息。
    59.82.xx.xx
    Orderstring

    根据指定字段对 SQL 语句进行排序,格式为 JSON,是一个有序 JSON 数组,按输入数组的顺序进行复合排序,包含FieldType两个字段,例如[{"Field":"StartTime", "Type": "desc" }]。其中:

    • Field表示需要排序的字段名,支持如下字段:

      • StartTime:执行开始时间。
      • Status:执行状态。
      • UserName:用户名称。
      • Cost:执行耗时。
      • PeakMemory:峰值内存。
      • ScanSize:扫描数据量。
      • Database:数据库名称。
      • ClientIp:访问源地址.
      • ResourceGroup:资源组。
      • QueueTime:排队耗时。
      • OutputRows:输出行数。
      • OutputDataSize:输出数据量。
      • ResourceCostRank:SQL 内部算子的耗时排名(仅当QueryCondition取值为{"Type":"status","Value":"running"}时,支持使用该字段)。
    • Type表示排序类型,支持如下取值(取值均不区分大小写):

      • Desc:降序。
      • Asc:升序。
    [{"Field":"StartTime", "Type": "desc" }]
    PageNumberinteger

    页码,取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1

    1
    PageSizeinteger

    每页记录数,取值为 30(默认值)、50100

    30
    Langstring

    设置下载文件的文件标题以及部分错误信息的语言,支持如下语言:

    • zh:简体中文(默认语言)。
    • en:英文。
    • ja:日文。
    • zh-tw:繁体中文。
    zh
    PatternIdstring

    SQL Pattern 的 ID。

    说明 您可以调用 DescribeSQLPatterns 接口查看指定时间内目标 AnalyticDB MySQL 集群下所有的 SQL Pattern 列表信息,包括 SQL Pattern 的 ID。
    5575924945138******

    返回参数

    名称类型描述示例值
    object

    详情。

    PageNumberinteger

    页数。

    1
    PageSizeinteger

    本页记录数。

    30
    TotalCountinteger

    总记录数。

    1
    Querysobject []

    SQL 语句详情列表。

    SQLstring

    SQL 语句详情。

    说明 出于性能考虑,当前 SQL 语句最长支持显示 5120 个字符,超出限制的 SQL 语句会被截断。您可以调用 DownloadDiagnosisRecords 接口下载符合指定条件的 SQL 语句的摘要信息,包括完整的 SQL 语句。
    SELECT count(*)\nFROM nation
    SQLTruncatedThresholdlong

    SQL 语句的截断阈值,固定为 5120 个字符。超过该长度的 SQL 语句会被截断。

    5120
    Statusstring

    SQL 语句的状态,取值为:

    • running:执行中。
    • finished:已完成。
    • failed:执行失败。
    finished
    OutputDataSizelong

    返回数据量,单位:Byte。

    9
    Costlong

    查询的总耗时。单位:毫秒。

    说明 该耗时指标是QueuedTimeTotalPlanningTimeExecutionTime三个耗时指标的累加值。
    10
    OutputRowslong

    返回行数。

    1
    RcHoststring

    执行 SQL 语句的 AnalyticDB MySQL 前端节点 IP 和端口信息。

    10.0.xx.xx:3004
    ScanSizelong

    扫描数据量,单位:Byte。

    9
    ProcessIdstring

    查询 ID。

    2021093000414401000000023503151******
    StartTimelong

    SQL 语句的执行开始时间,格式为 Unix 时间戳,单位:毫秒。

    1632933704000
    SQLTruncatedboolean

    查询结果的长度是否超过阈值(即是否被截断),取值如下:

    • true:查询结果的长度超过阈值。
    • false:查询结果的长度未超过阈值。
    false
    Databasestring

    执行 SQL 语句的数据库名称。

    adb_demo
    ScanRowslong

    扫描行数。

    1
    ResourceCostRankinteger

    SQL 语句内部算子的耗时排名。

    说明 仅状态为执行中,即Status取值为running的 SQL 语句支持返回该字段。
    1
    ClientIpstring

    访问源地址。

    59.82.xx.xx
    PeakMemorylong

    峰值内存,单位:Byte。

    16648
    QueueTimelong

    排队耗时,单位:毫秒。

    0
    ResourceGroupstring

    SQL 语句所属的资源池。

    user_default
    UserNamestring

    执行 SQL 语句的用户名。

    test_user
    ExecutionTimelong

    查询执行的耗时,单位:毫秒。

    6
    TotalPlanningTimelong

    生成执行计划的耗时,单位:毫秒。

    4
    EtlWriteRowslong

    ETL 任务写表的行数。

    0
    TotalStagesinteger

    查询生成的总 Stage 数量。

    2
    RequestIdstring

    请求 ID。

    109462AF-B5FA-3D5A-9377-B27E5B******

    示例

    正常返回示例

    JSON格式

    {
      "PageNumber": 1,
      "PageSize": 30,
      "TotalCount": 1,
      "Querys": [
        {
          "SQL": "SELECT count(*)\\nFROM nation",
          "SQLTruncatedThreshold": 5120,
          "Status": "finished",
          "OutputDataSize": 9,
          "Cost": 10,
          "OutputRows": 1,
          "RcHost": "10.0.xx.xx:3004",
          "ScanSize": 9,
          "ProcessId": "2021093000414401000000023503151******",
          "StartTime": 1632933704000,
          "SQLTruncated": false,
          "Database": "adb_demo",
          "ScanRows": 1,
          "ResourceCostRank": 1,
          "ClientIp": "59.82.xx.xx",
          "PeakMemory": 16648,
          "QueueTime": 0,
          "ResourceGroup": "user_default",
          "UserName": "test_user",
          "ExecutionTime": 6,
          "TotalPlanningTime": 4,
          "EtlWriteRows": 0,
          "TotalStages": 2
        }
      ],
      "RequestId": "109462AF-B5FA-3D5A-9377-B27E5B******"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-01-05API 内部配置变更,不影响调用看变更集
    变更项变更内容
    API 内部配置变更,不影响调用
    2021-10-12OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    出参OpenAPI 返回结构发生变更
    2021-10-12OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:PatternId
    • 本页导读 (1)
    文档反馈