@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/DescribeSqlpatternsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSQLPatternsResponseBodyPatternDetails extends $dara.Model {
   /**
    * @remarks
-   * The IP address of the SQL client that commits the SQL pattern.
+   * The client IP address used to submit the queries.
    * 
    * @example
    * 192.168.xx.xx
@@ -13,16 +13,23 @@ export class DescribeSQLPatternsResponseBodyPatternDetails 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 of queries matching this pattern. Unit: milliseconds.
    * 
    * @example
    * 234.78
    */
   averageExecutionTime?: number;
+  /**
+   * @remarks
+   * The average CPU cost for queries that match this pattern. Unit: milliseconds.
+   * 
+   * @example
+   * 5
+   */
   averageOperatorCost?: number;
   /**
    * @remarks
-   * The average peak memory usage of the SQL pattern within the query time range. Unit: bytes.
+   * The average peak memory usage of queries matching this pattern. Unit: bytes.
    * 
    * @example
    * 234.22
@@ -30,16 +37,23 @@ export class DescribeSQLPatternsResponseBodyPatternDetails extends $dara.Model {
   averagePeakMemory?: number;
   /**
    * @remarks
-   * The average total amount of time consumed by the SQL pattern within the query time range. Unit: milliseconds.
+   * The average duration of queries matching this pattern. Unit: milliseconds.
    * 
    * @example
    * 4
    */
   averageQueryTime?: number;
+  /**
+   * @remarks
+   * The average scan time for queries that match this pattern. Unit: milliseconds.
+   * 
+   * @example
+   * 5
+   */
   averageScanCost?: number;
   /**
    * @remarks
-   * The average amount of data scanned based on the SQL pattern within the query time range. Unit: bytes.
+   * The average amount of data scanned by queries matching this pattern. Unit: bytes.
    * 
    * @example
    * 234149.23
@@ -47,12 +61,13 @@ export class DescribeSQLPatternsResponseBodyPatternDetails extends $dara.Model {
   averageScanSize?: number;
   /**
    * @remarks
-   * Indicates whether the execution of the SQL pattern can be intercepted. Valid values:
+   * Indicates whether queries that match this pattern can be blocked. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: The queries can be blocked.
    * 
-   * >  Only SELECT and INSERT statements can be intercepted.
+   * - **false**: The queries cannot be blocked.
+   * 
+   * > Currently, AnalyticDB for MySQL allows you to block only SELECT and INSERT statements.
    * 
    * @example
    * true
@@ -60,7 +75,7 @@ export class DescribeSQLPatternsResponseBodyPatternDetails extends $dara.Model {
   blockable?: boolean;
   /**
    * @remarks
-   * The number of failed queries executed in association with the SQL pattern within the query time range.
+   * The number of failed queries that match this pattern.
    * 
    * @example
    * 18
@@ -68,16 +83,23 @@ export class DescribeSQLPatternsResponseBodyPatternDetails extends $dara.Model {
   failedCount?: number;
   /**
    * @remarks
-   * The maximum execution duration of the SQL pattern within the query time range. Unit: milliseconds.
+   * The maximum execution time of a query matching this pattern. Unit: milliseconds.
    * 
    * @example
    * 2142
    */
   maxExecutionTime?: number;
+  /**
+   * @remarks
+   * The maximum CPU cost for a query that matches this pattern. Unit: milliseconds.
+   * 
+   * @example
+   * 5
+   */
   maxOperatorCost?: number;
   /**
    * @remarks
-   * The maximum peak memory usage of the SQL pattern within the query time range. Unit: bytes.
+   * The maximum peak memory usage of a query matching this pattern. Unit: bytes.
    * 
    * @example
    * 234149
@@ -85,26 +107,47 @@ export class DescribeSQLPatternsResponseBodyPatternDetails extends $dara.Model {
   maxPeakMemory?: number;
   /**
    * @remarks
-   * The maximum total amount of time consumed by the SQL pattern within the query time range. Unit: milliseconds.
+   * The maximum duration of a query matching this pattern. Unit: milliseconds.
    * 
    * @example
    * 2341
    */
   maxQueryTime?: number;
+  /**
+   * @remarks
+   * The maximum scan time for a query that matches this pattern. Unit: milliseconds.
+   * 
+   * @example
+   * 5
+   */
   maxScanCost?: number;
   /**
    * @remarks
-   * The maximum amount of data scanned based on the SQL pattern within the query time range. Unit: bytes.
+   * The maximum amount of data scanned by a query matching this pattern. Unit: bytes.
    * 
    * @example
    * 32212254
    */
   maxScanSize?: number;
+  /**
+   * @remarks
+   * The total CPU cost of queries matching this pattern as a percentage of the total CPU cost for all queries. Unit: %.
+   * 
+   * @example
+   * 20
+   */
   operatorCostPercentage?: number;
+  /**
+   * @remarks
+   * The total CPU cost for all queries that match this pattern. Unit: milliseconds.
+   * 
+   * @example
+   * 5
+   */
   operatorCostSum?: number;
   /**
    * @remarks
-   * The earliest commit time of the SQL pattern within the query time range.
+   * The submission time of the first query that matches this pattern within the specified time range.
    * 
    * @example
    * 2022-09-06 05:06:00
@@ -118,33 +161,89 @@ export class DescribeSQLPatternsResponseBodyPatternDetails extends $dara.Model {
    * 5575924945138******
    */
   patternId?: string;
+  /**
+   * @remarks
+   * The total peak memory usage of queries matching this pattern as a percentage of the total peak memory usage for all queries. Unit: %.
+   * 
+   * @example
+   * 10
+   */
   peakMemoryPercentage?: number;
+  /**
+   * @remarks
+   * The sum of the peak memory usage for all queries that match this pattern. Unit: bytes.
+   * 
+   * @example
+   * 5
+   */
   peakMemorySum?: number;
   /**
    * @remarks
-   * The number of queries executed in association with the SQL pattern within the query time range.
+   * The number of executed queries that match this pattern.
    * 
    * @example
    * 345
    */
   queryCount?: number;
+  /**
+   * @remarks
+   * The total query time of queries matching this pattern as a percentage of the total query time for all queries. Unit: %.
+   * 
+   * @example
+   * 10
+   */
   queryTimePercentage?: number;
+  /**
+   * @remarks
+   * The total query duration for all queries that match this pattern. Unit: milliseconds.
+   * 
+   * @example
+   * 5
+   */
   queryTimeSum?: number;
   /**
    * @remarks
-   * The statement of the SQL pattern.
+   * The SQL pattern.
    * 
    * @example
    * SELECT * FROM KEPLER_META_NODE_STATIC_INFO WHERE elastic_node = ? OR (elastic_node = ? AND enable = ?)
    */
   SQLPattern?: string;
+  /**
+   * @remarks
+   * The total scan cost of queries matching this pattern as a percentage of the total scan cost for all queries. Unit: %.
+   * 
+   * @example
+   * 5
+   */
   scanCostPercentage?: number;
+  /**
+   * @remarks
+   * The total scan cost for all queries that match this pattern. Unit: milliseconds.
+   * 
+   * @example
+   * 5
+   */
   scanCostSum?: number;
+  /**
+   * @remarks
+   * The total amount of data scanned by queries matching this pattern as a percentage of the total data scanned by all queries. Unit: %.
+   * 
+   * @example
+   * 80
+   */
   scanSizePercentage?: number;
+  /**
+   * @remarks
+   * The total amount of data scanned by all queries that match this pattern. Unit: bytes.
+   * 
+   * @example
+   * 5
+   */
   scanSizeSum?: number;
   /**
    * @remarks
-   * The tables scanned based on the SQL pattern.
+   * The tables scanned by the SQL pattern.
    * 
    * @example
    * tpch.orders
@@ -152,7 +251,7 @@ export class DescribeSQLPatternsResponseBodyPatternDetails extends $dara.Model {
   tables?: string;
   /**
    * @remarks
-   * The name of the database account that is used to commit the SQL pattern.
+   * The name of the database user who submitted the matching SQL statements.
    * 
    * @example
    * test
@@ -242,7 +341,7 @@ export class DescribeSQLPatternsResponseBodyPatternDetails extends $dara.Model {
 export class DescribeSQLPatternsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.
+   * Details about the access denial. This parameter is returned only if RAM authentication fails.
    * 
    * @example
    * {
@@ -274,7 +373,7 @@ export class DescribeSQLPatternsResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The queried SQL patterns.
+   * A list of SQL patterns.
    */
   patternDetails?: DescribeSQLPatternsResponseBodyPatternDetails[];
   /**
@@ -282,12 +381,12 @@ export class DescribeSQLPatternsResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * F3174013-5B7A-5A47-9FE0-6B5D397BD86B
+   * F3174013-5B7A-5A47-9FE0-6B5D397BD86A
    */
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries.
    * 
    * @example
    * 20

package/src/models/DescribeSqlwebSocketDomainRequest.ts

@@ -7,18 +7,29 @@ export class DescribeSQLWebSocketDomainRequest extends $dara.Model {
    * @remarks
    * The cluster ID.
    * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
+   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) API to query the details of all clusters in your account, including cluster IDs.
    * 
    * @example
    * amv-bp1lw6g669zpi660
    */
   DBClusterId?: string;
+  /**
+   * @remarks
+   * The application module name.
+   * 
+   * - `SQLWebSocket`: The module for SQL development.
+   * 
+   * - `Assistant`: The module for the intelligent assistant.
+   * 
+   * @example
+   * Assistant
+   */
   module?: string;
   /**
    * @remarks
-   * The region ID
+   * The region ID.
    * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the most recent region list.
+   * > Call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) API to query the region IDs supported by AnalyticDB for MySQL.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeSqlwebSocketDomainResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeSQLWebSocketDomainResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.
+   * The status code. A value of 200 indicates that the request succeeded.
    * 
    * @example
    * 200
@@ -21,10 +21,11 @@ export class DescribeSQLWebSocketDomainResponseBody extends $dara.Model {
   domain?: string;
   /**
    * @remarks
-   * The returned message. Valid values:
+   * The response message.
    * 
-   * *   If the request was successful, a success message is returned.****
-   * *   If the request failed, an error message is returned.
+   * - Returns **Success** if the request succeeds.
+   * 
+   * - Returns a specific error code if the request fails.
    * 
    * @example
    * Success
@@ -32,7 +33,7 @@ export class DescribeSQLWebSocketDomainResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * The unique identifier for the request.
    * 
    * @example
    * E03F0806-A67B-5B24-8562-9589F20DEEB5
@@ -40,10 +41,11 @@ export class DescribeSQLWebSocketDomainResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the API call succeeded. Valid values:
+   * 
+   * - **true**: The call succeeded.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: The call failed.
    * 
    * @example
    * true

package/src/models/DescribeTableAccessCountRequest.ts

@@ -5,9 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeTableAccessCountRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
+   * <props="china">The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.
+   * <props="intl">The ID of the Data Lakehouse Edition cluster.
    * 
-   * >  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 clusters in a region.
    * 
    * This parameter is required.
    * 
@@ -17,20 +18,16 @@ export class DescribeTableAccessCountRequest 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":"TableSchema","Type":"Asc"}]`. Fields in the request parameter:
+   * Sorts the query results by a specified field. The value is a JSON string. Example: `[{"Field":"TableSchema","Type":"Asc"}]`.
+   * - `Field` specifies the field by which to sort. Valid values:
+   *     - `TableSchema`: the name of the database to which the table belongs.
+   *     - `TableName`: the table name.
+   *     - `AccessCount`: the number of times the table is accessed.
+   * - `Type` specifies the sort order. Valid values:
+   *     - `Asc`: ascending order.
+   *     - `Desc`: descending order.
    * 
-   * *   `Field` specifies the field by which to sort the query results. Valid values:
-   * 
-   *     *   `TableSchema`: the name of the database to which the table belongs.
-   *     *   `TableName`: the name of the table.
-   *     *   `AccessCount`: the number of accesses to the table.
-   * 
-   * *   `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 based on the database and the table.
+   * > If this parameter is not specified, the results are sorted by the database name of the table in ascending order by default.
    * 
    * @example
    * [{"Field":"TableSchema","Type":"Asc"}]
@@ -38,7 +35,7 @@ export class DescribeTableAccessCountRequest extends $dara.Model {
   order?: string;
   /**
    * @remarks
-   * The page number. Pages start from 1. Default value: **1**.
+   * The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: **1**.
    * 
    * @example
    * 1
@@ -47,11 +44,10 @@ export class DescribeTableAccessCountRequest extends $dara.Model {
   /**
    * @remarks
    * The number of entries per page. Valid values:
-   * 
-   * *   **10** (default)
-   * *   **30**
-   * *   **50**
-   * *   **100**
+   * - **10** (default)
+   * - **30**
+   * - **50**
+   * - **100**
    * 
    * @example
    * 30
@@ -59,7 +55,7 @@ export class DescribeTableAccessCountRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID.
    * 
    * This parameter is required.
    * 
@@ -69,9 +65,8 @@ export class DescribeTableAccessCountRequest 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.
-   * 
-   * >  Only data within the last 30 days can be queried.
+   * The beginning of the time range to query, in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
+   * > Only data within the last 30 days can be queried.
    * 
    * @example
    * 2022-09-25T12:10:00Z
@@ -80,8 +75,7 @@ export class DescribeTableAccessCountRequest extends $dara.Model {
   /**
    * @remarks
    * The name of the table.
-   * 
-   * >  If you leave this parameter empty, the number of accesses to all tables in the cluster on a date is returned.
+   * > If this parameter is left empty, the access frequency data of all tables in the cluster within the specified date range is returned.
    * 
    * @example
    * CUSTOMER

package/src/models/DescribeTableAccessCountResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeTableAccessCountResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The number of accesses to the table.
+   * The number of times the table was accessed.
    * 
    * @example
    * 6
@@ -13,7 +13,7 @@ export class DescribeTableAccessCountResponseBodyItems extends $dara.Model {
   accessCount?: string;
   /**
    * @remarks
-   * The ID of the cluster to which the table belongs.
+   * The cluster ID of the cluster to which the table belongs.
    * 
    * @example
    * amv-2ze627uzpkh8a8****
@@ -21,7 +21,7 @@ export class DescribeTableAccessCountResponseBodyItems extends $dara.Model {
   instanceName?: string;
   /**
    * @remarks
-   * The date when the table was accessed.
+   * The date on which the table was used.
    * 
    * @example
    * 2022-09-26
@@ -29,7 +29,7 @@ export class DescribeTableAccessCountResponseBodyItems extends $dara.Model {
   reportDate?: string;
   /**
    * @remarks
-   * The name of the table.
+   * The table name.
    * 
    * @example
    * CUSTOMER
@@ -75,7 +75,7 @@ export class DescribeTableAccessCountResponseBodyItems extends $dara.Model {
 export class DescribeTableAccessCountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The queried tables.
+   * The table usage details.
    */
   items?: DescribeTableAccessCountResponseBodyItems[];
   /**

package/src/models/DescribeTablePartitionDiagnoseResponseBody.ts

@@ -8,7 +8,7 @@ export class DescribeTablePartitionDiagnoseResponseBodyDetectionItems extends $d
    * The detection result.
    * 
    * @example
-   * Multiple oversized non-partitioned tables are detected.
+   * 检测到表存在分区不合理的情况
    */
   message?: string;
   /**
@@ -16,7 +16,7 @@ export class DescribeTablePartitionDiagnoseResponseBodyDetectionItems extends $d
    * The name of the detection item.
    * 
    * @example
-   * Improper partition field diagnostics
+   * 表分区合理性检测
    */
   name?: string;
   /**

package/src/models/DescribeTableStatisticsResponseBody.ts

@@ -3,110 +3,17 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeTableStatisticsResponseBodyItemsTableStatisticRecords extends $dara.Model {
-  /**
-   * @remarks
-   * The size of cold data. Unit: bytes.
-   * 
-   * >  This parameter is supported only for AnalyticDB for MySQL clusters of V3.1.3.4 or later.
-   * 
-   * @example
-   * 4428120064
-   */
   coldDataSize?: number;
-  /**
-   * @remarks
-   * The data size of the table. Unit: bytes.
-   * 
-   * @example
-   * 15592
-   */
   dataSize?: number;
-  /**
-   * @remarks
-   * The size of hot data. Unit: bytes.
-   * 
-   * @example
-   * 1048576
-   */
   hotDataSize?: number;
-  /**
-   * @remarks
-   * The data size of indexes. Unit: bytes.
-   * 
-   * @example
-   * 3076
-   */
   indexSize?: number;
-  /**
-   * @remarks
-   * The data size of other data. Unit: bytes.
-   * 
-   * @example
-   * 1048576
-   */
   otherSize?: number;
-  /**
-   * @remarks
-   * The number of partitions.
-   * 
-   * @example
-   * 1
-   */
   partitionCount?: number;
-  /**
-   * @remarks
-   * The data size of the primary key index. Unit: bytes.
-   * 
-   * @example
-   * 16340
-   */
   primaryKeyIndexSize?: number;
-  /**
-   * @remarks
-   * The number of rows in the table.
-   * 
-   * @example
-   * 3
-   */
   rowCount?: number;
-  /**
-   * @remarks
-   * The name of the database.
-   * 
-   * @example
-   * test_schema
-   */
   schemaName?: string;
-  /**
-   * @remarks
-   * The percentage of the table size. Unit: %.
-   * 
-   * >  Formula: Table storage percentage = Total data size of a table/Total data size of the cluster × 100%.
-   * 
-   * @example
-   * 66.23
-   */
   spaceRatio?: number;
-  /**
-   * @remarks
-   * The name of the table.
-   * 
-   * @example
-   * test_table
-   */
   tableName?: string;
-  /**
-   * @remarks
-   * The total data size of the table. Unit: bytes.
-   * 
-   * >  The following formulas can be used to calculate the total data size:
-   * 
-   * *   Formula 1: Total data size = Hot data size + Cold data size.
-   * *   Formula 2: Total data size = Data size of table records + Data size of regular indexes + Data size of primary key indexes + Data size of other data.
-   * 
-   * @example
-   * 1577
-   */
   totalSize?: number;
   static names(): { [key: string]: string } {
     return {
@@ -186,10 +93,6 @@ export class DescribeTableStatisticsResponseBody extends $dara.Model {
    * am-****************
    */
   DBClusterId?: string;
-  /**
-   * @remarks
-   * The queried table statistics.
-   */
   items?: DescribeTableStatisticsResponseBodyItems;
   /**
    * @remarks