@alicloud/adb20211201 4.7.1 → 5.0.1

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/DescribeAdbMySqlColumnsRequest.ts

@@ -3,11 +3,17 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeAdbMySqlColumnsRequest extends $dara.Model {
+  /**
+   * **if can be null:**
+   * true
+   */
+  catalog?: 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 clusters within a region.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the cluster IDs of all clusters in a specified region.
    * 
    * This parameter is required.
    * 
@@ -18,8 +24,7 @@ export class DescribeAdbMySqlColumnsRequest 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.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the region ID of a specified cluster.
    * 
    * This parameter is required.
    * 
@@ -29,7 +34,7 @@ export class DescribeAdbMySqlColumnsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * adb_demo
@@ -37,7 +42,7 @@ export class DescribeAdbMySqlColumnsRequest extends $dara.Model {
   schema?: string;
   /**
    * @remarks
-   * The name of the table.
+   * The table name.
    * 
    * @example
    * test
@@ -45,6 +50,7 @@ export class DescribeAdbMySqlColumnsRequest extends $dara.Model {
   tableName?: string;
   static names(): { [key: string]: string } {
     return {
+      catalog: 'Catalog',
       DBClusterId: 'DBClusterId',
       regionId: 'RegionId',
       schema: 'Schema',
@@ -54,6 +60,7 @@ export class DescribeAdbMySqlColumnsRequest extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      catalog: 'string',
       DBClusterId: 'string',
       regionId: 'string',
       schema: 'string',

package/src/models/DescribeAdbMySqlColumnsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAdbMySqlColumnsResponseBodyColumns extends $dara.Model {
   /**
    * @remarks
-   * The comments of the column.
+   * The column comment.
    * 
    * @example
    * test
@@ -13,7 +13,7 @@ export class DescribeAdbMySqlColumnsResponseBodyColumns extends $dara.Model {
   comment?: string;
   /**
    * @remarks
-   * The name of the column.
+   * The column name.
    * 
    * @example
    * id
@@ -63,15 +63,14 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   columnCount?: number;
   /**
    * @remarks
-   * Details of the columns.
+   * The column information.
    */
   columns?: DescribeAdbMySqlColumnsResponseBodyColumns[];
   /**
    * @remarks
-   * The message returned for the operation. Valid values:
-   * 
-   * *   **Success** is returned if the operation is successful.
-   * *   An error message is returned if the operation fails.
+   * The additional information about the call result. Valid values:
+   * - If the request was successful, **Success** is returned. 
+   * - If the request failed, a specific error code is returned.
    * 
    * @example
    * Success
@@ -79,7 +78,7 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * A9F013CD-0222-595E-8157-445969B97F03
@@ -87,7 +86,7 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * adb_demo
@@ -95,10 +94,9 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   schema?: string;
   /**
    * @remarks
-   * Indicates whether the operation is successful. Valid values:
-   * 
-   * *   **true**: The operation is successful.
-   * *   **false**: The operation fails.
+   * Indicates whether the call was successful.
+   * - **true**: The call was successful.
+   * - **false**: The call failed.
    * 
    * @example
    * true
@@ -106,7 +104,7 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The name of the table.
+   * The table name.
    * 
    * @example
    * test

package/src/models/DescribeAdbMySqlSchemasRequest.ts

@@ -3,9 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeAdbMySqlSchemasRequest extends $dara.Model {
+  /**
+   * **if can be null:**
+   * true
+   */
+  catalog?: 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.
    * 
@@ -16,8 +22,7 @@ export class DescribeAdbMySqlSchemasRequest 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.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the region ID of a specified cluster.
    * 
    * This parameter is required.
    * 
@@ -27,6 +32,7 @@ export class DescribeAdbMySqlSchemasRequest extends $dara.Model {
   regionId?: string;
   static names(): { [key: string]: string } {
     return {
+      catalog: 'Catalog',
       DBClusterId: 'DBClusterId',
       regionId: 'RegionId',
     };
@@ -34,6 +40,7 @@ export class DescribeAdbMySqlSchemasRequest extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      catalog: 'string',
       DBClusterId: 'string',
       regionId: 'string',
     };

package/src/models/DescribeAdbMySqlSchemasResponseBody.ts

@@ -5,10 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAdbMySqlSchemasResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned message.
-   * 
-   * *   If the request was successful, a **success** message is returned.
-   * *   If the request failed, an error message is returned.
+   * The additional information about the call result. Valid values:
+   * - If the request was successful, **Success** is returned. 
+   * - If the request failed, a specific error code is returned.
    * 
    * @example
    * Success
@@ -24,15 +23,14 @@ export class DescribeAdbMySqlSchemasResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The queried databases.
+   * The list of databases.
    */
   schemas?: string[];
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   **true**
-   * *   **false**
+   * Indicates whether the call was successful. Valid values:
+   * - **true**: The call was successful.
+   * - **false**: The call failed.
    * 
    * @example
    * true

package/src/models/DescribeAdbMySqlTablesRequest.ts

@@ -3,9 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeAdbMySqlTablesRequest extends $dara.Model {
+  /**
+   * **if can be null:**
+   * true
+   */
+  catalog?: 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.
    * 
@@ -16,8 +22,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.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the region ID of a specified cluster.
    * 
    * This parameter is required.
    * 
@@ -27,7 +32,7 @@ export class DescribeAdbMySqlTablesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * adb_demo
@@ -38,6 +43,7 @@ export class DescribeAdbMySqlTablesRequest extends $dara.Model {
   schema?: string;
   static names(): { [key: string]: string } {
     return {
+      catalog: 'Catalog',
       DBClusterId: 'DBClusterId',
       regionId: 'RegionId',
       schema: 'Schema',
@@ -46,6 +52,7 @@ export class DescribeAdbMySqlTablesRequest extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      catalog: 'string',
       DBClusterId: 'string',
       regionId: 'string',
       schema: 'string',

package/src/models/DescribeAdbMySqlTablesResponseBody.ts

@@ -5,10 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAdbMySqlTablesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The message returned for the operation. Valid values:
-   * 
-   * *   **Success** is returned if the operation is successful.
-   * *   An error message is returned if the operation fails.
+   * The additional information about the call result. Valid values:
+   * - If the request was successful, **Success** is returned. 
+   * - If the request failed, a specific error code is returned.
    * 
    * @example
    * Success
@@ -16,7 +15,7 @@ export class DescribeAdbMySqlTablesResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 7A7D49E3-5585-5DF8-B62C-75C46B4991DC
@@ -24,7 +23,7 @@ export class DescribeAdbMySqlTablesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The name of the database.
+   * The database name.
    * 
    * @example
    * adb_demo
@@ -32,10 +31,9 @@ export class DescribeAdbMySqlTablesResponseBody extends $dara.Model {
   schema?: string;
   /**
    * @remarks
-   * Indicates whether the operation is successful. Valid values:
-   * 
-   * *   **true**: The operation is successful.
-   * *   **false**: The operation fails.
+   * Indicates whether the call was successful. Valid values:
+   * - **true**: The call was successful.
+   * - **false**: The call failed.
    * 
    * @example
    * true
@@ -43,7 +41,7 @@ export class DescribeAdbMySqlTablesResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The names of tables.
+   * The table information.
    */
   tables?: string[];
   static names(): { [key: string]: string } {