@alicloud/adb20211201 5.4.0 → 5.5.1

package/src/models/DescribeSparkSqldiagnosisListRequest.ts

@@ -6,8 +6,7 @@ export class DescribeSparkSQLDiagnosisListRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the details of all AnalyticDB for MySQL Data Lakehouse Edition (3.0) clusters in a specific region, including the cluster IDs.
    * 
    * This parameter is required.
    * 
@@ -17,7 +16,7 @@ export class DescribeSparkSQLDiagnosisListRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The latest start time.
+   * The maximum start time. Format: yyyy-MM-dd HH:mm:ss.
    * 
    * @example
    * 2024-11-28 23:00:00
@@ -25,7 +24,7 @@ export class DescribeSparkSQLDiagnosisListRequest extends $dara.Model {
   maxStartTime?: string;
   /**
    * @remarks
-   * The earliest start time.
+   * The minimum start time. Format: yyyy-MM-dd HH:mm:ss.
    * 
    * @example
    * 2024-11-28 22:00:00
@@ -33,23 +32,18 @@ export class DescribeSparkSQLDiagnosisListRequest extends $dara.Model {
   minStartTime?: string;
   /**
    * @remarks
-   * The order by which to sort query results. Specify the parameter value in the JSON format. Example: `[{"Field":"MaxExclusiveTime","Type":"Asc"}]`.
-   * 
-   * *   `Field` specifies the field by which to sort the query results. Valid values:
-   * 
-   *     *   `MaxExclusiveTime`: the maximum execution duration.
-   *     *   `PeakMemory`: the peak memory.
-   *     *   `QueryStartTime`: the start time of the query.
-   *     *   `QueryWallclockTime`: the execution duration of the query.
+   * Sorts the query results by a specified field. The value must be a JSON string. Example: `[{"Field":"MaxExclusiveTime","Type":"Asc"}]`. Parameters in the JSON string:
+   * - `Field`: the sort field. Valid values:
+   *     - `MaxExclusiveTime`: the maximum execution time.
+   *     - `PeakMemory`: the peak memory usage.
+   *     - `QueryStartTime`: the query start time.
+   *     - `QueryWallclockTime`: the query execution time.
    * 
-   * *   `Type` specifies the sorting order. Valid values:
+   * - `Type`: the sort order. Valid values:
+   *     - `Asc`: ascending order.
+   *     - `Desc`: descending order.
    * 
-   *     *   `Asc`: ascending order.
-   *     *   `Desc`: descending order.
-   * 
-   * > 
-   * 
-   * *   If you do not specify this parameter, query results are sorted by `MaxExclusiveTime` in ascending order.
+   * > - If this parameter is not specified, the results are sorted in ascending order by the `MaxExclusiveTime` field by default.
    * 
    * @example
    * [{\\"Field\\":\\"QueryStartTime\\",\\"Type\\":\\"Desc\\"}]
@@ -74,8 +68,7 @@ export class DescribeSparkSQLDiagnosisListRequest extends $dara.Model {
   /**
    * @remarks
    * The region ID.
-   * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the most recent region list.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the regions and zones supported by AnalyticDB for MySQL, including region IDs.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeSparkSqldiagnosisListResponseBody.ts

@@ -6,8 +6,7 @@ export class DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList extends $
   /**
    * @remarks
    * The application ID.
-   * 
-   * >  You can call the [ListSparkApps](https://help.aliyun.com/document_detail/612475.html) operation to query a list of Spark application IDs.
+   * > You can call the [ListSparkApps](https://help.aliyun.com/document_detail/612475.html) operation to query the ID of the Spark application.
    * 
    * @example
    * s202404291020bjd448ad40002122
@@ -15,7 +14,7 @@ export class DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList extends $
   appId?: string;
   /**
    * @remarks
-   * The execution duration of the query. Unit: milliseconds.
+   * The actual running time. Unit: milliseconds.
    * 
    * @example
    * 100
@@ -23,7 +22,7 @@ export class DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList extends $
   elapsedTime?: number;
   /**
    * @remarks
-   * The ID of the query executed within the Spark application.
+   * The internal query execution ID within the Spark application.
    * 
    * @example
    * 1
@@ -31,7 +30,7 @@ export class DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList extends $
   innerQueryId?: number;
   /**
    * @remarks
-   * The maximum operator execution duration. Unit: milliseconds.
+   * The maximum operator execution time. Unit: milliseconds.
    * 
    * @example
    * 90
@@ -39,7 +38,7 @@ export class DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList extends $
   maxExclusiveTime?: number;
   /**
    * @remarks
-   * The maximum operator memory used. Unit: bytes.
+   * The maximum operator memory consumption. Unit: bytes.
    * 
    * @example
    * 1024
@@ -55,7 +54,7 @@ export class DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList extends $
   SQL?: string;
   /**
    * @remarks
-   * The number of entries scanned.
+   * The number of scanned rows.
    * 
    * @example
    * 100
@@ -63,7 +62,7 @@ export class DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList extends $
   scanRowCount?: number;
   /**
    * @remarks
-   * The start time of the query. The time follows the ISO 8601 standard in the *yyyy-MM-ddTHH:mmZ* format. The time is displayed in UTC.
+   * The start time of the query. Format: <i>yyyy-MM-ddTHH:mmZ</i> (UTC time).
    * 
    * @example
    * 2024-11-20 09:09:00
@@ -71,12 +70,12 @@ export class DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList extends $
   startTime?: string;
   /**
    * @remarks
-   * The execution status of the query. Valid values:
+   * The final execution state of the query. Valid values:
    * 
-   * *   COMPLETED
-   * *   CANCELED
-   * *   ABORTED
-   * *   FAILED
+   * - COMPLETED: The query is completed.
+   * - CANCELED: The query is canceled.
+   * - ABORTED: The query is aborted.
+   * - FAILED: The query failed.
    * 
    * @example
    * COMPLETED
@@ -132,7 +131,7 @@ export class DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList extends $
 export class DescribeSparkSQLDiagnosisListResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the request denial.
+   * The details of the access denial.
    * 
    * @example
    * {}
@@ -164,12 +163,12 @@ export class DescribeSparkSQLDiagnosisListResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The queried diagnostic information.
+   * The SQL diagnostics information collection.
    */
   SQLDiagnosisList?: DescribeSparkSQLDiagnosisListResponseBodySQLDiagnosisList[];
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 1343

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

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