DescribeSQLPatterns - 开发指南| 阿里云

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeSQLPatterns	系统规定参数。取值：DescribeSQLPatterns。
DBClusterId	String	是	am-****************	集群ID。说明您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL集群的详情，包括集群ID。
StartTime	String	是	2021-11-12T00:15:00Z	查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。说明仅支持查看最近14天的数据。例如：当前时间为2021-11-22T12:00:00Z，最早可以查询到2021-11-09T12:00:00Z的数据。查询开始时间和查询结束时间的间隔不能大于24小时。
EndTime	String	是	2021-11-13T00:15:00Z	查询结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。说明查询结束时间需晚于查询开始时间。
RegionId	String	是	cn-hangzhou	地域ID。说明您可以调用DescribeRegions接口查看AnalyticDB MySQL版支持的地域和可用区信息，包括地域ID。
Keyword	String	否	SELECT	查询关键字。
Order	String	是	[{"Field":"AverageQueryTime","Type":"Asc"}]	将查询结果按指定字段进行排序。格式为JOSN字符串，例如`[{"Field":"AverageQueryTime","Type":"Asc"}]`。其中： `Field`表示排序字段。取值说明： `PatternCreationTime`：查询时间范围内，Pattern的最早提交时间。 `AverageQueryTime`：查询时间范围内，Pattern的平均总耗时。 `MaxQueryTime`：查询时间范围内，Pattern的最大总耗时。 `AverageExecutionTime`: 查询时间范围内，Pattern的平均执行耗时。 `MaxExecutionTime`: 查询时间范围内，Pattern的最大执行耗时。 `AveragePeakMemory`: 查询时间范围内，Pattern的平均峰值内存。 `MaxPeakMemory`: 查询时间范围内，Pattern的最大峰值内存。 `AverageScanSize`: 查询时间范围内，Pattern的平均数据读取量。 `MaxScanSize`: 查询时间范围内，Pattern的最大数据读取量。 `QueryCount`: 查询时间范围内，Pattern的执行次数。 `FailedCount`: 查询时间范围内，Pattern的失败次数。 `Type`表示排序方式。取值说明（取值不区分大小写）： `Asc`：升序排序。 `Desc`：降序排序。
PageNumber	Integer	否	1	页码，取值为大于0且不超过Integer数据类型的最大值。说明本参数不填写，默认为1。
PageSize	Integer	否	30	每页记录数，取值说明： 30 50 100 说明本参数不填写，默认为30。
Lang	String	否	zh	设置下载文件的文件标题以及部分错误信息的语言，取值说明： zh：简体中文（默认语言）。 en：英文。 ja：日文。 zh-tw：繁体中文。

返回数据


名称	类型	示例值	描述
PageNumber	Integer	1	页数。
PageSize	Integer	30	本页记录数。
TotalCount	Integer	1	总记录数。
PatternDetails	Array of patternDetails		SQL Pattern的详细信息。
SQLPattern	String	SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)	SQL Pattern的具体语句。
PatternId	String	5575924945138******	SQL Pattern的ID。
User	String	reporter	提交Pattern相关的SQL数据库用户名。
AccessIp	String	192.168.xx.xx	提交Pattern相关的SQL客户端IP地址。
Tables	String	tpch.orders	SQL Pattern扫描的列表。
PatternCreationTime	String	2021-11-12 03:06:00	查询时间范围内，Pattern的最早提交时间。单位：毫秒。
AverageQueryTime	double	23.6666	查询时间范围内，Pattern的平均总耗时。单位：毫秒。
MaxQueryTime	Long	2341	查询时间范围内，Pattern的最大总耗时。单位：毫秒。
AverageExecutionTime	double	234.78	查询时间范围内，Pattern的平均执行时间。单位：毫秒。
MaxExecutionTime	Long	2142	查询时间范围内，Pattern的最大执行时间。单位：毫秒。
AveragePeakMemory	double	234.22	查询时间范围内，Pattern的平均峰值内存。单位：Byte。
MaxPeakMemory	Long	234149	Pattern相关SQL的最大峰值内存。单位：Byte。
AverageScanSize	double	234149.23	查询时间范围内，Pattern的平均数据读取量。单位：Byte。
MaxScanSize	Long	234149	Pattern相关SQL的最大数据读取量。单位：Byte。
QueryCount	Long	345	查询时间范围内，Pattern的执行次数。
FailedCount	Long	234	查询时间范围内，Pattern的失败次数。
Blockable	Boolean	true	能否拦截当前SQL Pattern的运行。取值说明： true：支持拦截。 false：不支持拦截。说明目前AnalyticDB MySQL版仅支持Select和Insert相关语句的拦截。
RequestId	String	6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******	请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSQLPatterns
&DBClusterId=am-****************
&StartTime=2021-11-12T00:15:00Z
&EndTime=2021-11-13T00:15:00Z
&RegionId=cn-hangzhou
&Keyword=SELECT
&Order=[{"Field":"AverageQueryTime","Type":"Asc"}]
&PageNumber=1
&PageSize=30
&Lang=zh
&公共请求参数

正常返回示例

XML格式

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

<DescribeSQLPatternsResponse>
    <PageNumber>1</PageNumber>
    <PageSize>30</PageSize>
    <TotalCount>1</TotalCount>
    <PatternDetails>
        <SQLPattern>SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)</SQLPattern>
        <PatternId>5575924945138******</PatternId>
        <User>reporter</User>
        <AccessIp>192.168.xx.xx</AccessIp>
        <Tables>tpch.orders</Tables>
        <PatternCreationTime>2021-11-12 03:06:00</PatternCreationTime>
        <AverageQueryTime>23.6666</AverageQueryTime>
        <MaxQueryTime>2341</MaxQueryTime>
        <AverageExecutionTime>234.78</AverageExecutionTime>
        <MaxExecutionTime>2142</MaxExecutionTime>
        <AveragePeakMemory>234.22</AveragePeakMemory>
        <MaxPeakMemory>234149</MaxPeakMemory>
        <AverageScanSize>234149.23</AverageScanSize>
        <MaxScanSize>234149</MaxScanSize>
        <QueryCount>345</QueryCount>
        <FailedCount>234</FailedCount>
        <Blockable>true</Blockable>
    </PatternDetails>
    <RequestId>6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******</RequestId>
</DescribeSQLPatternsResponse>

JSON格式

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

{
  "PageNumber" : 1,
  "PageSize" : 30,
  "TotalCount" : 1,
  "PatternDetails" : {
    "SQLPattern" : "SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)",
    "PatternId" : "5575924945138******",
    "User" : "reporter",
    "AccessIp" : "192.168.xx.xx",
    "Tables" : "tpch.orders",
    "PatternCreationTime" : "2021-11-12 03:06:00",
    "AverageQueryTime" : 23.6666,
    "MaxQueryTime" : 2341,
    "AverageExecutionTime" : 234.78,
    "MaxExecutionTime" : 2142,
    "AveragePeakMemory" : 234.22,
    "MaxPeakMemory" : 234149,
    "AverageScanSize" : 234149.23,
    "MaxScanSize" : 234149,
    "QueryCount" : 345,
    "FailedCount" : 234,
    "Blockable" : true
  },
  "RequestId" : "6BE0EDD1-0DE6-3EB6-81BF-BFE4F2******"
}

错误码

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