@alicloud/adb20211201 4.7.1 → 5.0.1

package/src/models/DescribeAllDataSourceResponseBody.ts

@@ -3,67 +3,12 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeAllDataSourceResponseBodyColumnsColumn extends $dara.Model {
-  /**
-   * @remarks
-   * Indicates whether the column is an auto-increment column. Valid values:
-   * 
-   * *   **true**
-   * *   **false**
-   * 
-   * @example
-   * true
-   */
   autoIncrementColumn?: boolean;
-  /**
-   * @remarks
-   * The name of the column.
-   * 
-   * @example
-   * id
-   */
   columnName?: string;
-  /**
-   * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
-   * 
-   * @example
-   * amv-bp1pke2pcfavw****
-   */
   DBClusterId?: string;
-  /**
-   * @remarks
-   * Indicates whether the column is the primary key of the table. Valid values:
-   * 
-   * *   **true**
-   * *   **false**
-   * 
-   * @example
-   * false
-   */
   primaryKey?: boolean;
-  /**
-   * @remarks
-   * The logical name of the database.
-   * 
-   * @example
-   * adb_demo
-   */
   schemaName?: string;
-  /**
-   * @remarks
-   * The logical name of the table.
-   * 
-   * @example
-   * test
-   */
   tableName?: string;
-  /**
-   * @remarks
-   * The data type of the column.
-   * 
-   * @example
-   * bigint
-   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -125,21 +70,7 @@ export class DescribeAllDataSourceResponseBodyColumns extends $dara.Model {
 }
 
 export class DescribeAllDataSourceResponseBodySchemasSchema extends $dara.Model {
-  /**
-   * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
-   * 
-   * @example
-   * amv-bp1pke2pcfavw****
-   */
   DBClusterId?: string;
-  /**
-   * @remarks
-   * The logical name of the database.
-   * 
-   * @example
-   * adb_demo
-   */
   schemaName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -191,29 +122,8 @@ export class DescribeAllDataSourceResponseBodySchemas extends $dara.Model {
 }
 
 export class DescribeAllDataSourceResponseBodyTablesTable extends $dara.Model {
-  /**
-   * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
-   * 
-   * @example
-   * amv-bp1pke2pcfavw****
-   */
   DBClusterId?: string;
-  /**
-   * @remarks
-   * The name of the database.
-   * 
-   * @example
-   * adb_demo
-   */
   schemaName?: string;
-  /**
-   * @remarks
-   * The logical name of the table.
-   * 
-   * @example
-   * test
-   */
   tableName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -267,10 +177,6 @@ export class DescribeAllDataSourceResponseBodyTables extends $dara.Model {
 }
 
 export class DescribeAllDataSourceResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * The queried columns.
-   */
   columns?: DescribeAllDataSourceResponseBodyColumns;
   /**
    * @remarks
@@ -280,15 +186,7 @@ export class DescribeAllDataSourceResponseBody extends $dara.Model {
    * C7EDB8E4-9769-4233-88C7-DCA4C9******
    */
   requestId?: string;
-  /**
-   * @remarks
-   * The queried databases.
-   */
   schemas?: DescribeAllDataSourceResponseBodySchemas;
-  /**
-   * @remarks
-   * The queried tables.
-   */
   tables?: DescribeAllDataSourceResponseBodyTables;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeAppliedAdvicesRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAppliedAdvicesRequest extends $dara.Model {
   /**
    * @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/cold data optimization
    * 
    * @example
    * INDEX
@@ -26,7 +27,7 @@ export class DescribeAppliedAdvicesRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The end date of the time range to query. Specify the date in the yyyyMMdd format.
+   * The end date of the query. The date is in the `yyyyMMdd` format.
    * 
    * @example
    * 20220824
@@ -34,7 +35,7 @@ export class DescribeAppliedAdvicesRequest extends $dara.Model {
   endTime?: number;
   /**
    * @remarks
-   * The keyword that is used to query information by table name.
+   * The keyword for the query. Fuzzy match by table name is supported.
    * 
    * @example
    * you_table_name
@@ -42,12 +43,15 @@ export class DescribeAppliedAdvicesRequest extends $dara.Model {
   keyword?: string;
   /**
    * @remarks
-   * The display language of the suggestion. Valid values:
+   * The language of the query results. Valid values:
+   * 
+   * - **zh** (default): Chinese
+   * 
+   * - **en**: English
    * 
-   * *   **zh** (default): simplified Chinese.
-   * *   **en**: English.
-   * *   **ja**: Japanese.
-   * *   **zh-tw**: traditional Chinese.
+   * - **ja**: Japanese
+   * 
+   * - **zh-tw**: Traditional Chinese
    * 
    * @example
    * zh
@@ -55,22 +59,27 @@ export class DescribeAppliedAdvicesRequest 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"}]`.
+   * The order by which to sort the query results. The value is a JSON string. Example: `[{"Field":"SchemaName","Type":"Asc"}]`. Fields:
+   * 
+   * - `Field`: The field by which to sort the results. Valid values:
+   * 
+   *   - `SchemaName`: the database name
    * 
-   * *   `Field` specifies the field by which to sort the query results. Valid values:
+   *   - `TableName`: the table name
    * 
-   *     *   `SchemaName`: the name of the database.
-   *     *   `TableName`: the name of the table.
-   *     *   `JobStatus`: the status of the BUILD job that is triggered on the table.
-   *     *   `SubmitTime`: the time when the suggestion was submitted.
-   *     *   `Benefit`: the expected benefits of the applied optimization suggestion.
+   *   - `JobStatus`: the status of the build job for the table
    * 
-   * *   `Type` specifies the sorting order. Valid values:
+   *   - `SubmitTime`: the time when the advice was submitted
    * 
-   *     *   `Asc`: ascending order.
-   *     *   `Desc`: descending order.
+   *   - `Benefit`: the estimated benefit
    * 
-   * >  If you do not specify this parameter, optimization suggestions are sorted in descending order based on the submission time.
+   * - `Type`: The sort order. Valid values:
+   * 
+   *   - `Asc`: ascending
+   * 
+   *   - `Desc`: descending
+   * 
+   * > If you do not set this parameter, the query results are sorted by advice submission time in descending order.
    * 
    * @example
    * [{\\"Field\\":\\"AdviceType\\",\\"Type\\":\\"Desc\\"}]
@@ -78,7 +87,7 @@ export class DescribeAppliedAdvicesRequest 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
@@ -86,11 +95,13 @@ export class DescribeAppliedAdvicesRequest 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
@@ -108,7 +119,7 @@ export class DescribeAppliedAdvicesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the table in the **DatabaseName.TableName** format.
+   * The name of the database and table. Format: **database.table**.
    * 
    * @example
    * tpch.lineitem
@@ -116,7 +127,7 @@ export class DescribeAppliedAdvicesRequest extends $dara.Model {
   schemaTableName?: string;
   /**
    * @remarks
-   * The start date of the time range to query. Specify the date in the yyyyMMdd format.
+   * The start date of the query. The date is in the `yyyyMMdd` format.
    * 
    * @example
    * 20220811

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