DescribeSqlPatternCompareReports - 查询 SQL Pattern 对比报告列表-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

查询 SQL Pattern 对比报告列表。

接口说明

查询指定实例下当前阿里云主账号创建的 SQL Pattern 对比报告。RAM 用户查询所属主账号的报告。

支持以下分页方式：

页码分页（推荐）：使用 PageNumber、PageSize。
令牌分页：使用 MaxResults、NextToken。

说明

两种分页方式不可混用。页码分页时，平台自动携带的 MaxResults 不生效。
列表仅返回未过期的 PENDING、RUNNING 或 SUCCESS 报告。
通过 DetailEnabled 判断是否可查询详情，通过 CancelAvailable 判断是否可取消。
报告有效期为 7 天，并按实例和阿里云主账号隔离。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在的地域 ID。	cn-beijing
DBClusterId	string	是	AnalyticDB for MySQL 实例 ID。	am-2ze1234567890****
PageNumber	integer	否	页码，从 1 开始。默认值：1。说明与 `PageSize` 配合使用。传入该参数时，`NextToken` 必须为空。	2
PageSize	integer	否	每页行数，取值范围：1～100。默认值：50。说明与 `PageNumber` 配合使用。传入该参数时，`NextToken` 必须为空。	50
MaxResults	integer	否	令牌分页的每页行数，取值范围：1～100。默认值：50。说明使用 `NextToken` 翻页时，该参数须保持不变。使用 `PageNumber`、`PageSize` 分页时，该参数不生效。推荐使用 `PageNumber`、`PageSize` 分页。	50
NextToken	string	否	下一页令牌。说明首次查询时不传，后续查询时原样传入上一次返回的 `NextToken`。不得与 `PageNumber` 或 `PageSize` 同时使用。推荐使用 `PageNumber`、`PageSize` 分页。	djE6Mjo1MA
Order	string	否	将查询结果按指定字段排序。格式为 JSON 数组字符串，例如 `[{"Field":"CreatedAt","Type":"Desc"}]`。数组中只能包含一个对象。其中： `Field` 表示排序字段。取值说明： `CreatedAt`：报告创建时间。 `StartTime`：时间 1 的开始时间。 `CompareStartTime`：时间 2 的开始时间。 `Type` 表示排序方式，不区分大小写。取值说明： `Asc`：升序排列。 `Desc`：降序排列。说明若不设置该参数，默认按照 `CreatedAt` 字段降序排列。	[{"Field":"CreatedAt","Type":"Desc"}]

返回参数

名称	类型	描述	示例值
	object	报告列表的分页查询结果。
Items	array<object>	当前页的报告列表；无符合条件的报告时为空数组。
	object	单份 SQL Pattern 对比报告。
CancelAvailable	boolean	是否可取消。PENDING 或 RUNNING 时为 true。	false
CompareEndTime	string	时间 2 的结束时间。UTC 格式为 yyyy-MM-ddTHH:mmZ。	2026-09-08T01:00Z
CompareStartTime	string	时间 2 的开始时间。UTC 格式为 yyyy-MM-ddTHH:mmZ。	2026-09-08T00:00Z
CreatedAt	string	报告创建时间。UTC 格式为 yyyy-MM-ddTHH:mmZ。	2026-09-08T01:05Z
DetailEnabled	boolean	是否可查询详情。SUCCESS 时为 true。	true
EndTime	string	时间 1 的结束时间。UTC 格式为 yyyy-MM-ddTHH:mmZ。	2026-09-07T01:00Z
ReportId	integer	SQL Pattern 对比报告 ID。	1001
ReportType	string	报告类型。取值说明： `NEW`：新增 Pattern。 `CHANGED`：指标增长的 Pattern。枚举值： NEW : 新增 SQL Pattern CHANGED : 指标增长的 SQL Pattern	CHANGED
ReportTypeName	string	报告类型名称。	变化 Pattern 对比报告
RowNumber	integer	当前排序结果中的序号，从 1 开始。	1
StartTime	string	时间 1 的开始时间。UTC 格式为 yyyy-MM-ddTHH:mmZ。	2026-09-07T00:00Z
Status	string	报告状态。取值说明： `PENDING`：等待生成。 `RUNNING`：正在生成。 `SUCCESS`：生成成功。 `FAILED`：生成失败。 `CANCELED`：已取消。 `EXPIRED`：已过期。说明当前列表仅返回 `PENDING`、`RUNNING` 或 `SUCCESS`。枚举值： SUCCESS : 生成成功 FAILED : 生成失败 RUNNING : 正在生成 CANCELED : 已取消 EXPIRED : 已过期 PENDING : 等待生成	SUCCESS
MaxResults	integer	本次查询使用的每页行数。	50
NextToken	string	下一页令牌；为空表示没有下一页。	djE6Mjo1MA
PageNumber	integer	本次查询使用的页码，从 1 开始。	2
PageSize	integer	本次查询使用的每页行数。	50
RequestId	string	请求 ID。	9A1B2C3D-4E5F-6789-ABCD-0123456789AB
TotalCount	integer	符合条件的报告总数。	51

示例

正常返回示例

JSON格式

{
  "Items": [
    {
      "CancelAvailable": false,
      "CompareEndTime": "2026-09-08T01:00Z",
      "CompareStartTime": "2026-09-08T00:00Z",
      "CreatedAt": "2026-09-08T01:05Z",
      "DetailEnabled": true,
      "EndTime": "2026-09-07T01:00Z",
      "ReportId": 1001,
      "ReportType": "CHANGED",
      "ReportTypeName": "变化 Pattern 对比报告",
      "RowNumber": 1,
      "StartTime": "2026-09-07T00:00Z",
      "Status": "SUCCESS"
    }
  ],
  "MaxResults": 50,
  "NextToken": "djE6Mjo1MA",
  "PageNumber": 2,
  "PageSize": 50,
  "RequestId": "9A1B2C3D-4E5F-6789-ABCD-0123456789AB",
  "TotalCount": 51
}

错误码

HTTP status code	错误码	错误信息	描述
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

变更历史

更多信息，参考变更详情。