@alicloud/adb20211201 5.4.0 → 5.5.1

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);
+  }
+}
+

package/src/models/DescribeSqlPatternRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSqlPatternRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
-   * 
-   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.
+   * The cluster ID.
+   * > You can call the DescribeDBClusters operation to query the IDs of all clusters in a specified region.
+   * [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html)
    * 
    * This parameter is required.
    * 
@@ -17,35 +17,29 @@ export class DescribeSqlPatternRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The order by which to sort query results. Specify the parameter value in the JSON string format. Example: `[{"Field":"Pattern","Type":"Asc"}]`. Parameters:
-   * 
-   * *   `Field` specifies the field by which to sort the query results. Valid values:
-   * 
-   *     *   `Pattern`: the SQL pattern.
-   *     *   `AccessIP`: the IP address of the client.
-   *     *   `User`: the username.
-   *     *   `QueryCount`: the number of queries performed in association with the SQL pattern within the time range to query.
-   *     *   `AvgPeakMemory`: the average peak memory usage of the SQL pattern within the time range to query. Unit: KB.
-   *     *   `MaxPeakMemory`: the maximum peak memory usage of the SQL pattern within the time range to query. Unit: KB.
-   *     *   `AvgCpuTime`: the average execution duration of the SQL pattern within the time range to query. Unit: milliseconds.
-   *     *   `MaxCpuTime`: the maximum execution duration of the SQL pattern within the time range to query. Unit: milliseconds.
-   *     *   `AvgStageCount`: the average number of stages.
-   *     *   `MaxStageCount`: the maximum number of stages.
-   *     *   `AvgTaskCount`: the average number of tasks.
-   *     *   `MaxTaskCount`: the maximum number of tasks.
-   *     *   `AvgScanSize`: the average amount of data scanned based on the SQL pattern within the time range to query. Unit: KB.
-   *     *   `MaxScanSize`: the maximum amount of data scanned based on the SQL pattern within the time range to query. Unit: KB.
-   * 
-   * *   `Type` specifies the sorting order. Valid values:
-   * 
-   *     *   `Asc`: ascending order.
-   *     *   `Desc`: descending order.
-   * 
-   * > 
-   * 
-   * *   If you do not specify this parameter, query results are sorted in ascending order of `Pattern`.
-   * 
-   * *   If you want to sort query results by `AccessIP`, you must set the `Type` parameter to `accessip`. If you want to sort query results by `User`, you must leave the `Type` parameter empty or set it to `user`.
+   * Specifies the sorting of query results by a specified field. The format is a JSON character string, such as `[{"Field":"Pattern","Type":"Asc"}]`. Parameters:
+   * - Field: the sorting field. Valid values:
+   *     - Pattern: SQL pattern.
+   *     - AccessIP: client IP address.
+   *     - User: username.
+   *     - QueryCount: total number of queries.
+   *     - AvgPeakMemory: average peak memory. Unit: KB.
+   *     - MaxPeakMemory: Peak Volume memory. Unit: KB.
+   *     - AvgCpuTime: average computing duration. Unit: milliseconds.
+   *     - MaxCpuTime: maximum computing duration. Unit: milliseconds.
+   *     - AvgStageCount: average number of stages.
+   *     - MaxStageCount: maximum number of stages.
+   *     - AvgTaskCount: average number of tasks.
+   *     - MaxTaskCount: maximum number of tasks.
+   *     - AvgScanSize: average scan size. Unit: KB.
+   *     - MaxScanSize: maximum scan size. Unit: KB.
+   * 
+   * - Type: the sorting method. Valid values:
+   *     - Asc: ascending sorting.
+   *     - Desc: descending sorting.
+   * 
+   * > - If no Settings are specified for this parameter, the results are sorted in ascending order by the Pattern field by default.
+   * - To perform sorting by the AccessIP field, you must set the Type parameter to accessip. To perform sorting by the User field, you must leave the Type parameter empty or set it to user.
    * 
    * @example
    * [{"Field":"Pattern","Type":"Asc"}]
@@ -53,7 +47,8 @@ export class DescribeSqlPatternRequest extends $dara.Model {
   order?: string;
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: 1.
+   * The page number. Valid values: integers greater than 0 and no greater than the maximum value of the Integer type.
+   * Default value: 1.
    * 
    * @example
    * 2
@@ -62,11 +57,10 @@ export class DescribeSqlPatternRequest extends $dara.Model {
   /**
    * @remarks
    * The number of entries per page. Valid values:
-   * 
-   * *   **10** (default)
-   * *   **30**
-   * *   **50**
-   * *   **100**
+   * - **10** (default)
+   * - **30**
+   * - **50**
+   * - **100**
    * 
    * @example
    * 30
@@ -74,7 +68,7 @@ export class DescribeSqlPatternRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID.
    * 
    * This parameter is required.
    * 
@@ -84,9 +78,8 @@ export class DescribeSqlPatternRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The keyword that is used for the query.
-   * 
-   * > If you do not specify this parameter, all SQL patterns of the AnalyticDB for MySQL cluster within the time period specified by `StartTime` are returned.
+   * The keyword that the SQL pattern must contain.
+   * > If this parameter is not specified, the details of all SQL patterns for the cluster on the date specified by the StartTime parameter are returned by default.
    * 
    * @example
    * SELECT
@@ -94,9 +87,8 @@ export class DescribeSqlPatternRequest extends $dara.Model {
   sqlPattern?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd format. The time must be in UTC.
-   * 
-   * > Only data within the last 30 days can be queried.
+   * The start date of the query. The time is in UTC and formatted as yyyy-MM-dd.
+   * > You can only query data within the last 30 days.
    * 
    * @example
    * 2022-08-30
@@ -104,12 +96,11 @@ export class DescribeSqlPatternRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The dimension by which to aggregate the SQL patterns. Valid values:
-   * 
-   * *   `user`: aggregates the SQL patterns by user.
-   * *   `accessip`: aggregates the SQL patterns by client IP address.
+   * Aggregates SQL patterns by a specified dimension. Valid values:
+   *  - user: aggregates by user.
+   *  - accessip: aggregates by access IP address.
    * 
-   * > If you do not specify this parameter, the SQL patterns are aggregated by `user`.
+   * > If this parameter is not specified, SQL patterns are aggregated by user by default.
    * 
    * @example
    * user

package/src/models/DescribeSqlPatternResponseBody.ts

@@ -5,9 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The IP address of the client.
-   * 
-   * >  This parameter is returned only when **Type** is set to **accessip**.
+   * The client IP address.
+   * > This parameter is returned only when the Type parameter is set to accessip.
    * 
    * @example
    * 100.104.xx.xx
@@ -15,7 +14,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   accessIP?: string;
   /**
    * @remarks
-   * The average execution duration of the SQL pattern within the query time range. Unit: milliseconds.
+   * The average execution time. Unit: milliseconds.
    * 
    * @example
    * 1.0625
@@ -23,7 +22,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   avgCpuTime?: string;
   /**
    * @remarks
-   * The average peak memory usage of the SQL pattern within the query time range. Unit: KB.
+   * The average peak memory. Unit: KB.
    * 
    * @example
    * 240048
@@ -31,7 +30,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   avgPeakMemory?: string;
   /**
    * @remarks
-   * The average amount of data scanned based on the SQL pattern within the query time range. Unit: KB.
+   * The average scan size. Unit: KB.
    * 
    * @example
    * 244
@@ -55,7 +54,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   avgTaskCount?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
+   * The cluster ID.
    * 
    * @example
    * amv-bp1ej1nq9n6****
@@ -63,7 +62,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   instanceName?: string;
   /**
    * @remarks
-   * The maximum execution duration of the SQL pattern within the query time range. Unit: milliseconds.
+   * The maximum execution time of the SQL statement. Unit: milliseconds.
    * 
    * @example
    * 17
@@ -71,7 +70,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   maxCpuTime?: string;
   /**
    * @remarks
-   * The maximum peak memory usage of the SQL pattern within the query time range. Unit: KB.
+   * The Peak Volume memory. Unit: KB.
    * 
    * @example
    * 480096
@@ -79,7 +78,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   maxPeakMemory?: string;
   /**
    * @remarks
-   * The maximum amount of data scanned based on the SQL pattern within the query time range. Unit: KB.
+   * The maximum scan size. Unit: KB.
    * 
    * @example
    * 1024
@@ -111,7 +110,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   pattern?: string;
   /**
    * @remarks
-   * The number of queries performed in association with the SQL pattern within the query time range.
+   * The total number of queries.
    * 
    * @example
    * 16
@@ -119,7 +118,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   queryCount?: string;
   /**
    * @remarks
-   * The start date of the query.
+   * The query date.
    * 
    * @example
    * 2022-08-30
@@ -128,8 +127,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
   /**
    * @remarks
    * The username.
-   * 
-   * >  This parameter is returned only when **Type** is left empty or set to **user**.
+   * > This parameter is returned only when the Type parameter is left empty or set to user.
    * 
    * @example
    * test_acc
@@ -189,7 +187,7 @@ export class DescribeSqlPatternResponseBodyItems extends $dara.Model {
 export class DescribeSqlPatternResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The queried SQL pattern.
+   * The list details.
    */
   items?: DescribeSqlPatternResponseBodyItems[];
   /**
@@ -218,7 +216,7 @@ export class DescribeSqlPatternResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 50