调用DescribeSqlPattern接口查看指定日期内AnalyticDB MySQL版集群下的SQL Pattern详情。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSqlPattern

系统规定参数。取值:DescribeSqlPattern

StartTime String 2021-08-30

需要查询的日期,格式为yyyy-MM-dd(UTC时间)。

说明 仅支持查看30天内的数据。
Order String [{"Field":"Pattern","Type":"Asc"}]

将查询结果按指定字段进行排序。格式为JOSN字符串,例如[{"Field":"Pattern","Type":"Asc"}]。其中:

  • Field表示排序字段。支持如下取值:
    • Pattern:SQL Pattern。
    • AccessIP:客户端IP。
    • User:用户名。
    • QueryCount:查询总数。
    • AvgPeakMemory:平均峰值内存,单位:KB。
    • MaxPeakMemory:最大峰值内存,单位:KB。
    • AvgCpuTime:平均计算耗时,单位:ms。
    • MaxCpuTime:最大计算耗时,单位:ms。
    • AvgStageCount:平均Stage个数。
    • MaxStageCount:最大Stage个数。
    • AvgTaskCount:平均Task个数。
    • MaxTaskCount:最大Task个数。
    • AvgScanSize:平均扫描量,单位:KB。
    • MaxScanSize:最大扫描量,单位:KB。
  • Type表示排序方式。支持如下取值:
    • Asc:升序排序。
    • Desc: 降序排序。
说明
  • 若不设置参数,默认按照Pattern字段升序排列。
  • 若需要按照AccessIP字段排序,则Type参数必须设置为accessip;若需要按照User字段排序,则Type参数必须留空或设置为user
PageNumber Integer 1

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

SqlPattern String SELECT

需要包含的SQL Pattern的关键字。

说明 若该参数不填,默认返回目标集群在StartTime参数所设日期内的所有SQL Pattern详情。
Type String user

按指定维度来聚合SQL Pattern。支持如下取值:

  • user:按用户维度聚合。
  • accessip:按访问IP来源聚合。
说明 若该参数不填,默认按照 user维度聚合。
DBClusterId String am-****************

集群ID。

说明 您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL集群的详情,包括集群ID。
PageSize Integer 30

每页记录数,取值为任意正整数。默认为30

RegionId String cn-hangzhou

地域ID。

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

返回数据

名称 类型 示例值 描述
PageSize Integer 30

本页记录数。

PageNumber Integer 1

页数。

TotalCount Integer 1

总记录数。

Items Array of Items

SQL Pattern详情。

AvgStageCount String 2

平均Stage个数。

MaxCpuTime String 17

最大计算耗时,单位:ms。

AccessIP String 100.104.***.***

客户端IP。

说明 仅当Type参数设置为accessip时,支持返回该参数。
AvgScanSize String 0

平均扫描量,单位:KB。

MaxScanSize String 0

最大扫描量,单位:KB。

MaxPeakMemory String 480096

最大峰值内存,单位:KB。

AvgCpuTime String 1.0625

平均计算耗时,单位:ms。

User String test_acc

用户名。

说明 仅当Type参数留空或设置为user时,支持返回该参数。
AvgPeakMemory String 240048

平均峰值内存,单位:KB。

MaxStageCount String 2

最大Stage个数。

MaxTaskCount String 2

最大Task个数。

InstanceName String am-****************

集群ID。

QueryCount String 16

查询总数。

ReportDate String 2021-08-30

查询日期。

Pattern String SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1

SQL Pattern。

AvgTaskCount String 2

平均Task个数。

RequestId String B6F2D1B4-2C9F-5622-B424-5E7965******

请求ID。

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeSqlPattern
&StartTime=2021-08-30
&DBClusterId=am-****************
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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

<DescribeSqlPatternResponse>
    <TotalCount>1</TotalCount>
    <PageSize>30</PageSize>
    <RequestId>B6F2D1B4-2C9F-5622-B424-5E7965******</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <AvgPeakMemory>240048</AvgPeakMemory>
        <AccessIP/>
        <AvgCpuTime>1.0625</AvgCpuTime>
        <Pattern>SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1</Pattern>
        <User>test_acc</User>
        <MaxStageCount>2</MaxStageCount>
        <AvgTaskCount>2</AvgTaskCount>
        <AvgScanSize>0</AvgScanSize>
        <ReportDate>2021-08-30</ReportDate>
        <AvgStageCount>2</AvgStageCount>
        <InstanceName>am-****************</InstanceName>
        <MaxScanSize>0</MaxScanSize>
        <MaxPeakMemory>480096</MaxPeakMemory>
        <MaxTaskCount>2</MaxTaskCount>
        <QueryCount>16</QueryCount>
        <MaxCpuTime>17</MaxCpuTime>
    </Items>
</DescribeSqlPatternResponse>

JSON格式

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

{
  "TotalCount" : 1,
  "PageSize" : 30,
  "RequestId" : "B6F2D1B4-2C9F-5622-B424-5E7965******",
  "PageNumber" : 1,
  "Items" : [ {
    "AvgPeakMemory" : "240048",
    "AccessIP" : "",
    "AvgCpuTime" : "1.0625",
    "Pattern" : "SELECT table_name, table_schema AS schema_name, create_time, create_time AS last_ddl_time, table_comment AS description , ceil((data_length + index_length) / ? / ?) AS store_capacity , data_length AS data_bytes, index_length AS index_bytes, table_collation AS collation, auto_increment, table_rows AS num_rows , engine FROM information_schema.tables WHERE table_type != ? AND table_schema = ? AND table_name IN (?) ORDER BY 1",
    "User" : "test_acc",
    "MaxStageCount" : "2",
    "AvgTaskCount" : "2",
    "AvgScanSize" : "0",
    "ReportDate" : "2021-08-30",
    "AvgStageCount" : "2",
    "InstanceName" : "am-****************",
    "MaxScanSize" : "0",
    "MaxPeakMemory" : "480096",
    "MaxTaskCount" : "2",
    "QueryCount" : "16",
    "MaxCpuTime" : "17"
  } ]
}

错误码

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