全部产品
Search

搜索本产品

    云原生数据仓库AnalyticDB：DescribeSqlPattern - 查询SQL模式

    文档中心

    云原生数据仓库AnalyticDB：DescribeSqlPattern - 查询SQL模式

    更新时间：Nov 08, 2024

    查看指定日期内AnalyticDB MySQL版集群下的SQL模板详情。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    StartTimestring是

    需要查询的日期，格式为yyyy-MM-dd（UTC 时间）。

    说明 仅支持查看 30 天内的数据。
    		2021-08-30
    Orderstring否

    将查询结果按指定字段进行排序。格式为 JSON 字符串，例如[{"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。
    •
    		[{"Field":"Pattern","Type":"Asc"}]
    PageNumberinteger否

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

    		1
    SqlPatternstring否

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

    说明 若该参数不填，默认返回目标集群在StartTime参数所设日期内的所有 SQL Pattern 详情。
    		SELECT
    Typestring否

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

    • user：按用户维度聚合。
    • accessip：按访问 IP 来源聚合。
    说明 若该参数不填，默认按照 user维度聚合。
    		user
    DBClusterIdstring是

    集群 ID。

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

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

    		30
    RegionIdstring是

    地域 ID。

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

    返回参数

    名称类型描述示例值
    object

    详情。

    PageSizeinteger

    本页记录数。

    		30
    PageNumberinteger

    页数。

    		1
    TotalCountinteger

    总记录数。

    		1
    Itemsarray<object>

    SQL Pattern 详情。

    Itemsobject

    详情。

    AvgStageCountstring

    平均 Stage 个数。

    		2
    MaxCpuTimestring

    最大计算耗时，单位：ms。

    		17
    AccessIPstring

    客户端 IP。

    说明 仅当Type参数设置为accessip时，支持返回该参数。
    		100.104.***.***
    AvgScanSizestring

    平均扫描量，单位：KB。

    		0
    MaxScanSizestring

    最大扫描量，单位：KB。

    		0
    MaxPeakMemorystring

    最大峰值内存，单位：KB。

    		480096
    AvgCpuTimestring

    平均计算耗时，单位：ms。

    		1.0625
    Userstring

    用户名。

    说明 仅当Type参数留空或设置为user时，支持返回该参数。
    		test_acc
    AvgPeakMemorystring

    平均峰值内存，单位：KB。

    		240048
    MaxStageCountstring

    最大 Stage 个数。

    		2
    MaxTaskCountstring

    最大 Task 个数。

    		2
    InstanceNamestring

    集群 ID。

    		am-bp1r053byu48p****
    QueryCountstring

    查询总数。

    		16
    ReportDatestring

    查询日期。

    		2021-08-30
    Patternstring

    SQL 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
    AvgTaskCountstring

    平均 Task 个数。

    		2
    RequestIdstring

    请求 ID。

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

    示例

    正常返回示例

    JSON格式

    {
  "PageSize": 30,
  "PageNumber": 1,
  "TotalCount": 1,
  "Items": [
    {
      "AvgStageCount": "2",
      "MaxCpuTime": "17",
      "AccessIP": "100.104.***.***",
      "AvgScanSize": "0",
      "MaxScanSize": "0",
      "MaxPeakMemory": "480096",
      "AvgCpuTime": "1.0625",
      "User": "test_acc",
      "AvgPeakMemory": "240048",
      "MaxStageCount": "2",
      "MaxTaskCount": "2",
      "InstanceName": "am-bp1r053byu48p****",
      "QueryCount": "16",
      "ReportDate": "2021-08-30",
      "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",
      "AvgTaskCount": "2"
    }
  ],
  "RequestId": "B6F2D1B4-2C9F-5622-B424-5E7965******"
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史