@alicloud/adb20211201 5.3.0 → 5.5.0

package/src/models/CancelSqlPatternCompareReportRequest.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CancelSqlPatternCompareReportRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The AnalyticDB for MySQL instance ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-2ze1234567890****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The region ID of the instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The SQL Pattern comparison report ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1001
+   */
+  reportId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      regionId: 'RegionId',
+      reportId: 'ReportId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      regionId: 'string',
+      reportId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CancelSqlPatternCompareReportResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CancelSqlPatternCompareReportResponseBody } from "./CancelSqlPatternCompareReportResponseBody";
+
+
+export class CancelSqlPatternCompareReportResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CancelSqlPatternCompareReportResponseBody;
+  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: CancelSqlPatternCompareReportResponseBody,
+    };
+  }
+
+  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/CancelSqlPatternCompareReportResponseBody.ts

@@ -0,0 +1,64 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CancelSqlPatternCompareReportResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The time when the report was first canceled. The time is in UTC in the yyyy-MM-ddTHH:mmZ format.
+   * 
+   * @example
+   * 2026-09-08T01:06Z
+   */
+  cancelTime?: string;
+  /**
+   * @remarks
+   * Indicates whether the report is canceled. The value true is returned when the report is successfully canceled or canceled again.
+   * 
+   * @example
+   * true
+   */
+  canceled?: boolean;
+  /**
+   * @remarks
+   * The SQL Pattern comparison report ID.
+   * 
+   * @example
+   * 1001
+   */
+  reportId?: number;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9A1B2C3D-4E5F-6789-ABCD-0123456789AB
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      cancelTime: 'CancelTime',
+      canceled: 'Canceled',
+      reportId: 'ReportId',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      cancelTime: 'string',
+      canceled: 'boolean',
+      reportId: 'number',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateSqlPatternCompareReportRequest.ts

@@ -0,0 +1,111 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateSqlPatternCompareReportRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The end time of time window 2. Specify the time in UTC in the yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm:ssZ format.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2026-09-08T01:00Z
+   */
+  compareEndTime?: string;
+  /**
+   * @remarks
+   * The start time of time window 2. Specify the time in UTC in the yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm:ssZ format.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2026-09-08T00:00Z
+   */
+  compareStartTime?: string;
+  /**
+   * @remarks
+   * The ID of the AnalyticDB for MySQL cluster.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-2ze1234567890****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The end time of time window 1. Specify the time in UTC in the yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm:ssZ format.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2026-09-07T01:00Z
+   */
+  endTime?: string;
+  /**
+   * @remarks
+   * The report type. Valid values:
+   * 
+   * - `NEW`: Patterns that are new in time window 2.
+   * - `CHANGED`: Patterns that exist in both time windows and have an increased average value in at least one metric.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * CHANGED
+   */
+  patternType?: string;
+  /**
+   * @remarks
+   * The region ID of the instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The start time of time window 1. Specify the time in UTC in the yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm:ssZ format.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2026-09-07T00:00Z
+   */
+  startTime?: string;
+  static names(): { [key: string]: string } {
+    return {
+      compareEndTime: 'CompareEndTime',
+      compareStartTime: 'CompareStartTime',
+      DBClusterId: 'DBClusterId',
+      endTime: 'EndTime',
+      patternType: 'PatternType',
+      regionId: 'RegionId',
+      startTime: 'StartTime',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      compareEndTime: 'string',
+      compareStartTime: 'string',
+      DBClusterId: 'string',
+      endTime: 'string',
+      patternType: 'string',
+      regionId: 'string',
+      startTime: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateSqlPatternCompareReportResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateSqlPatternCompareReportResponseBody } from "./CreateSqlPatternCompareReportResponseBody";
+
+
+export class CreateSqlPatternCompareReportResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateSqlPatternCompareReportResponseBody;
+  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: CreateSqlPatternCompareReportResponseBody,
+    };
+  }
+
+  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/CreateSqlPatternCompareReportResponseBody.ts

@@ -0,0 +1,44 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateSqlPatternCompareReportResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the created report. This value only indicates that the request has been accepted.
+   * 
+   * @example
+   * 1001
+   */
+  reportId?: number;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9A1B2C3D-4E5F-6789-ABCD-0123456789AB
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      reportId: 'ReportId',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      reportId: 'number',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeSqlPatternCompareReportRequest.ts

@@ -0,0 +1,160 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeSqlPatternCompareReportRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The average change rate filter range for CHANGED reports. The format is `left~right`, where values are expressed as percentages and the interval is left-exclusive and right-inclusive. Examples:
+   * 
+   * - `100~500`: greater than 100% and less than or equal to 500%.
+   * - `100~`: greater than 100% with no upper limit.
+   * 
+   * > - The left boundary is required and must be no less than 0. The right boundary must be no less than the left boundary.
+   * > - This parameter is ignored for NEW reports.
+   * > - When the time window 1 metric value is 0 and the time window 2 value is greater than 0, the Pattern is classified as zero-baseline growth and is categorized as `SEVERE` (significant change). To exclude such Patterns, set an upper limit for the change rate.
+   * 
+   * @example
+   * 100~500
+   */
+  changeRate?: string;
+  /**
+   * @remarks
+   * The ID of the AnalyticDB for MySQL instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-2ze1234567890****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * Specifies whether to return the parameterized SQL Pattern text. Valid values:
+   * 
+   * - `true`: Returns the Pattern text.
+   * - `false`: Does not return the Pattern text, which reduces the response size.
+   * 
+   * Default value: `true`.
+   * 
+   * @example
+   * true
+   */
+  includePattern?: boolean;
+  /**
+   * @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.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * CPU_COST
+   */
+  metricType?: string;
+  /**
+   * @remarks
+   * Sorts the query results by a specified field. The value is a JSON array string, such as `[{"Field":"Time2SumValue","Type":"Desc"}]`. The array can contain only one object. Parameters:
+   * 
+   * - `Field`: the sort field. This parameter is case-sensitive. Valid values:
+   *     - NEW report: `Time2SumValue`, `Time2AvgValue`, `Time2MaxValue`.
+   *     - CHANGED report: `AvgChangeRatePercent`, `AvgTime1Value`, `AvgTime2Value`, `SumChangeRatePercent`, `SumTime1Value`, `SumTime2Value`, `MaxChangeRatePercent`, `MaxTime1Value`, `MaxTime2Value`.
+   *     - All report types and analysis metrics: `AvgRt`, `MaxRt`.
+   *     - `QUERY_COUNT`: `TotalQueryTime`.
+   *     - `CPU_COST`: `QueryCount`, `AvgPlanningTime`, `MaxPlanningTime`, `AvgExecutionTime`, `MaxExecutionTime`.
+   *     - `SHUFFLE_SIZE`, `PEAK_MEMORY`: `QueryCount`.
+   *     - `SCAN_SIZE`: `QueryCount`, `TotalScanCost`.
+   * - `Type`: the sort order. This parameter is case-insensitive. Valid values:
+   *     - `Asc`: ascending order.
+   *     - `Desc`: descending order.
+   * 
+   * > - NEW reports are sorted by `Time2SumValue` in descending order by default.
+   * > - CHANGED reports are sorted by `AvgChangeRatePercent` in descending order by default.
+   * > - The value of `Field` must be applicable to the current report type and `MetricType`.
+   * 
+   * @example
+   * [{"Field":"AvgChangeRatePercent","Type":"Desc"}]
+   */
+  order?: string;
+  /**
+   * @remarks
+   * The page number. Pages start from page 1.
+   * 
+   * Default value: 1.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Valid values: 1 to 100.
+   * 
+   * Default value: 50.
+   * 
+   * @example
+   * 50
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The region ID of the instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The ID of the SQL Pattern comparison report.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1001
+   */
+  reportId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      changeRate: 'ChangeRate',
+      DBClusterId: 'DBClusterId',
+      includePattern: 'IncludePattern',
+      metricType: 'MetricType',
+      order: 'Order',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      regionId: 'RegionId',
+      reportId: 'ReportId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      changeRate: 'string',
+      DBClusterId: 'string',
+      includePattern: 'boolean',
+      metricType: 'string',
+      order: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
+      regionId: 'string',
+      reportId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeSqlPatternCompareReportResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeSqlPatternCompareReportResponseBody } from "./DescribeSqlPatternCompareReportResponseBody";
+
+
+export class DescribeSqlPatternCompareReportResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeSqlPatternCompareReportResponseBody;
+  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: DescribeSqlPatternCompareReportResponseBody,
+    };
+  }
+
+  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);
+  }
+}
+