首页 云原生数据仓库AnalyticDB MySQL版 开发参考 API参考（数仓版） API目录 SQL诊断 DescribeDiagnosisRecords - 查询诊断记录

DescribeDiagnosisRecords - 查询诊断记录

更新时间: 2023-04-13 15:04:51

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeDiagnosisRecordsRead
  • ADB
    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字符串，包含Type、Value、Min或Max等字段。其中Type 表示查询维度（当前仅支持3个取值：maxCost、status和cost），Value、Min或Max表示该维度下的查询范围。具体支持的取值范围如下：

    • {"Type":"maxCost","Value":"100"}：表示查看执行耗时最长的前100条SQL详情，当前Value的取值仅支持设置为100。
    • {"Type":"status","Value":"finished"}：表示查看已完成的SQL详情。您也可以将Value设置为running或failed来查询正在执行或执行失败的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数组，按输入数组的顺序进行复合排序，包含Field和Type两个字段，例如[{"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（默认值）、50或100。

    		30
    Langstring否

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

    • zh：简体中文（默认语言）。
    • en：英文。
    • ja：日文。
    • zh-tw：繁体中文。
    		zh
    PatternIdstring否

    SQL Pattern的ID。 <otherprops="limitout">您可以调用DescribeSQLPatterns接口查看指定时间内目标AnalyticDB MySQL集群下所有的SQL Pattern列表信息，包括SQL Pattern的ID。

    		5575924945138******

    返回参数

    名称类型描述示例值
    object

    详情。

    PageNumberinteger

    页数。

    		1
    PageSizeinteger

    本页记录数。

    		30
    TotalCountinteger

    总记录数。

    		1
    Querysarray

    SQL语句详情列表。

    object

    详情。

    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

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

    说明该耗时指标是QueuedTime、TotalPlanningTime和ExecutionTime三个耗时指标的累加值。
    		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******"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2021-10-12OpenAPI 返回结构发生变更
    变更项变更内容
    出参OpenAPI 返回结构发生变更
    2021-10-12OpenAPI 入参发生变更
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参：PatternId
    阿里云首页 云原生数据仓库AnalyticDB MySQL版 相关技术圈