DescribeDiagnosisRecords - 云原生数据仓库AnalyticDB MySQL版

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDiagnosisRecords	系统规定参数。取值：DescribeDiagnosisRecords。
DBClusterId	String	是	am-bp1r053byu48p****	集群ID。说明您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。
StartTime	String	是	1632931200000	查询开始时间，格式为Unix时间戳，单位：毫秒。说明仅支持查看14天内的数据。
EndTime	String	是	1633017540000	查询结束时间，格式为Unix时间戳，单位：毫秒。说明查询结束时间需晚于查询开始时间。开始时间与结束时间的间隔不能超过24小时。
RegionId	String	是	cn-hangzhou	地域ID。说明您可以调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。
QueryCondition	String	是	{"Type":"status","Value":"finished"}	指定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详情，您也可以自定义执行耗时的最大值与最小值，单位：毫秒。
Keyword	String	否	select	查询关键字。
MinPeakMemory	Long	否	0	SQL语句的最小峰值内存，单位：Byte。
MaxPeakMemory	Long	否	89000000	SQL语句的最大峰值内存，单位：Byte。
MinScanSize	Long	否	0	SQL语句的最小扫描量，单位：Byte。
MaxScanSize	Long	否	104428198	SQL语句的最大扫描量，单位：Byte。
ResourceGroup	String	否	user_default	SQL语句所属的资源组。说明您可以调用DescribeDiagnosisDimensions接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。
UserName	String	否	test_user	执行SQL语句的用户名。说明您可以调用DescribeDiagnosisDimensions接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。
Database	String	否	adb_demo	执行SQL语句的数据库。说明您可以调用DescribeDiagnosisDimensions接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。
ClientIp	String	否	59.82.xx.xx	访问源地址。说明您可以调用DescribeDiagnosisDimensions接口查看符合指定检索条件的SQL语句所属的资源组、数据库名、用户名以及访问源地址信息。
Order	String	否	[{"Field":"StartTime", "Type": "desc" }]	根据指定字段对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`：升序。
PageNumber	Integer	否	1	页码，取值为大于0且不超过Integer数据类型的最大值。默认值为1。
PageSize	Integer	否	30	每页记录数，取值为30（默认值）、50或100。
Lang	String	否	zh	设置下载文件的文件标题以及部分错误信息的语言，支持如下语言： zh：简体中文（默认语言）。 en：英文。 ja：日文。 zh-tw：繁体中文。
PatternId	Long	否	5575924945138******	SQL Pattern的ID。

返回数据


名称	类型	示例值	描述
PageNumber	Integer	1	页数。
PageSize	Integer	30	本页记录数。
TotalCount	Integer	1	总记录数。
Querys	Array of Items		SQL语句详情列表。
SQL	String	SELECT count(*)\nFROM nation	SQL语句详情。说明出于性能考虑，当前SQL语句最长支持显示5120个字符，超出限制的SQL语句会被截断。您可以调用DownloadDiagnosisRecords接口下载符合指定条件的SQL语句的摘要信息，包括完整的SQL语句。
SQLTruncatedThreshold	Long	5120	SQL语句的截断阈值，固定为5120个字符。超过该长度的SQL语句会被截断。
Status	String	finished	SQL语句的状态，取值为： running：执行中。 finished：已完成。 failed：执行失败。
OutputDataSize	Long	9	返回数据量，单位：Byte。
Cost	Long	10	查询的总耗时。单位：毫秒。说明该耗时指标是`QueuedTime`、`TotalPlanningTime`和`ExecutionTime`三个耗时指标的累加值。
OutputRows	Long	1	返回行数。
RcHost	String	10.0.xx.xx:3004	执行SQL语句的AnalyticDB MySQL前端节点IP和端口信息。
ScanSize	Long	9	扫描数据量，单位：Byte。
ProcessId	String	2021093000414401000000023503151******	查询ID。
StartTime	Long	1632933704000	SQL语句的执行开始时间，格式为Unix时间戳，单位：毫秒。
SQLTruncated	Boolean	false	查询结果的长度是否超过阈值（即是否被截断），取值如下： true：查询结果的长度超过阈值。 false：查询结果的长度未超过阈值。
Database	String	adb_demo	执行SQL语句的数据库名称。
ScanRows	Long	1	扫描行数。
ResourceCostRank	Integer	1	SQL语句内部算子的耗时排名。说明仅状态为执行中，即`Status`取值为`running`的SQL语句支持返回该字段。
ClientIp	String	59.82.xx.xx	访问源地址。
PeakMemory	Long	16648	峰值内存，单位：Byte。
QueueTime	Long	0	排队耗时，单位：毫秒。
ResourceGroup	String	user_default	SQL语句所属的资源池。
UserName	String	test_user	执行SQL语句的用户名。
ExecutionTime	Long	6	查询执行的耗时，单位：毫秒。
TotalPlanningTime	Long	4	生成执行计划的耗时，单位：毫秒。
EtlWriteRows	Long	0	ETL任务写表的行数。
TotalStages	Integer	2	查询生成的总Stage数量。
RequestId	String	109462AF-B5FA-3D5A-9377-B27E5B******	请求ID。

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeDiagnosisRecords
&DBClusterId=am-bp1r053byu48p****
&StartTime=1632931200000
&EndTime=1633017540000
&RegionId=cn-hangzhou
&QueryCondition={"Type":"status","Value":"finished"}
&Keyword=select
&MinPeakMemory=0
&MaxPeakMemory=89000000
&MinScanSize=0
&MaxScanSize=104428198
&ResourceGroup=user_default
&UserName=test_user
&Database=adb_demo
&ClientIp=59.82.xx.xx
&Order=[{"Field":"StartTime", "Type": "desc" }]
&PageNumber=1
&PageSize=30
&Lang=zh
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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******"
}

错误码

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