@alicloud/adb20211201 5.3.0 → 5.5.0

package/src/models/DescribeSqlPatternCompareReportResponseBody.ts

@@ -0,0 +1,287 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ItemsMetricValuesValue } from "./ItemsMetricValuesValue";
+
+
+export class DescribeSqlPatternCompareReportResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * The display string of the average execution duration for Time 2, in seconds. This field is returned only for the CPU_COST dimension.
+   * 
+   * @example
+   * 0.4s
+   */
+  avgExecutionTime?: string;
+  /**
+   * @remarks
+   * The display string of the average planning duration for Time 2, in seconds. This field is returned only for the CPU_COST dimension.
+   * 
+   * @example
+   * 0.1s
+   */
+  avgPlanningTime?: string;
+  /**
+   * @remarks
+   * The display string of the average query response time for Time 2, in seconds. This field is returned for all analysis dimensions.
+   * 
+   * @example
+   * 0.5s
+   */
+  avgRt?: string;
+  /**
+   * @remarks
+   * The display string of the maximum execution duration for Time 2, in seconds. This field is returned only for the CPU_COST dimension.
+   * 
+   * @example
+   * 1.8s
+   */
+  maxExecutionTime?: string;
+  /**
+   * @remarks
+   * The display string of the maximum planning duration for Time 2, in seconds. This field is returned only for the CPU_COST dimension.
+   * 
+   * @example
+   * 0.2s
+   */
+  maxPlanningTime?: string;
+  /**
+   * @remarks
+   * The display string of the maximum query response time for Time 2, in seconds. This field is returned for all analysis dimensions.
+   * 
+   * @example
+   * 2s
+   */
+  maxRt?: string;
+  /**
+   * @remarks
+   * The primary metric mapping for the current analysis dimension. Valid keys:
+   * 
+   * - `QUERY_COUNT`: the number of query executions.
+   * - `CPU_COST`: the CPU consumption.
+   * - `SHUFFLE_SIZE`: the shuffle data volume.
+   * - `PEAK_MEMORY`: the peak memory consumption.
+   * - `SCAN_SIZE`: the scan data volume.
+   * 
+   * > Each result contains only one key that matches the `MetricType` request parameter.
+   */
+  metricValues?: { [key: string]: ItemsMetricValuesValue };
+  /**
+   * @remarks
+   * The parameterized SQL Pattern text. This field is empty or not returned when IncludePattern is set to false. When the text is unavailable, a prompt containing a hash identifier may be returned.
+   * 
+   * @example
+   * SELECT * FROM orders WHERE order_id = ?
+   */
+  pattern?: string;
+  /**
+   * @remarks
+   * The number of query executions for Time 2, in count. This field is returned for the CPU_COST, SHUFFLE_SIZE, PEAK_MEMORY, and SCAN_SIZE dimensions.
+   * 
+   * @example
+   * 120
+   */
+  queryCount?: number;
+  /**
+   * @remarks
+   * The display string of the number of query executions for Time 2. The applicable scope is the same as QueryCount.
+   * 
+   * @example
+   * 120 times
+   */
+  queryCountDisplayValue?: string;
+  /**
+   * @remarks
+   * The global sequence number in the current filtered and sorted results, starting from 1 and numbered continuously across pages.
+   * 
+   * @example
+   * 1
+   */
+  rank?: number;
+  /**
+   * @remarks
+   * The change level for the current analysis dimension. Valid values:
+   * 
+   * - `NEW`: A new Pattern. Returned only for NEW reports.
+   * - `SLIGHT`: A slight change. The average change rate is in the range of (0%, 20%].
+   * - `MODERATE`: A moderate change. The average change rate is in the range of (20%, 50%].
+   * - `HIGH`: A high change. The average change rate is in the range of (50%, 100%].
+   * - `SEVERE`: A severe change. The average change rate is greater than 100%, or the change represents zero-baseline growth.
+   * 
+   * > The change level only indicates the magnitude of metric growth and cannot be used alone to determine the cause of a fault.
+   * 
+   * @example
+   * SEVERE
+   */
+  riskLevel?: string;
+  /**
+   * @remarks
+   * The hash identifier of the SQL Pattern, returned as a string. Store and pass this value as a string to avoid precision loss caused by numeric conversion.
+   * 
+   * @example
+   * 1234567890123456789
+   */
+  sqlPatternHash?: string;
+  /**
+   * @remarks
+   * The display string of the total query duration for Time 2, in seconds. This field is returned only for the QUERY_COUNT dimension.
+   * 
+   * @example
+   * 60s
+   */
+  totalQueryTime?: string;
+  /**
+   * @remarks
+   * The display string of the total scan duration for Time 2, in seconds. This field is returned only for the SCAN_SIZE dimension.
+   * 
+   * @example
+   * 12s
+   */
+  totalScanCost?: string;
+  static names(): { [key: string]: string } {
+    return {
+      avgExecutionTime: 'AvgExecutionTime',
+      avgPlanningTime: 'AvgPlanningTime',
+      avgRt: 'AvgRt',
+      maxExecutionTime: 'MaxExecutionTime',
+      maxPlanningTime: 'MaxPlanningTime',
+      maxRt: 'MaxRt',
+      metricValues: 'MetricValues',
+      pattern: 'Pattern',
+      queryCount: 'QueryCount',
+      queryCountDisplayValue: 'QueryCountDisplayValue',
+      rank: 'Rank',
+      riskLevel: 'RiskLevel',
+      sqlPatternHash: 'SqlPatternHash',
+      totalQueryTime: 'TotalQueryTime',
+      totalScanCost: 'TotalScanCost',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      avgExecutionTime: 'string',
+      avgPlanningTime: 'string',
+      avgRt: 'string',
+      maxExecutionTime: 'string',
+      maxPlanningTime: 'string',
+      maxRt: 'string',
+      metricValues: { 'type': 'map', 'keyType': 'string', 'valueType': ItemsMetricValuesValue },
+      pattern: 'string',
+      queryCount: 'number',
+      queryCountDisplayValue: 'string',
+      rank: 'number',
+      riskLevel: 'string',
+      sqlPatternHash: 'string',
+      totalQueryTime: 'string',
+      totalScanCost: 'string',
+    };
+  }
+
+  validate() {
+    if(this.metricValues) {
+      $dara.Model.validateMap(this.metricValues);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeSqlPatternCompareReportResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The Pattern details on the current page. An empty array is returned if no results match the conditions.
+   */
+  items?: DescribeSqlPatternCompareReportResponseBodyItems[];
+  /**
+   * @remarks
+   * The analysis metric. Valid values:
+   * 
+   * - `QUERY_COUNT`: the number of query executions.
+   * - `CPU_COST`: the CPU consumption.
+   * - `SHUFFLE_SIZE`: the amount of shuffle data.
+   * - `PEAK_MEMORY`: the peak memory consumption.
+   * - `SCAN_SIZE`: the amount of scanned data.
+   * 
+   * @example
+   * CPU_COST
+   */
+  metricType?: string;
+  /**
+   * @remarks
+   * The page number of the returned page, starting from 1.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The maximum number of entries returned per page for this query.
+   * 
+   * @example
+   * 50
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The ID of the SQL Pattern comparison report.
+   * 
+   * @example
+   * 1001
+   */
+  reportId?: number;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9A1B2C3D-4E5F-6789-ABCD-0123456789AB
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of Patterns that match the current report, analysis dimension, and change rate filter conditions. This is not the number of entries on the current page.
+   * 
+   * @example
+   * 1
+   */
+  totalCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      items: 'Items',
+      metricType: 'MetricType',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      reportId: 'ReportId',
+      requestId: 'RequestId',
+      totalCount: 'TotalCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      items: { 'type': 'array', 'itemType': DescribeSqlPatternCompareReportResponseBodyItems },
+      metricType: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
+      reportId: 'number',
+      requestId: 'string',
+      totalCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeSqlPatternCompareReportsRequest.ts

@@ -0,0 +1,126 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeSqlPatternCompareReportsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the AnalyticDB for MySQL instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-2ze1234567890****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The number of rows per page for token-based pagination. Valid values: 1 to 100.
+   * 
+   * Default value: 50.
+   * 
+   * > - When you use `NextToken` for pagination, keep this parameter unchanged.
+   * > - This parameter does not take effect when you use `PageNumber` and `PageSize` for pagination.
+   * > - We recommend that you use `PageNumber` and `PageSize` for pagination.
+   * 
+   * @example
+   * 50
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next page.
+   * 
+   * > - Do not specify this parameter for the first query. For subsequent queries, pass in the `NextToken` value returned by the previous query.
+   * > - Do not use this parameter together with `PageNumber` or `PageSize`.
+   * > - Use `PageNumber` and `PageSize` for pagination.
+   * 
+   * @example
+   * djE6Mjo1MA
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * Sorts the query results by a specified field. The value is a JSON array string, for example, `[{"Field":"CreatedAt","Type":"Desc"}]`. The array can contain only one object. Fields:
+   * 
+   * - `Field`: the field by which to sort. Valid values:
+   *     - `CreatedAt`: the time when the report was created.
+   *     - `StartTime`: the start time of time range 1.
+   *     - `CompareStartTime`: the start time of time range 2.
+   * - `Type`: the sort order. This value is case-insensitive. Valid values:
+   *     - `Asc`: ascending order.
+   *     - `Desc`: descending order.
+   * 
+   * > If you do not specify this parameter, the results are sorted by `CreatedAt` in descending order by default.
+   * 
+   * @example
+   * [{"Field":"CreatedAt","Type":"Desc"}]
+   */
+  order?: string;
+  /**
+   * @remarks
+   * The page number. Pages start from 1.
+   * 
+   * Default value: 1.
+   * 
+   * > Use this parameter together with `PageSize`. If you specify this parameter, `NextToken` must be empty.
+   * 
+   * @example
+   * 2
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of rows per page. Valid values: 1 to 100.
+   * 
+   * Default value: 50.
+   * 
+   * > Use this parameter together with `PageNumber`. If you specify this parameter, `NextToken` must be empty.
+   * 
+   * @example
+   * 50
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The region ID of the instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      order: 'Order',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      maxResults: 'number',
+      nextToken: 'string',
+      order: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeSqlPatternCompareReportsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeSqlPatternCompareReportsResponseBody } from "./DescribeSqlPatternCompareReportsResponseBody";
+
+
+export class DescribeSqlPatternCompareReportsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeSqlPatternCompareReportsResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeSqlPatternCompareReportsResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeSqlPatternCompareReportsResponseBody.ts

@@ -0,0 +1,246 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeSqlPatternCompareReportsResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the report can be canceled. The value is true when the report is in the PENDING or RUNNING state.
+   * 
+   * @example
+   * false
+   */
+  cancelAvailable?: boolean;
+  /**
+   * @remarks
+   * The end time of time range 2. The time is in the yyyy-MM-ddTHH:mmZ UTC format.
+   * 
+   * @example
+   * 2026-09-08T01:00Z
+   */
+  compareEndTime?: string;
+  /**
+   * @remarks
+   * The start time of time range 2. The time is in the yyyy-MM-ddTHH:mmZ UTC format.
+   * 
+   * @example
+   * 2026-09-08T00:00Z
+   */
+  compareStartTime?: string;
+  /**
+   * @remarks
+   * The time when the report was created. The time is in the yyyy-MM-ddTHH:mmZ UTC format.
+   * 
+   * @example
+   * 2026-09-08T01:05Z
+   */
+  createdAt?: string;
+  /**
+   * @remarks
+   * Indicates whether report details can be queried. The value is true when the report is in the SUCCESS state.
+   * 
+   * @example
+   * true
+   */
+  detailEnabled?: boolean;
+  /**
+   * @remarks
+   * The end time of time range 1. The time is in the yyyy-MM-ddTHH:mmZ UTC format.
+   * 
+   * @example
+   * 2026-09-07T01:00Z
+   */
+  endTime?: string;
+  /**
+   * @remarks
+   * The ID of the SQL Pattern comparison report.
+   * 
+   * @example
+   * 1001
+   */
+  reportId?: number;
+  /**
+   * @remarks
+   * The report type. Valid values:
+   * 
+   * - `NEW`: new patterns.
+   * - `CHANGED`: patterns with increased metrics.
+   * 
+   * @example
+   * CHANGED
+   */
+  reportType?: string;
+  /**
+   * @remarks
+   * The name of the report type.
+   * 
+   * @example
+   * Changed Pattern Comparison Report
+   */
+  reportTypeName?: string;
+  /**
+   * @remarks
+   * The sequence number in the current sorted result. The value starts from 1.
+   * 
+   * @example
+   * 1
+   */
+  rowNumber?: number;
+  /**
+   * @remarks
+   * The start time of time range 1. The time is in the yyyy-MM-ddTHH:mmZ UTC format.
+   * 
+   * @example
+   * 2026-09-07T00:00Z
+   */
+  startTime?: string;
+  /**
+   * @remarks
+   * The report status. Valid values:
+   * 
+   * - `PENDING`: waiting to be generated.
+   * - `RUNNING`: being generated.
+   * - `SUCCESS`: generated.
+   * - `FAILED`: failed to be generated.
+   * - `CANCELED`: canceled.
+   * - `EXPIRED`: expired.
+   * 
+   * > The current list returns only reports in the `PENDING`, `RUNNING`, or `SUCCESS` state.
+   * 
+   * @example
+   * SUCCESS
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      cancelAvailable: 'CancelAvailable',
+      compareEndTime: 'CompareEndTime',
+      compareStartTime: 'CompareStartTime',
+      createdAt: 'CreatedAt',
+      detailEnabled: 'DetailEnabled',
+      endTime: 'EndTime',
+      reportId: 'ReportId',
+      reportType: 'ReportType',
+      reportTypeName: 'ReportTypeName',
+      rowNumber: 'RowNumber',
+      startTime: 'StartTime',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      cancelAvailable: 'boolean',
+      compareEndTime: 'string',
+      compareStartTime: 'string',
+      createdAt: 'string',
+      detailEnabled: 'boolean',
+      endTime: 'string',
+      reportId: 'number',
+      reportType: 'string',
+      reportTypeName: 'string',
+      rowNumber: 'number',
+      startTime: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeSqlPatternCompareReportsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of reports on the current page. An empty array is returned if no reports match the conditions.
+   */
+  items?: DescribeSqlPatternCompareReportsResponseBodyItems[];
+  /**
+   * @remarks
+   * The number of rows per page used in this query.
+   * 
+   * @example
+   * 50
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next page. An empty value indicates that no more pages are available.
+   * 
+   * @example
+   * djE6Mjo1MA
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The page number used in this query. Pages start from 1.
+   * 
+   * @example
+   * 2
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of rows per page used in this query.
+   * 
+   * @example
+   * 50
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9A1B2C3D-4E5F-6789-ABCD-0123456789AB
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of reports that match the conditions.
+   * 
+   * @example
+   * 51
+   */
+  totalCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      items: 'Items',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      requestId: 'RequestId',
+      totalCount: 'TotalCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      items: { 'type': 'array', 'itemType': DescribeSqlPatternCompareReportsResponseBodyItems },
+      maxResults: 'number',
+      nextToken: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
+      requestId: 'string',
+      totalCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+