@alicloud/adb20211201 4.7.1 → 5.0.0

package/src/models/DescribeAuditLogRecordsResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeAuditLogRecordsResponseBodyItems extends $dara.Model {
   connId?: string;
   /**
    * @remarks
-   * The name of the database on which the SQL statement was executed.
+   * The name of the database on which the SQL statement ran.
    * 
    * @example
    * adb_demo
@@ -21,21 +21,34 @@ export class DescribeAuditLogRecordsResponseBodyItems extends $dara.Model {
   DBName?: string;
   /**
    * @remarks
-   * The start time of the execution of the SQL statement. The time is displayed in the ISO 8601 standard in the yyyy-MM-dd HH:mm:ss format. The time must be in UTC.
+   * The execution start time of the SQL statement. The time is in the `yyyy-MM-dd HH:mm:ss` format and in the local time zone.
    * 
    * @example
    * 2022-08-12 10:10:00
    */
   executeTime?: string;
+  /**
+   * @remarks
+   * The execution start time of the SQL statement, as a millisecond timestamp.
+   * 
+   * @example
+   * 1774600396584
+   */
   executeTimestamp?: number;
   /**
+   * @remarks
+   * Specifies whether the response contains diagnostic information.
+   * 
+   * @example
+   * true
+   * 
    * **if can be null:**
    * true
    */
   hasDiagnosticInfo?: boolean;
   /**
    * @remarks
-   * The IP address and port number of the client that is used to execute the SQL statement.
+   * The IP address and port of the client that ran the SQL statement.
    * 
    * @example
    * 100.104.XX.XX:43908
@@ -43,7 +56,7 @@ export class DescribeAuditLogRecordsResponseBodyItems extends $dara.Model {
   hostAddress?: string;
   /**
    * @remarks
-   * The task ID.
+   * The process ID.
    * 
    * @example
    * 202106081752021720161662490345362390
@@ -59,7 +72,7 @@ export class DescribeAuditLogRecordsResponseBodyItems extends $dara.Model {
   SQLText?: string;
   /**
    * @remarks
-   * The type of the SQL statement.
+   * The SQL type.
    * 
    * @example
    * SELECT
@@ -67,10 +80,11 @@ export class DescribeAuditLogRecordsResponseBodyItems extends $dara.Model {
   SQLType?: string;
   /**
    * @remarks
-   * Indicates whether the SQL statement was successfully executed. Valid values:
+   * Indicates whether the SQL statement succeeded. Valid values:
+   * 
+   * - **true**: The SQL statement succeeded.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: The SQL statement failed.
    * 
    * @example
    * true
@@ -78,7 +92,7 @@ export class DescribeAuditLogRecordsResponseBodyItems extends $dara.Model {
   succeed?: string;
   /**
    * @remarks
-   * The amount of time that is consumed to execute the SQL statement. Unit: milliseconds.
+   * The execution duration of the SQL statement in milliseconds (ms).
    * 
    * @example
    * 216
@@ -86,7 +100,7 @@ export class DescribeAuditLogRecordsResponseBodyItems extends $dara.Model {
   totalTime?: string;
   /**
    * @remarks
-   * The username that is used to execute the SQL statement.
+   * The username of the account that ran the SQL statement.
    * 
    * @example
    * test
@@ -138,7 +152,8 @@ export class DescribeAuditLogRecordsResponseBodyItems extends $dara.Model {
 export class DescribeAuditLogRecordsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) 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.
    * 
    * @example
    * amv-t4nj8619bz2w3****
@@ -146,7 +161,7 @@ export class DescribeAuditLogRecordsResponseBody extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The queried SQL audit logs.
+   * A list of audit log records.
    */
   items?: DescribeAuditLogRecordsResponseBodyItems[];
   /**
@@ -159,7 +174,7 @@ export class DescribeAuditLogRecordsResponseBody extends $dara.Model {
   pageNumber?: string;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of records per page.
    * 
    * @example
    * 10
@@ -175,7 +190,7 @@ export class DescribeAuditLogRecordsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of records.
    * 
    * @example
    * 6974

package/src/models/DescribeAutoRenewalAttributeResponseBody.ts

@@ -3,63 +3,11 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeAutoRenewalAttributeResponseBodyItemsAutoRenewalAttribute extends $dara.Model {
-  /**
-   * @remarks
-   * Indicates whether auto-renewal is enabled for the cluster. Valid values:
-   * 
-   * *   **true**: Enables.
-   * *   **false**: Disables.
-   * 
-   * @example
-   * true
-   */
   autoRenewalEnabled?: boolean;
-  /**
-   * @remarks
-   * The auto-renewal duration.
-   * 
-   * @example
-   * 1
-   */
   autoRenewalPeriod?: number;
-  /**
-   * @remarks
-   * The unit of auto-renewal duration. Valid values:
-   * 
-   * *   **Year**
-   * *   **Month**
-   * 
-   * @example
-   * Year
-   */
   autoRenewalPeriodUnit?: string;
-  /**
-   * @remarks
-   * The renewal method. Valid values:
-   * 
-   * *   **AutoRenewal**: The cluster is automatically renewed.
-   * *   **Normal**: The cluster is manually renewed. Before the cluster expires, the system sends you a reminder by SMS message.
-   * *   **NotRenewal**: The cluster is not renewed. Reminders are only sent three days before cluster expiration.
-   * 
-   * @example
-   * AutoRenewal
-   */
   autoRenewalStatus?: string;
-  /**
-   * @remarks
-   * The cluster ID.
-   * 
-   * @example
-   * amv-uf6485635fz8****
-   */
   DBClusterId?: string;
-  /**
-   * @remarks
-   * The region ID.
-   * 
-   * @example
-   * cn-shenzhen
-   */
   regionId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -119,10 +67,6 @@ export class DescribeAutoRenewalAttributeResponseBodyItems extends $dara.Model {
 }
 
 export class DescribeAutoRenewalAttributeResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * The list of auto-renewal details.
-   */
   items?: DescribeAutoRenewalAttributeResponseBodyItems;
   /**
    * @remarks

package/src/models/DescribeAvailableAdvicesRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAvailableAdvicesRequest extends $dara.Model {
   /**
    * @remarks
-   * The date when the suggestion is generated. Specify the date in the yyyyMMdd format.
+   * The date when the advice was generated, in the `yyyyMMdd` format.
    * 
-   * >  Suggestions are generated after analysis after midnight every day. You must specify a date that is at least one day earlier than the current date. For example, if the current date is 20240627, you must specify 20240626 or an earlier date.
+   * > Advice is generated daily. To query for advice, specify a date at least one day before the current date. For example, if you query on June 27, 2024, set this parameter to `20240626` or an earlier date.
    * 
    * @example
    * 20221124
@@ -15,10 +15,11 @@ export class DescribeAvailableAdvicesRequest extends $dara.Model {
   adviceDate?: number;
   /**
    * @remarks
-   * The type of the suggestion. Valid values:
+   * The type of advice. Valid values:
    * 
-   * *   **INDEX**: index optimization.
-   * *   **TIERING**: hot and cold data optimization.
+   * - **INDEX**: index optimization.
+   * 
+   * - **TIERING**: hot and cold data tiering.
    * 
    * @example
    * INDEX
@@ -36,7 +37,7 @@ export class DescribeAvailableAdvicesRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The keyword that is used to query information by table name.
+   * The keyword for a fuzzy search on table names.
    * 
    * @example
    * you_table_name
@@ -44,12 +45,15 @@ export class DescribeAvailableAdvicesRequest extends $dara.Model {
   keyword?: string;
   /**
    * @remarks
-   * The display language of suggestions. Valid values:
+   * The display language for the advice. Valid values:
+   * 
+   * - **zh**: Simplified Chinese (default).
+   * 
+   * - **en**: English.
    * 
-   * *   **zh** (default): simplified Chinese.
-   * *   **en**: English.
-   * *   **ja**: Japanese.
-   * *   **zh-tw**: traditional Chinese.
+   * - **ja**: Japanese.
+   * 
+   * - **zh-tw**: Traditional Chinese.
    * 
    * @example
    * zh
@@ -57,20 +61,23 @@ export class DescribeAvailableAdvicesRequest extends $dara.Model {
   lang?: string;
   /**
    * @remarks
-   * The order by which to sort query results. Specify the parameter value in the JSON format. Example: `[{"Field":"SchemaName","Type":"Asc"}]`.
+   * Specifies the sort order for the results. The value is a JSON string. Example: `[{"Field":"SchemaName","Type":"Asc"}]`. The JSON string contains the following key-value pairs:
+   * 
+   * - `Field`: the field to sort by. Valid values:
    * 
-   * *   `Field` specifies the field by which to sort the query results. Valid values:
+   *   - `SchemaName`: the database name.
    * 
-   *     *   `SchemaName`: the name of the database.
-   *     *   `TableName`: the name of the table.
-   *     *   `Benefit`: the expected benefits of the applied optimization suggestion.
+   *   - `TableName`: the table name.
    * 
-   * *   `Type` specifies the sorting order. Valid values:
+   *   - `Benefit`: the expected benefit.
    * 
-   *     *   `Asc`: ascending order.
-   *     *   `Desc`: descending order.
+   * - `Type`: the sort order. Valid values:
    * 
-   * >  If you do not specify this parameter, the query results are sorted in descending order based on the Benefit field.
+   *   - `Asc`: ascending order.
+   * 
+   *   - `Desc`: descending order.
+   * 
+   * > By default, results are sorted by expected benefit in descending order.
    * 
    * @example
    * [{\\"Field\\":\\"AdviceType\\",\\"Type\\":\\"Desc\\"}]
@@ -78,7 +85,7 @@ export class DescribeAvailableAdvicesRequest extends $dara.Model {
   order?: string;
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: 1.
+   * The page number. The value must be an integer that is greater than 0. Default value: 1.
    * 
    * @example
    * 1
@@ -88,9 +95,11 @@ export class DescribeAvailableAdvicesRequest extends $dara.Model {
    * @remarks
    * The number of entries per page. Valid values:
    * 
-   * *   **30** (default)
-   * *   **50**
-   * *   **100**
+   * - **30** (default)
+   * 
+   * - **50**
+   * 
+   * - **100**
    * 
    * @example
    * 30
@@ -108,7 +117,7 @@ export class DescribeAvailableAdvicesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the table in the DatabaseName.TableName format.
+   * A concatenation of the database name and the table name.
    * 
    * @example
    * tpch.lineitem

package/src/models/DescribeAvailableAdvicesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The date when the suggestion is generated. The date is in the yyyyMMdd format.
+   * The date when the advice was generated. The date is displayed in the yyyyMMdd format.
    * 
    * @example
    * 20221124
@@ -13,7 +13,7 @@ export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
   adviceDate?: string;
   /**
    * @remarks
-   * The suggestion ID.
+   * The advice ID.
    * 
    * @example
    * dcd04135-0925-4aed-a5a7-e7d92cb1****
@@ -21,10 +21,11 @@ export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
   adviceId?: string;
   /**
    * @remarks
-   * The type of the suggestion. Valid values:
+   * The type of the advice. Valid values:
    * 
-   * *   **INDEX**: index optimization.
-   * *   **TIERING**: hot and cold data optimization.
+   * - **INDEX**: index optimization.
+   * 
+   * - **TIERING**: hot and cold data optimization.
    * 
    * @example
    * INDEX
@@ -32,16 +33,23 @@ export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
   adviceType?: string;
   /**
    * @remarks
-   * The benefit of the suggestion.
+   * The benefits of the advice.
    * 
    * @example
-   * 0.4 GB of storage saved
+   * 节省0.4 GB的存储空间。
    */
   benefit?: string;
+  /**
+   * @remarks
+   * The index fields.
+   * 
+   * @example
+   * message
+   */
   indexFields?: string;
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: 1.
+   * The page number. The value is greater than 0 and less than or equal to the maximum value of the integer data type. Default value: 1.
    * 
    * @example
    * 1
@@ -49,11 +57,13 @@ export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values:
+   * The number of entries to return on each page. Valid values:
+   * 
+   * - **30** (default)
+   * 
+   * - **50**
    * 
-   * *   **30** (default)
-   * *   **50**
-   * *   **100**
+   * - **100**
    * 
    * @example
    * 30
@@ -61,15 +71,15 @@ export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The reason why the suggestion was generated.
+   * The reason why the optimization advice is generated.
    * 
    * @example
-   * Unused for 15 days, historical usage less than 1%
+   * 15天未使用，历史使用统计概率小于1%
    */
   reason?: string;
   /**
    * @remarks
-   * The SQL statement that is used to apply the suggestion.
+   * The SQL statement that is used to apply the advice.
    * 
    * @example
    * alter table `schema1`.`table1` drop key col1_1_idx
@@ -77,7 +87,7 @@ export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
   SQL?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * adb_demo
@@ -85,7 +95,7 @@ export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
   schemaName?: string;
   /**
    * @remarks
-   * The name of the table.
+   * The table name.
    * 
    * @example
    * test_table
@@ -93,7 +103,7 @@ export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
   tableName?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries returned. The value is greater than or equal to 0 and less than or equal to the maximum value of the integer data type. Default value: 0.
    * 
    * @example
    * 10192
@@ -145,12 +155,12 @@ export class DescribeAvailableAdvicesResponseBodyItems extends $dara.Model {
 export class DescribeAvailableAdvicesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The queried suggestions.
+   * The optimization advice items.
    */
   items?: DescribeAvailableAdvicesResponseBodyItems[];
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: 1.
+   * The page number. The value is greater than 0 and less than or equal to the maximum value of the integer data type. Default value: 1.
    * 
    * @example
    * 1
@@ -158,11 +168,13 @@ export class DescribeAvailableAdvicesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values:
+   * The number of entries to return on each page. Valid values:
+   * 
+   * - **30** (default)
+   * 
+   * - **50**
    * 
-   * *   **30** (default)
-   * *   **50**
-   * *   **100**
+   * - **100**
    * 
    * @example
    * 30
@@ -178,12 +190,12 @@ export class DescribeAvailableAdvicesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The name of the table in the DatabaseName.TableName format.
+   * The names of databases and tables.
    */
   schemaTableNames?: string[];
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries returned. The value is greater than or equal to 0 and less than or equal to the maximum value of the integer data type. Default value: 0.
    * 
    * @example
    * 10192

package/src/models/DescribeBackupPolicyRequest.ts

@@ -7,7 +7,7 @@ export class DescribeBackupPolicyRequest 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.
+   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to view the details of all AnalyticDB for MySQL clusters in the destination region, including the cluster ID.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeBackupPolicyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBackupPolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The number of days for which data backup files are retained.
+   * The number of days to retain data backups.
    * 
    * @example
    * 7
@@ -13,10 +13,11 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   backupRetentionPeriod?: number;
   /**
    * @remarks
-   * Indicates whether log backup is enabled. Valid values:
+   * Indicates whether real-time log backup is enabled. Valid values:
    * 
-   * *   **Enable**
-   * *   **Disable**
+   * - **Enable**: enabled.
+   * 
+   * - **Disable**: disabled.
    * 
    * @example
    * true
@@ -24,7 +25,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   enableBackupLog?: string;
   /**
    * @remarks
-   * The number of days for which the log backup files are retained.
+   * The number of days to retain log backups.
    * 
    * @example
    * 7
@@ -32,15 +33,21 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   logBackupRetentionPeriod?: number;
   /**
    * @remarks
-   * The cycle based on which backups are performed. If more than one day of the week is specified, the days of the week are separated by commas (,). Valid value:
+   * The data backup cycle. Separate multiple values with commas (,). Valid values:
+   * 
+   * - Monday
+   * 
+   * - Tuesday
+   * 
+   * - Wednesday
+   * 
+   * - Thursday
+   * 
+   * - Friday
+   * 
+   * - Saturday
    * 
-   * *   Monday
-   * *   Tuesday
-   * *   Wednesday
-   * *   Thursday
-   * *   Friday
-   * *   Saturday
-   * *   Sunday
+   * - Sunday
    * 
    * @example
    * Wednesday,Saturday
@@ -48,7 +55,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   preferredBackupPeriod?: string;
   /**
    * @remarks
-   * The data backup time. The time is in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.
+   * The data backup time. The time is in the HH:mmZ-HH:mmZ format.
    * 
    * @example
    * 15:00Z-16:00Z

package/src/models/DescribeBackupsRequest.ts

@@ -13,9 +13,10 @@ export class DescribeBackupsRequest extends $dara.Model {
   backupId?: string;
   /**
    * @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 Data Lakehouse Edition clusters within a region.
+   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all clusters in a specific region.
    * 
    * This parameter is required.
    * 
@@ -25,7 +26,7 @@ export class DescribeBackupsRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time.
+   * The end of the time range to query. The end time must be later than the start time. Specify the time in the \\`yyyy-MM-ddTHH:mmZ\\` format.
    * 
    * This parameter is required.
    * 
@@ -37,7 +38,7 @@ export class DescribeBackupsRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The page number. Pages start from page 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
@@ -45,11 +46,13 @@ export class DescribeBackupsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values:
+   * The number of entries to return on each page. Valid values:
    * 
-   * *   30
-   * *   50
-   * *   100
+   * - 30
+   * 
+   * - 50
+   * 
+   * - 100
    * 
    * Default value: 30.
    * 
@@ -57,12 +60,19 @@ export class DescribeBackupsRequest extends $dara.Model {
    * 30
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * Specifies whether to query only cross-region backups. Set the value to true to query only cross-region backups. Set the value to false to query only local backups.
+   * 
+   * @example
+   * false
+   */
   remote?: boolean;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.
+   * The beginning of the time range to query. Specify the time in the \\`yyyy-MM-ddTHH:mmZ\\` format.
    * 
    * This parameter is required.
    *