@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/DescribeAccountPrivilegesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAccountPrivilegesRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the database account.
+   * The name of the database account whose privileges you want to query.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DescribeAccountPrivilegesRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * The columns that you want to query. You can use this parameter to query the permissions of the database account on specific columns. This parameter is available only if the PrivilegeType parameter is set to Column.
+   * Filters the results by column name. This parameter is used only when `PrivilegeType` is set to `Column`.
    * 
    * @example
    * col1
@@ -23,7 +23,8 @@ export class DescribeAccountPrivilegesRequest extends $dara.Model {
   columnPrivilegeObject?: string;
   /**
    * @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 Lakehouse Edition cluster.
+   * <props="intl">The ID of the Lakehouse Edition cluster.
    * 
    * This parameter is required.
    * 
@@ -33,7 +34,7 @@ export class DescribeAccountPrivilegesRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The databases that you want to query. You can use this parameter to query the permissions of the database account on specific databases. This parameter is available only if the PrivilegeType parameter is set to Database, Table, or Column.
+   * Filters the results by database name. This parameter is used only when `PrivilegeType` is set to `Database`, `Table`, or `Column`.
    * 
    * @example
    * db1
@@ -41,7 +42,7 @@ export class DescribeAccountPrivilegesRequest extends $dara.Model {
   databasePrivilegeObject?: string;
   /**
    * @remarks
-   * The number of the page to return. Pages start from page 1. Default value: 1.
+   * The page number. Pages start at 1. Default value: 1.
    * 
    * @example
    * 1
@@ -49,7 +50,7 @@ export class DescribeAccountPrivilegesRequest extends $dara.Model {
   pageNumber?: string;
   /**
    * @remarks
-   * The number of entries to return on each page. Default value: 20.
+   * The number of entries per page. Default value: 20.
    * 
    * @example
    * 10
@@ -57,7 +58,7 @@ export class DescribeAccountPrivilegesRequest extends $dara.Model {
   pageSize?: string;
   /**
    * @remarks
-   * The permission level that you want to query. You can call the `DescribeEnabledPrivileges` operation to query the permission level of the database account.
+   * The privilege level to query. To obtain the valid values for this parameter, call the `DescribeEnabledPrivileges` operation.
    * 
    * @example
    * Global
@@ -65,7 +66,7 @@ export class DescribeAccountPrivilegesRequest extends $dara.Model {
   privilegeType?: string;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID.
    * 
    * This parameter is required.
    * 
@@ -75,7 +76,7 @@ export class DescribeAccountPrivilegesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The tables that you want to query. You can use this parameter to query the permissions of the database account on specific tables. This parameter can be used together with the DatabasePrivilegeObject parameter. This parameter is available only if the PrivilegeType parameter is set to Table or Column.
+   * Filters the results by table name. You can use this parameter with `DatabasePrivilegeObject` to refine the search. This parameter is used only when `PrivilegeType` is set to `Table` or `Column`.
    * 
    * @example
    * table1

package/src/models/DescribeAccountPrivilegesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAccountPrivilegesResponseBodyDataPrivilegeObject extends $dara.Model {
   /**
    * @remarks
-   * The name of the column.
+   * The column name.
    * 
    * @example
    * column1
@@ -13,7 +13,7 @@ export class DescribeAccountPrivilegesResponseBodyDataPrivilegeObject extends $d
   column?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * db1
@@ -21,7 +21,7 @@ export class DescribeAccountPrivilegesResponseBodyDataPrivilegeObject extends $d
   database?: string;
   /**
    * @remarks
-   * The description of the permission object.
+   * The description.
    * 
    * @example
    * a test column
@@ -29,7 +29,7 @@ export class DescribeAccountPrivilegesResponseBodyDataPrivilegeObject extends $d
   description?: string;
   /**
    * @remarks
-   * The name of the table.
+   * The table name.
    * 
    * @example
    * tabl1
@@ -65,12 +65,12 @@ export class DescribeAccountPrivilegesResponseBodyDataPrivilegeObject extends $d
 export class DescribeAccountPrivilegesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The objects on which the permission takes effect, including databases, tables, columns, and additional descriptions.
+   * The privilege object, which specifies the database, table, column, and description.
    */
   privilegeObject?: DescribeAccountPrivilegesResponseBodyDataPrivilegeObject;
   /**
    * @remarks
-   * The permission level of the permission. Valid values: `Global`, `Database`, `Table`, and `Column`. You can call the `DescribeEnabledPrivileges` parameter to query the permission level of a specific permission.
+   * The privilege level. Valid values: `Global`, `Database`, `Table`, and `Column`. The `DescribeEnabledPrivileges` API returns this value.
    * 
    * @example
    * Column
@@ -78,7 +78,7 @@ export class DescribeAccountPrivilegesResponseBodyData extends $dara.Model {
   privilegeType?: string;
   /**
    * @remarks
-   * The name of the permission. You can call the `DescribeEnabledPrivileges` operation to query the name of the permission.
+   * A list of privileges.
    */
   privileges?: string[];
   static names(): { [key: string]: string } {
@@ -115,12 +115,12 @@ export class DescribeAccountPrivilegesResponseBodyData extends $dara.Model {
 export class DescribeAccountPrivilegesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Details of the permissions.
+   * A list of privilege details.
    */
   data?: DescribeAccountPrivilegesResponseBodyData[];
   /**
    * @remarks
-   * The page number of the returned page.
+   * The page number. This value matches the `PageNumber` input parameter.
    * 
    * @example
    * 1
@@ -128,7 +128,7 @@ export class DescribeAccountPrivilegesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page. This value matches the `PageSize` input parameter.
    * 
    * @example
    * 20
@@ -136,7 +136,7 @@ export class DescribeAccountPrivilegesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * DA32480A-E3E5-1BE7-BA98-724551DC04C8
@@ -144,7 +144,7 @@ export class DescribeAccountPrivilegesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total count of privileges at the specified privilege level.
    * 
    * @example
    * 100

package/src/models/DescribeAccountsRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAccountsRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the database account.
+   * The database account.
    * 
-   * > If you do not specify this parameter, the information about all database accounts in the cluster is returned.
+   * > If you do not specify this parameter, information about all database accounts is returned.
    * 
    * @example
    * test_accout
@@ -15,7 +15,8 @@ export class DescribeAccountsRequest extends $dara.Model {
   accountName?: 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.
    * 
    * This parameter is required.
    * 
@@ -25,10 +26,11 @@ export class DescribeAccountsRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The database engine of the cluster. Valid values:
+   * The database engine. Valid values:
    * 
-   * *   **AnalyticDB** (default): the AnalyticDB for MySQL engine.
-   * *   **Clickhouse**: the wide table engine.
+   * - **AnalyticDB** (default): the AnalyticDB for MySQL engine
+   * 
+   * - **Clickhouse**: the LindormTable engine
    * 
    * @example
    * Clickhouse

package/src/models/DescribeAccountsResponseBody.ts

@@ -2,64 +2,39 @@
 import * as $dara from '@darabonba/typescript';
 
 
+export class DescribeAccountsResponseBodyAccountListDBAccountRamUserList extends $dara.Model {
+  ramUserList?: string[];
+  static names(): { [key: string]: string } {
+    return {
+      ramUserList: 'RamUserList',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ramUserList: { 'type': 'array', 'itemType': 'string' },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.ramUserList)) {
+      $dara.Model.validateArray(this.ramUserList);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class DescribeAccountsResponseBodyAccountListDBAccount extends $dara.Model {
-  /**
-   * @remarks
-   * The description of the database account.
-   * 
-   * @example
-   * test_accout_des
-   */
   accountDescription?: string;
-  /**
-   * @remarks
-   * The name of the database account.
-   * 
-   * @example
-   * test_accout
-   */
   accountName?: string;
-  /**
-   * @remarks
-   * The status of the database account. Valid values:
-   * 
-   * *   **Creating**
-   * *   **Available**
-   * *   **Deleting**
-   * 
-   * @example
-   * Available
-   */
   accountStatus?: string;
-  /**
-   * @remarks
-   * The type of the database account. Valid values:
-   * 
-   * *   **Normal**: standard account.
-   * *   **Super**: privileged account.
-   * 
-   * @example
-   * Normal
-   */
   accountType?: string;
-  /**
-   * @remarks
-   * The database engine of the cluster. Valid values:
-   * 
-   * *   **AnalyticDB**: the AnalyticDB for MySQL engine.
-   * *   **Clickhouse**: the wide table engine.
-   * 
-   * @example
-   * Clickhouse
-   */
   engine?: string;
-  /**
-   * @remarks
-   * The ID of the Resource Access Management (RAM) user.
-   * 
-   * @example
-   * 1958134230****
-   */
+  ramUserList?: DescribeAccountsResponseBodyAccountListDBAccountRamUserList;
   ramUsers?: string;
   static names(): { [key: string]: string } {
     return {
@@ -68,6 +43,7 @@ export class DescribeAccountsResponseBodyAccountListDBAccount extends $dara.Mode
       accountStatus: 'AccountStatus',
       accountType: 'AccountType',
       engine: 'Engine',
+      ramUserList: 'RamUserList',
       ramUsers: 'RamUsers',
     };
   }
@@ -79,11 +55,15 @@ export class DescribeAccountsResponseBodyAccountListDBAccount extends $dara.Mode
       accountStatus: 'string',
       accountType: 'string',
       engine: 'string',
+      ramUserList: DescribeAccountsResponseBodyAccountListDBAccountRamUserList,
       ramUsers: 'string',
     };
   }
 
   validate() {
+    if(this.ramUserList && typeof (this.ramUserList as any).validate === 'function') {
+      (this.ramUserList as any).validate();
+    }
     super.validate();
   }
 
@@ -119,10 +99,6 @@ export class DescribeAccountsResponseBodyAccountList extends $dara.Model {
 }
 
 export class DescribeAccountsResponseBody extends $dara.Model {
-  /**
-   * @remarks
-   * The queried database accounts.
-   */
   accountList?: DescribeAccountsResponseBodyAccountList;
   /**
    * @remarks

package/src/models/DescribeAdbMySqlTablesRequest.ts

@@ -5,7 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAdbMySqlTablesRequest 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.
    * 
    * This parameter is required.
    * 
@@ -17,7 +18,7 @@ export class DescribeAdbMySqlTablesRequest 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 query the region ID of a cluster.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeAdbMySqlTablesResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAdbMySqlTablesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The message returned for the operation. Valid values:
+   * Additional information about the call. Valid values:
    * 
-   * *   **Success** is returned if the operation is successful.
-   * *   An error message is returned if the operation fails.
+   * - **Success** is returned if the request is successful.
+   * 
+   * - A specific error code is returned if the request fails.
    * 
    * @example
    * Success
@@ -16,7 +17,7 @@ export class DescribeAdbMySqlTablesResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 7A7D49E3-5585-5DF8-B62C-75C46B4991DC
@@ -32,10 +33,11 @@ export class DescribeAdbMySqlTablesResponseBody extends $dara.Model {
   schema?: string;
   /**
    * @remarks
-   * Indicates whether the operation is successful. Valid values:
+   * Indicates whether the call was successful. Valid values:
+   * 
+   * - **true**: The call was successful.
    * 
-   * *   **true**: The operation is successful.
-   * *   **false**: The operation fails.
+   * - **false**: The call failed.
    * 
    * @example
    * true
@@ -43,7 +45,7 @@ export class DescribeAdbMySqlTablesResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The names of tables.
+   * Information about the tables.
    */
   tables?: string[];
   static names(): { [key: string]: string } {

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