@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/DescribeAppliedAdvicesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The suggestion ID.
+   * The advice ID.
    * 
    * @example
    * 7417db9c-914d-43f3-a123-4d0e448f****
@@ -13,27 +13,35 @@ export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   adviceId?: string;
   /**
    * @remarks
-   * The benefit of the suggestion.
+   * The benefit of the advice.
    * 
    * @example
-   * 0.4 GB of storage saved
+   * 节省0.4 GB的存储空间
    */
   benefit?: string;
   /**
    * @remarks
-   * The SQL statement that is used to execute the BUILD job.
+   * The SQL statement of the build task.
    * 
    * @example
    * build table `schema1`.`table1`
    */
   buildSQL?: string;
+  /**
+   * @remarks
+   * The index fields.
+   * 
+   * @example
+   * message
+   */
   indexFields?: string;
   /**
    * @remarks
-   * The status of the suggestion execution job. Valid values:
+   * The status of the task that is used to apply the advice. Valid values:
+   * 
+   * - **SUCCEED**: The task is successful.
    * 
-   * *   **SUCCEED**
-   * *   **FAILED**
+   * - **FAILED**: The task has failed.
    * 
    * @example
    * SUCCEED
@@ -41,7 +49,7 @@ export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   jobStatus?: string;
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: 1.
+   * The page number of the returned page. The value must be an integer that is greater than 0. Default value: 1.
    * 
    * @example
    * 1
@@ -49,11 +57,13 @@ export class DescribeAppliedAdvicesResponseBodyItems 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**
-   * *   **100**
+   * - **30** (Default)
+   * 
+   * - **50**
+   * 
+   * - **100**
    * 
    * @example
    * 30
@@ -61,7 +71,7 @@ export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The SQL statement that is used to roll back the suggestion.
+   * The SQL statement that is used to roll back the advice.
    * 
    * @example
    * alter table `schema1`.`table1` add key col1_1_idx(col1)
@@ -69,7 +79,7 @@ export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   rollbackSQL?: 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 DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   SQL?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * adb_demo
@@ -85,10 +95,11 @@ export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   schemaName?: string;
   /**
    * @remarks
-   * The submission status of the suggestion. Valid values:
+   * The submission status of the advice. Valid values:
+   * 
+   * - **SUCCEED**: The advice is submitted.
    * 
-   * *   **SUCCEED**
-   * *   **FAILED**
+   * - **FAILED**: The advice fails to be submitted.
    * 
    * @example
    * SUCCEED
@@ -96,7 +107,7 @@ export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   submitStatus?: string;
   /**
    * @remarks
-   * The time when the suggestion was submitted. The time follows the ISO 8601 standard in the yyMMddHHmm format. The time is displayed in UTC.
+   * The time when the advice was submitted. The time is in the `yyMMddHHmm` format. The time is displayed in UTC.
    * 
    * @example
    * 2208131600
@@ -104,7 +115,7 @@ export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   submitTime?: string;
   /**
    * @remarks
-   * The name of the table.
+   * The table name.
    * 
    * @example
    * test
@@ -112,7 +123,7 @@ export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
   tableName?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries returned. The value must be an integer that is greater than or equal to 0. Default value: 0.
    * 
    * @example
    * 1
@@ -168,12 +179,12 @@ export class DescribeAppliedAdvicesResponseBodyItems extends $dara.Model {
 export class DescribeAppliedAdvicesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The queried applied optimization suggestions.
+   * Details.
    */
   items?: DescribeAppliedAdvicesResponseBodyItems[];
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: 1.
+   * The page number of the returned page. The value must be an integer that is greater than 0. Default value: 1.
    * 
    * @example
    * 1
@@ -181,11 +192,13 @@ export class DescribeAppliedAdvicesResponseBody 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
@@ -201,12 +214,12 @@ export class DescribeAppliedAdvicesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The name of the table in the DatabaseName.TableName format.
+   * The concatenated strings of database and table names.
    */
   schemaTableNames?: string[];
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries returned. The value must be an integer that is greater than or equal to 0. Default value: 0.
    * 
    * @example
    * 1

package/src/models/DescribeApsActionLogsRequest.ts

@@ -24,7 +24,7 @@ export class DescribeApsActionLogsRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * 2023-02-11T09:30:00Z
+   * 2023-02-11T09:30Z
    */
   endTime?: string;
   /**
@@ -92,7 +92,7 @@ export class DescribeApsActionLogsRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * 2023-02-11T08:30:00Z
+   * 2023-02-11T08:30Z
    */
   startTime?: string;
   /**

package/src/models/DescribeApsJobsResponseBody.ts

@@ -56,7 +56,7 @@ export class DescribeApsJobsResponseBodyAPSJobs extends $dara.Model {
    * The progress.
    * 
    * @example
-   * 30: The progress is 30%.
+   * 30: progress 30%
    */
   projress?: string;
   /**

package/src/models/DescribeApsResourceGroupsRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeApsResourceGroupsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.
+   * The ID of the Data Lakehouse Edition cluster.
    * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/612397.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters within a region.
+   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/612397.html) operation to view the cluster ID.
    * 
    * This parameter is required.
    * 
@@ -19,7 +19,7 @@ export class DescribeApsResourceGroupsRequest extends $dara.Model {
    * @remarks
    * The region ID.
    * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the most recent region list.
+   * > Call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to view the region ID of a cluster.
    * 
    * @example
    * cn-hangzhou
@@ -27,7 +27,7 @@ export class DescribeApsResourceGroupsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the data synchronization job.
+   * The ID of the data synchronization task.
    * 
    * @example
    * aps-hz1686v37sx****

package/src/models/DescribeApsResourceGroupsResponseBody.ts

@@ -7,13 +7,18 @@ export class DescribeApsResourceGroupsResponseBodyDataResourceGroups extends $da
    * @remarks
    * Indicates whether the resource group is available. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **True**
+   * 
+   * - **False**
    * 
    * @example
    * True
    */
   available?: boolean;
+  /**
+   * @remarks
+   * The resource gradient values.
+   */
   cuOptions?: number[];
   /**
    * @remarks
@@ -27,10 +32,11 @@ export class DescribeApsResourceGroupsResponseBodyDataResourceGroups extends $da
    * @remarks
    * The type of the resource group. Valid values:
    * 
-   * *   **Interactive**
-   * *   **Job**
+   * - **Interactive**
+   * 
+   * - **Job**
    * 
-   * >  For more information about resource groups, see [Resource groups](https://help.aliyun.com/document_detail/428610.html).
+   * > For more information about resource groups in Data Lakehouse Edition, see [Resource groups](https://help.aliyun.com/document_detail/428610.html).
    * 
    * @example
    * Job
@@ -38,7 +44,7 @@ export class DescribeApsResourceGroupsResponseBodyDataResourceGroups extends $da
   groupType?: string;
   /**
    * @remarks
-   * The amount of remaining computing resources. Unit: ACUs.
+   * The remaining computing resources, in ACU.
    * 
    * @example
    * 512
@@ -46,10 +52,11 @@ export class DescribeApsResourceGroupsResponseBodyDataResourceGroups extends $da
   leftComputeResource?: number;
   /**
    * @remarks
-   * The maximum amount of reserved computing resources. Unit: ACUs.
+   * The maximum reserved computing resources, in ACU.
    * 
-   * *   If the value of GroupType is **Interactive**, the amount of reserved computing resources that are not allocated in the cluster is returned in increments of 16 ACUs.
-   * *   If the value of GroupType is **Job**, the amount of reserved computing resources that are not allocated in the cluster is returned in increments of 8 ACUs.
+   * - If GroupType is **Interactive**, the maximum reserved computing resources are the current unallocated resources of the cluster, and the step size is 16 ACU.
+   * 
+   * - If GroupType is **Job**, the maximum reserved computing resources are the current unallocated resources of the cluster, and the step size is 8 ACU.
    * 
    * @example
    * 512
@@ -57,10 +64,11 @@ export class DescribeApsResourceGroupsResponseBodyDataResourceGroups extends $da
   maxComputeResource?: number;
   /**
    * @remarks
-   * The minimum amount of reserved computing resources. Unit: ACUs.
+   * The minimum reserved computing resources, in ACU.
+   * 
+   * - If GroupType is **Interactive**, the minimum reserved computing resources are 16 ACU.
    * 
-   * *   If the value of GroupType is **Interactive**, 16 is returned.
-   * *   If the value of GroupType is **Job**, 0 is returned.
+   * - If GroupType is **Job**, the minimum reserved computing resources are 0 ACU.
    * 
    * @example
    * 0
@@ -105,15 +113,16 @@ export class DescribeApsResourceGroupsResponseBodyDataResourceGroups extends $da
 export class DescribeApsResourceGroupsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The queried resource groups.
+   * The resource groups.
    */
   resourceGroups?: DescribeApsResourceGroupsResponseBodyDataResourceGroups[];
   /**
    * @remarks
-   * The step size of resources. Unit: AnalyticDB compute units (ACUs).
+   * The step size of the resource group, in ACU.
+   * 
+   * - If GroupType is **Interactive**, the step size is 16 ACU.
    * 
-   * *   If the value of GroupType is **Interactive**, 16 is returned.
-   * *   If the value of GroupType is **Job**, 8 is returned.
+   * - If GroupType is **Job**, the step size is 8 ACU.
    * 
    * @example
    * 8
@@ -148,7 +157,7 @@ export class DescribeApsResourceGroupsResponseBodyData extends $dara.Model {
 export class DescribeApsResourceGroupsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The queried resource groups.
+   * The information about the resource groups.
    */
   data?: DescribeApsResourceGroupsResponseBodyData;
   /**
@@ -161,10 +170,11 @@ export class DescribeApsResourceGroupsResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The returned message.
+   * Additional information about the call. Valid values:
    * 
-   * *   If the request was successful, a success message is returned.
-   * *   If the request failed, an error message is returned.
+   * - Success is returned if the request is successful.
+   * 
+   * - An error code is returned if the request fails.
    * 
    * @example
    * Success
@@ -182,8 +192,9 @@ export class DescribeApsResourceGroupsResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **True**
+   * 
+   * - **False**
    * 
    * @example
    * True

package/src/models/DescribeAuditLogRecordsRequest.ts

@@ -5,9 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAuditLogRecordsRequest 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.
    * 
-   * > 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.
+   * > 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.
    * 
@@ -25,13 +26,11 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   DBName?: 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 of the time range to query. The time must be in UTC and in the `yyyy-MM-ddTHH:mmZ` format.
    * 
-   * > 
-   * 
-   * *   The end time must be later than the start time.
-   * 
-   * *   The maximum time range that can be specified is 24 hours.
+   * > - The end time must be later than the start time.
+   * >
+   * > - The time range cannot exceed 24 hours.
    * 
    * @example
    * 2022-08-12T17:08Z
@@ -39,7 +38,7 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The IP address and port number of the client that is used to execute the SQL statement.
+   * The client IP address and port number.
    * 
    * @example
    * 100.104.XX.XX:43908
@@ -47,26 +46,37 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   hostAddress?: string;
   /**
    * @remarks
-   * The order in which to sort the retrieved entries by field. Specify this parameter in the JSON format. The value is an ordered array that uses the order of the input array and contains `Field` and `Type`. Example: `[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]`. Fields:
+   * Specifies the fields for sorting the results. The value is a JSON string that is an array of objects. The order of objects in the array defines the sort priority. Each object contains the`Field` and`Type` parameters. Example: `[{"Field":"ExecutionStartTime","Type":"Desc"},{"Field":"ScanRows","Type":"Asc"}]`.
+   * 
+   * - `Field`: the field by which to sort the results. Valid values:
+   * 
+   *   - **HostAddress**: the client IP address.
+   * 
+   *   - **UserName**: the username.
+   * 
+   *   - **ExecutionStartTime**: the execution start time of the SQL statement.
+   * 
+   *   - **QueryTime**: the execution duration.
+   * 
+   *   - **PeakMemoryUsage**: the peak memory usage of the SQL statement.
+   * 
+   *   - **ScanRows**: the number of rows scanned by a task that involves a data source.
+   * 
+   *   - **ScanSize**: the amount of data scanned.
+   * 
+   *   - **ScanTime**: the time taken for the data scan.
+   * 
+   *   - **PlanningTime**: the time taken to generate the execution plan.
    * 
-   * *   `Field`: the field that is used to sort the retrieved entries. Valid values:
+   *   - **WallTime**: the total CPU time of all operators on all nodes.
    * 
-   *     *   **HostAddress**: the IP address of the client that is used to connect to the database.
-   *     *   **UserName**: the username.
-   *     *   **ExecutionStartTime**: the start time of the query execution.
-   *     *   **QueryTime**: the amount of time consumed to execute the SQL statement.
-   *     *   **PeakMemoryUsage**: the maximum memory usage when the SQL statement is executed.
-   *     *   **ScanRows**: the number of rows to be scanned from a data source in the task.
-   *     *   **ScanSize**: the amount of data to be scanned.
-   *     *   **ScanTime**: the total amount of time consumed to scan data.
-   *     *   **PlanningTime**: the amount of time consumed to generate execution plans.
-   *     *   **WallTime**: the accumulated CPU Time values of all operators in the query on each node.
-   *     *   **ProcessID**: the process ID.
+   *   - **ProcessID**: the process ID.
    * 
-   * *   `Type`: the sorting type of the retrieved entries. Valid values:
+   * - `Type`: the sort order. Valid values:
    * 
-   *     *   **Desc**: descending order.
-   *     *   **Asc**: ascending order.
+   *   - **Desc**: descending order.
+   * 
+   *   - **Asc**: ascending order.
    * 
    * @example
    * [{"Field":"ExecuteTime","Type":"Desc"},{"Field":"HostAddress","Type":"Asc"}]
@@ -74,10 +84,11 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   order?: string;
   /**
    * @remarks
-   * The sorting order of the retrieved entries. Valid values:
+   * The sort order for the results based on execution time. Valid values:
+   * 
+   * - **asc**: ascending order.
    * 
-   * *   **asc**: sorts the retrieved entries by time in ascending order.
-   * *   **desc**: sorts the retrieved entries by time in descending order.
+   * - **desc**: descending order.
    * 
    * @example
    * asc
@@ -87,7 +98,7 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @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
@@ -95,12 +106,15 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values:
+   * The page size. Valid values:
+   * 
+   * - **10** (default)
    * 
-   * *   **10** (default)
-   * *   **30**
-   * *   **50**
-   * *   **100**
+   * - **30**
+   * 
+   * - **50**
+   * 
+   * - **100**
    * 
    * @example
    * 10
@@ -111,12 +125,12 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
    * A reserved parameter.
    * 
    * @example
-   * none
+   * 无
    */
   proxyUser?: string;
   /**
    * @remarks
-   * The keyword based on which audit logs are queried. You can set this parameter to a value of the STRING type.
+   * A keyword used to perform a fuzzy search on the returned results.
    * 
    * @example
    * adb
@@ -124,9 +138,9 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   queryKeyword?: string;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID.
    * 
-   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the most recent region list.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query available regions.
    * 
    * This parameter is required.
    * 
@@ -140,15 +154,21 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
    * @remarks
    * The type of the SQL statement. Valid values:
    * 
-   * *   **DELETE**
-   * *   **SELECT**
-   * *   **UPDATE**
-   * *   **INSERT INTO SELECT**
-   * *   **ALTER**
-   * *   **DROP**
-   * *   **CREATE**
+   * - **DELETE**
+   * 
+   * - **SELECT**
    * 
-   * >  You can query only a single type of SQL statements at a time. If you leave this parameter empty, all types of SQL statements are queried.
+   * - **UPDATE**
+   * 
+   * - **INSERT INTO SELECT**
+   * 
+   * - **ALTER**
+   * 
+   * - **DROP**
+   * 
+   * - **CREATE**
+   * 
+   * > You can specify only one type per request. If this parameter is not specified, all types are queried by default.
    * 
    * @example
    * SELECT
@@ -156,9 +176,9 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   sqlType?: string;
   /**
    * @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 start of the time range to query. The time must be in UTC and in the `yyyy-MM-ddTHH:mmZ` format.
    * 
-   * > SQL audit logs can be queried only when SQL audit is enabled. Only SQL audit logs within the last 30 days can be queried. If SQL audit was disabled and re-enabled, only SQL audit logs from the time when SQL audit was re-enabled can be queried.
+   * > You can query SQL audit logs only when this feature is enabled. Logs are available for the last 30 days. If you disable and then re-enable SQL audit, only logs generated after the feature was re-enabled are returned.
    * 
    * @example
    * 2022-08-12T04:17Z
@@ -166,10 +186,11 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * Specifies whether the execution of the SQL statement succeeds. Valid values:
+   * Indicates whether the SQL statement was successfully executed. Valid values:
+   * 
+   * - **true**: The SQL statement succeeded.
    * 
-   * *   **true**
-   * *   **false**
+   * - **false**: The SQL statement failed.
    * 
    * @example
    * true
@@ -177,7 +198,7 @@ export class DescribeAuditLogRecordsRequest extends $dara.Model {
   succeed?: string;
   /**
    * @remarks
-   * The username that is used to execute the SQL statement.
+   * The username that executed the SQL statement.
    * 
    * @example
    * test