@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/DescribeMvRecommendSubTasksRequest.ts

@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeMvRecommendSubTasksRequest extends $dara.Model {
   /**
    * @remarks
-   * Fixed system value (non-modifiable).
+   * A static value. This parameter cannot be modified.
+   * 
+   * @example
+   * Modification is not supported.
    */
   actionInner?: string;
   /**
@@ -18,20 +21,26 @@ export class DescribeMvRecommendSubTasksRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Fixed system value (non-modifiable).
+   * A static value. This parameter cannot be modified.
+   * 
+   * @example
+   * Modification is not supported.
    */
   from?: string;
   /**
    * @remarks
-   * The sorting field. Valid values for Type:
+   * The sorting criteria.
+   * Valid values for \\`Type\\`:
+   * 
+   * - Asc
+   * 
+   * - Desc
    * 
-   * *   Asc.
-   * *   Desc.
+   * Valid values for \\`Field\\`:
    * 
-   * Valid values for Field:
+   * - StartTime
    * 
-   * *   StartTime;
-   * *   EndTime;
+   * - EndTime
    * 
    * @example
    * {\\"Type\\": \\"ASC\\", \\"Field\\": \\"StartTime\\"}
@@ -47,7 +56,7 @@ export class DescribeMvRecommendSubTasksRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return per page.
+   * The number of entries per page.
    * 
    * @example
    * 30
@@ -71,7 +80,7 @@ export class DescribeMvRecommendSubTasksRequest extends $dara.Model {
   subtaskId?: number;
   /**
    * @remarks
-   * The name of the recommendation task.
+   * The name of the materialized view recommendation task.
    * 
    * @example
    * my_task_1

package/src/models/DescribeMvRecommendSubTasksResponseBody.ts

@@ -6,7 +6,7 @@ import { OpenStructMvRecommendSubTaskModel } from "./OpenStructMvRecommendSubTas
 export class DescribeMvRecommendSubTasksResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The list of recommended tasks to be executed.
+   * The list of materialized view recommendation task executions.
    */
   mvRecommendSubTaskModels?: OpenStructMvRecommendSubTaskModel[];
   /**
@@ -19,7 +19,7 @@ export class DescribeMvRecommendSubTasksResponseBodyData extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page.
    * 
    * @example
    * 30
@@ -27,7 +27,7 @@ export class DescribeMvRecommendSubTasksResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 4
@@ -79,7 +79,7 @@ export class DescribeMvRecommendSubTasksResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page.
    * 
    * @example
    * 30
@@ -87,7 +87,7 @@ export class DescribeMvRecommendSubTasksResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
@@ -95,7 +95,7 @@ export class DescribeMvRecommendSubTasksResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 4

package/src/models/DescribeMvRecommendTasksRequest.ts

@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeMvRecommendTasksRequest extends $dara.Model {
   /**
    * @remarks
-   * Fixed system value (non-modifiable).
+   * A static field. This parameter cannot be modified.
+   * 
+   * @example
+   * Modification is not supported.
    */
   actionInner?: string;
   /**
@@ -18,7 +21,10 @@ export class DescribeMvRecommendTasksRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Fixed system value (non-modifiable).
+   * A static field. This parameter cannot be modified.
+   * 
+   * @example
+   * Modification is not supported.
    */
   from?: string;
   /**
@@ -31,7 +37,7 @@ export class DescribeMvRecommendTasksRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * The number of entries per page.
    * 
    * @example
    * 30
@@ -47,7 +53,7 @@ export class DescribeMvRecommendTasksRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the recommendation task.
+   * The name of the materialized view recommendation task.
    * 
    * @example
    * my_task_1

package/src/models/DescribeMvRecommendTasksResponseBody.ts

@@ -6,7 +6,7 @@ import { OpenStructMvRecommendTaskModel } from "./OpenStructMvRecommendTaskModel
 export class DescribeMvRecommendTasksResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The list of recommended tasks for materialized views.
+   * The list of materialized view recommendation tasks.
    */
   mvRecommendTaskModels?: OpenStructMvRecommendTaskModel[];
   /**
@@ -19,7 +19,7 @@ export class DescribeMvRecommendTasksResponseBodyData extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page.
    * 
    * @example
    * 30
@@ -27,7 +27,7 @@ export class DescribeMvRecommendTasksResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries that are returned.
+   * The total number of entries.
    * 
    * @example
    * 4
@@ -66,7 +66,7 @@ export class DescribeMvRecommendTasksResponseBodyData extends $dara.Model {
 export class DescribeMvRecommendTasksResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The data returned.
+   * The returned data.
    */
   data?: DescribeMvRecommendTasksResponseBodyData;
   /**
@@ -79,7 +79,7 @@ export class DescribeMvRecommendTasksResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page.
    * 
    * @example
    * 30
@@ -87,7 +87,7 @@ export class DescribeMvRecommendTasksResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
@@ -95,7 +95,7 @@ export class DescribeMvRecommendTasksResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries that are returned.
+   * The total number of entries.
    * 
    * @example
    * 4

package/src/models/DescribeMvrecommendResultsRequest.ts

@@ -5,7 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeMVRecommendResultsRequest extends $dara.Model {
   /**
    * @remarks
-   * Fixed system value (non-modifiable).
+   * A static value. This parameter cannot be modified.
+   * 
+   * @example
+   * Modification is not supported.
    */
   actionInner?: string;
   /**
@@ -18,7 +21,10 @@ export class DescribeMVRecommendResultsRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Fixed system value (non-modifiable).
+   * A static value. This parameter cannot be modified.
+   * 
+   * @example
+   * Modification is not supported.
    */
   from?: string;
   /**
@@ -39,7 +45,7 @@ export class DescribeMVRecommendResultsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return per page.
+   * The number of entries per page.
    * 
    * @example
    * 30
@@ -54,6 +60,9 @@ export class DescribeMVRecommendResultsRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The subquery ID.
+   * 
    * @example
    * 123
    */

package/src/models/DescribeMvrecommendResultsResponseBody.ts

@@ -4,10 +4,14 @@ import { OpenStructMVRecommendResultModel } from "./OpenStructMvrecommendResultM
 
 
 export class DescribeMVRecommendResultsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * A list of materialized view recommendation results.
+   */
   mvRecommendResultModels?: OpenStructMVRecommendResultModel[];
   /**
    * @remarks
-   * The page number. Default value: **1**.
+   * The page number. The default value is **1**.
    * 
    * @example
    * 1
@@ -15,11 +19,13 @@ export class DescribeMVRecommendResultsResponseBodyData extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned per page. Valid values:
+   * The number of entries per page. Valid values:
    * 
-   * *   **30** (default).
-   * *   **50**.
-   * *   **100**.
+   * - **30** (Default)
+   * 
+   * - **50**
+   * 
+   * - **100**
    * 
    * @example
    * 20
@@ -87,7 +93,7 @@ export class DescribeMVRecommendResultsResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
@@ -95,7 +101,7 @@ export class DescribeMVRecommendResultsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 20

package/src/models/DescribeOperatorPermissionRequest.ts

@@ -7,7 +7,7 @@ export class DescribeOperatorPermissionRequest extends $dara.Model {
    * @remarks
    * The cluster ID.
    * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeOversizeNonPartitionTableInfosResponseBody.ts

@@ -16,7 +16,7 @@ export class DescribeOversizeNonPartitionTableInfosResponseBodyDetectionItems ex
    * The name of the detection item.
    * 
    * @example
-   * Oversized non-partitioned tables
+   * Oversized non-partitioned table
    */
   name?: string;
   /**

package/src/models/DescribePatternPerformanceRequest.ts

@@ -7,7 +7,7 @@ export class DescribePatternPerformanceRequest 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 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 clusters in a region, including their cluster IDs.
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class DescribePatternPerformanceRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. Specify the time in the *yyyy-MM-ddTHH:mmZ* format. The time must be in UTC.
+   * The end of the time range to query. Specify the time in UTC in the *yyyy-MM-ddTHH:mm:ssZ* format.
    * 
    * > The end time must be later than the start time.
    * 
@@ -27,9 +27,9 @@ export class DescribePatternPerformanceRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The SQL pattern ID.
+   * The ID of the SQL pattern.
    * 
-   * >  You can call the [DescribeSQLPatterns](https://help.aliyun.com/document_detail/321868.html) operation to query the information about all SQL patterns in an AnalyticDB for MySQL cluster within a period of time, including SQL pattern IDs.
+   * > You can call the [DescribeSQLPatterns](https://help.aliyun.com/document_detail/321868.html) operation to query information about all SQL patterns in a cluster within a specified time range, including the ID of each SQL pattern.
    * 
    * @example
    * 3847585356974******
@@ -47,13 +47,11 @@ export class DescribePatternPerformanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-ddTHH:mm:ssZ* format. The time must be in UTC.
+   * The beginning of the time range to query. Specify the time in UTC in the *yyyy-MM-ddTHH:mm:ssZ* format.
    * 
-   * > 
+   * > - You can query data from the last 14 days. If you specify a start time earlier than this period, an empty value is returned. For example, if the current date is August 22, 2022 (China Standard Time), the earliest valid start time is 2022-08-08T16:00:00Z.
    * 
-   * *   If the current date is August 22, 2022 (UTC+8), you can query the data of August 9, 2022 (2022-08-08T16:00:00Z) to the earliest extent. If you want to query the data that is earlier than August 9, 2022 (2022-08-08T16:00:00Z), null is returned.
-   * 
-   * *   The maximum time range that can be specified is 24 hours.
+   * - The interval between the start time and the end time cannot exceed 24 hours.
    * 
    * @example
    * 2022-08-21T02:15:00Z

package/src/models/DescribePatternPerformanceResponseBody.ts

@@ -5,29 +5,33 @@ import * as $dara from '@darabonba/typescript';
 export class DescribePatternPerformanceResponseBodyPerformancesSeries extends $dara.Model {
   /**
    * @remarks
-   * The name of the performance metric value. Valid values:
+   * The name of the performance value. The value of this parameter varies based on the value of `Key`:
    * 
-   * *   If the value of `Key` is `AnalyticDB_PatternQueryCount`, `pattern_query_count` is returned, which indicates the number of executions of the SQL statements in association with the SQL pattern.
+   * - If `Key` is `AnalyticDB_PatternQueryCount`, this parameter returns `pattern_query_count`, which indicates the query count for the sql pattern.
    * 
-   * *   If the value of `Key` is `AnalyticDB_PatternQueryTime`, the following values are returned:
+   * - If `Key` is `AnalyticDB_PatternQueryTime`, this parameter can be one of the following values:
    * 
-   *     *   `average_query_time`, which indicates the average total amount of time consumed by the SQL statements in association with the SQL pattern.
-   *     *   `max_query_time`, which indicates the maximum total amount of time consumed by the SQL statements in association with the SQL pattern.
+   *   - `average_query_time`: the average total time of queries that match the sql pattern.
    * 
-   * *   If the value of `Key` is `AnalyticDB_PatternExecutionTime`, the following values are returned:
+   *   - `max_query_time`: the maximum total time of queries that match the sql pattern.
    * 
-   *     *   `average_execution_time`, which indicates the average execution duration of the SQL statements in association with the SQL pattern.
-   *     *   `max_execution_time`, which indicates the maximum execution duration of the SQL statements in association with the SQL pattern.
+   * - If `Key` is `AnalyticDB_PatternExecutionTime`, this parameter can be one of the following values:
    * 
-   * *   If the value of `Key` is `AnalyticDB_PatternPeakMemory`, the following values are returned:
+   *   - `average_execution_time`: the average execution time of queries that match the sql pattern.
    * 
-   *     *   `average_peak_memory`, which indicates the average peak memory usage of the SQL statements in association with the SQL pattern.
-   *     *   `max_peak_memory`, which indicates the maximum peak memory usage of the SQL statements in association with the SQL pattern.
+   *   - `max_execution_time`: the maximum execution time of queries that match the sql pattern.
    * 
-   * *   If the value of `Key` is `AnalyticDB_PatternScanSize`, the following values are returned:
+   * - If `Key` is `AnalyticDB_PatternPeakMemory`, this parameter can be one of the following values:
    * 
-   *     *   `average_scan_size`, which indicates the average amount of data scanned by the SQL statements in association with the SQL pattern.
-   *     *   `max_scan_size`, which indicates the maximum amount of data scanned by the SQL statements in association with the SQL pattern.
+   *   - `average_peak_memory`: the average peak memory usage of queries that match the sql pattern.
+   * 
+   *   - `max_peak_memory`: the maximum peak memory usage of queries that match the sql pattern.
+   * 
+   * - If `Key` is `AnalyticDB_PatternScanSize`, this parameter can be one of the following values:
+   * 
+   *   - `average_scan_size`: the average data scan size of queries that match the sql pattern.
+   * 
+   *   - `max_scan_size`: the maximum data scan size of queries that match the sql pattern.
    * 
    * @example
    * max_query_time
@@ -35,7 +39,7 @@ export class DescribePatternPerformanceResponseBodyPerformancesSeries extends $d
   name?: string;
   /**
    * @remarks
-   * The values of the performance metric.
+   * The list of performance values.
    */
   values?: string[];
   static names(): { [key: string]: string } {
@@ -67,13 +71,17 @@ export class DescribePatternPerformanceResponseBodyPerformancesSeries extends $d
 export class DescribePatternPerformanceResponseBodyPerformances extends $dara.Model {
   /**
    * @remarks
-   * The queried performance metric. Valid values:
+   * The performance metric. Valid values:
+   * 
+   * - **AnalyticDB_PatternQueryCount**: The total number of queries that match the sql pattern.
+   * 
+   * - **AnalyticDB_PatternQueryTime**: The total time for queries that match the sql pattern.
    * 
-   * *   **AnalyticDB_PatternQueryCount**: the total number of queries executed in association with the SQL pattern.
-   * *   **AnalyticDB_PatternQueryTime**: the total amount of time consumed by the queries executed in association with the SQL pattern.
-   * *   **AnalyticDB_PatternExecutionTime**: the execution duration of the queries executed in association with the SQL pattern.
-   * *   **AnalyticDB_PatternPeakMemory**: the peak memory usage of the queries executed in association with the SQL pattern.
-   * *   **AnalyticDB_PatternScanSize**: the amount of data scanned in the queries executed in association with the SQL pattern.
+   * - **AnalyticDB_PatternExecutionTime**: The total execution time of queries that match the sql pattern.
+   * 
+   * - **AnalyticDB_PatternPeakMemory**: The peak memory usage of queries that match the sql pattern.
+   * 
+   * - **AnalyticDB_PatternScanSize**: The total data scan size of queries that match the sql pattern.
    * 
    * @example
    * AnalyticDB_PatternExecutionTime
@@ -81,17 +89,20 @@ export class DescribePatternPerformanceResponseBodyPerformances extends $dara.Mo
   key?: string;
   /**
    * @remarks
-   * The values of the performance metrics.
+   * The time series data for the performance metric.
    */
   series?: DescribePatternPerformanceResponseBodyPerformancesSeries[];
   /**
    * @remarks
-   * The unit of the performance metric. Valid values:
+   * The unit of the performance metric. The returned unit varies based on the value of `Key`:
+   * 
+   * - If `Key` is `AnalyticDB_PatternQueryTime` or `AnalyticDB_PatternExecutionTime`, the unit is **ms**.
+   * 
+   * - If `Key` is `AnalyticDB_PatternPeakMemory`, the unit is **MB**.
+   * 
+   * - If `Key` is `AnalyticDB_PatternScanSize`, the unit is **MB**.
    * 
-   * *   If the performance metric is related to the query time (the value of `Key` is `AnalyticDB_PatternQueryTime` or `AnalyticDB_PatternExecutionTime`), **ms** is returned.
-   * *   If the performance metric is related to the peak memory usage (the value of `Key` is `AnalyticDB_PatternPeakMemory`), **MB** is returned.
-   * *   If the performance metric is related to the amount of data scanned (the value of `Key` is `AnalyticDB_PatternScanSize`), **MB** is returned.
-   * *   If the performance metric is related to the number of queries (the value of `Key` is `AnalyticDB_PatternQueryCount`), null is returned.
+   * - If `Key` is `AnalyticDB_PatternQueryCount`, this parameter is empty.
    * 
    * @example
    * ms
@@ -126,21 +137,42 @@ export class DescribePatternPerformanceResponseBodyPerformances extends $dara.Mo
 }
 
 export class DescribePatternPerformanceResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The client IP address that submitted the queries that match the sql pattern.
+   * 
+   * @example
+   * 172.16.14.*
+   */
   accessIp?: string;
   /**
    * @remarks
-   * The end 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 end of the query time range. The time is in UTC and is formatted as *yyyy-MM-ddTHH:mmZ*.
    * 
    * @example
    * 2022-08-22T01:06:00Z
    */
   endTime?: string;
+  /**
+   * @remarks
+   * The number of failed executions for the sql pattern within the query time range.
+   * 
+   * @example
+   * 1
+   */
   failedCount?: number;
   /**
    * @remarks
-   * The queried performance metrics.
+   * The performance metrics.
    */
   performances?: DescribePatternPerformanceResponseBodyPerformances[];
+  /**
+   * @remarks
+   * The number of executions for the sql pattern within the query time range.
+   * 
+   * @example
+   * 1202
+   */
   queryCount?: number;
   /**
    * @remarks
@@ -150,16 +182,37 @@ export class DescribePatternPerformanceResponseBody extends $dara.Model {
    * F21AF487-B8C9-57E0-8E3A-A92BC3611FB6
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The SQL statement for the sql pattern.
+   * 
+   * @example
+   * SELECT *nFROM HIVE.`ADB_EXTERNAL_TPCH_10GB`.`External_customer`nLIMIT ?
+   */
   SQLPattern?: string;
   /**
    * @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 of the query time range. The time is in UTC and is formatted as *yyyy-MM-ddTHH:mmZ*.
    * 
    * @example
    * 2022-08-21T02:15:00Z
    */
   startTime?: string;
+  /**
+   * @remarks
+   * The tables queried by the sql pattern.
+   * 
+   * @example
+   * tpch_1g.part;tpch_1g.supplier;tpch_1g.lineitem;tpch_1g.partsupp;tpch_1g.orders;tpch_1g.nation
+   */
   tables?: string;
+  /**
+   * @remarks
+   * The database account that executes the SQL statements.
+   * 
+   * @example
+   * test_user
+   */
   user?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribePerformanceViewAttributeRequest.ts

@@ -38,7 +38,7 @@ export class DescribePerformanceViewAttributeRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * Basic
+   * Custom-All metrics-2 columns-Linked
    */
   viewName?: string;
   static names(): { [key: string]: string } {

package/src/models/DescribePerformanceViewAttributeResponseBody.ts

@@ -250,7 +250,7 @@ export class DescribePerformanceViewAttributeResponseBody extends $dara.Model {
    * The name of the view.
    * 
    * @example
-   * Basic
+   * Custom-All metrics-2 columns-Linked
    */
   viewName?: string;
   static names(): { [key: string]: string } {

package/src/models/DescribePerformanceViewsResponseBody.ts

@@ -24,7 +24,7 @@ export class DescribePerformanceViewsResponseBodyViews extends $dara.Model {
    * The name of the view.
    * 
    * @example
-   * Basic
+   * Custom-1
    */
   viewName?: string;
   static names(): { [key: string]: string } {