调用DescribeSqlPattern查询SQLPattern详情_云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

查看指定日期内AnalyticDB for MySQL集群的SQL Pattern详情。

接口说明

当前服务的接入地址请参见服务接入点。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
adb:DescribeSqlPattern	list	DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
StartTime	string	是	查询开始日期，UTC 时间，格式：yyyy-MM-dd。说明仅支持查看 30 天内的数据。	2022-08-30
Order	string	否	将查询结果按指定字段进行排序。格式为 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"}]
PageNumber	integer	否	页码，取值：大于 0 且不超过 Integer 的最大值。默认值：1。	2
SqlPattern	string	否	需要包含的 SQL Pattern 的关键字。说明若该参数不填，默认返回目标集群在`StartTime`参数所设日期内的所有 SQL Pattern 详情。	SELECT
Type	string	否	按指定维度来聚合 SQL Pattern。取值说明： `user`：按用户维度聚合。 `accessip`：按访问 IP 来源聚合。说明若该参数不填，默认按照 `user`维度聚合。	user
DBClusterId	string	是	集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有集群的集群 ID。	amv-bp1ej1nq9n6****
PageSize	integer	否	每页记录数，取值： 10（默认值） 30 50 100	30
RegionId	string	是	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页记录数。	30
PageNumber	integer	页码。	2
TotalCount	integer	总记录数。	50
Items	array<object>	列表详情。
Items	object	列表详情。
AvgStageCount	string	平均扫描行数。	2
MaxCpuTime	string	SQL 的最大运行时间，单位：毫秒（ms）。	17
AccessIP	string	客户端 IP。说明仅当 Type 参数设置为 accessip 时，返回该参数。	100.104.xx.xx
AvgScanSize	string	平均扫描量，单位：KB。	244
MaxScanSize	string	最大扫描量，单位：KB。	1024
MaxPeakMemory	string	最大峰值内存，单位：KB。	480096
AvgCpuTime	string	平均执行时间，单位：毫秒（ms）。	1.0625
User	string	用户名。说明仅当 Type 参数留空或设置为 user 时，返回该参数。	test_acc
AvgPeakMemory	string	平均峰值内存，单位：KB。	240048
MaxStageCount	string	最大 Stage 个数。	2
MaxTaskCount	string	最大任务数。	2
InstanceName	string	集群 ID。	amv-bp1ej1nq9n6****
QueryCount	string	查询总数。	16
ReportDate	string	查询日期。	2022-08-30
Pattern	string	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
AvgTaskCount	string	平均任务数。	2
RequestId	string	请求 ID。	DB1F6C23-CBCA-5260-9366-BA7BB5EBF6F1

示例

正常返回示例

JSON格式

{
  "PageSize": 30,
  "PageNumber": 2,
  "TotalCount": 50,
  "Items": [
    {
      "AvgStageCount": "2",
      "MaxCpuTime": "17",
      "AccessIP": "100.104.xx.xx",
      "AvgScanSize": "244",
      "MaxScanSize": "1024",
      "MaxPeakMemory": "480096",
      "AvgCpuTime": "1.0625",
      "User": "test_acc",
      "AvgPeakMemory": "240048",
      "MaxStageCount": "2",
      "MaxTaskCount": "2",
      "InstanceName": "amv-bp1ej1nq9n6****",
      "QueryCount": "16",
      "ReportDate": "2022-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": "DB1F6C23-CBCA-5260-9366-BA7BB5EBF6F1"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-09-13	API 内部配置变更，不影响调用	查看变更详情