@alicloud/adb20211201 5.4.0 → 5.5.1

package/src/models/CreateSqlPatternCompareReportRequest.ts

@@ -0,0 +1,111 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateSqlPatternCompareReportRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The end time of time window 2. Specify the time in UTC in the yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm:ssZ format.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2026-09-08T01:00Z
+   */
+  compareEndTime?: string;
+  /**
+   * @remarks
+   * The start time of time window 2. Specify the time in UTC in the yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm:ssZ format.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2026-09-08T00:00Z
+   */
+  compareStartTime?: string;
+  /**
+   * @remarks
+   * The ID of the AnalyticDB for MySQL cluster.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-2ze1234567890****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The end time of time window 1. Specify the time in UTC in the yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm:ssZ format.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2026-09-07T01:00Z
+   */
+  endTime?: string;
+  /**
+   * @remarks
+   * The report type. Valid values:
+   * 
+   * - `NEW`: Patterns that are new in time window 2.
+   * - `CHANGED`: Patterns that exist in both time windows and have an increased average value in at least one metric.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * CHANGED
+   */
+  patternType?: string;
+  /**
+   * @remarks
+   * The region ID of the instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The start time of time window 1. Specify the time in UTC in the yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm:ssZ format.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2026-09-07T00:00Z
+   */
+  startTime?: string;
+  static names(): { [key: string]: string } {
+    return {
+      compareEndTime: 'CompareEndTime',
+      compareStartTime: 'CompareStartTime',
+      DBClusterId: 'DBClusterId',
+      endTime: 'EndTime',
+      patternType: 'PatternType',
+      regionId: 'RegionId',
+      startTime: 'StartTime',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      compareEndTime: 'string',
+      compareStartTime: 'string',
+      DBClusterId: 'string',
+      endTime: 'string',
+      patternType: 'string',
+      regionId: 'string',
+      startTime: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateSqlPatternCompareReportResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CreateSqlPatternCompareReportResponseBody } from "./CreateSqlPatternCompareReportResponseBody";
+
+
+export class CreateSqlPatternCompareReportResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CreateSqlPatternCompareReportResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: CreateSqlPatternCompareReportResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateSqlPatternCompareReportResponseBody.ts

@@ -0,0 +1,44 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateSqlPatternCompareReportResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the created report. This value only indicates that the request has been accepted.
+   * 
+   * @example
+   * 1001
+   */
+  reportId?: number;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9A1B2C3D-4E5F-6789-ABCD-0123456789AB
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      reportId: 'ReportId',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      reportId: 'number',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DatabaseSummaryModel.ts

@@ -5,27 +5,43 @@ import * as $dara from '@darabonba/typescript';
 export class DatabaseSummaryModel extends $dara.Model {
   /**
    * @remarks
-   * Creation time.
+   * The creation time.
    * 
    * @example
    * 2023-01-05 13:17:55
    */
   createTime?: string;
+  /**
+   * @remarks
+   * The creation source of the database.
+   */
   createdBySource?: string;
+  /**
+   * @remarks
+   * The user who created the database.
+   */
   createdByUser?: string;
+  /**
+   * @remarks
+   * The database type.
+   */
   dbType?: string;
   /**
    * @remarks
-   * Description.
+   * The description.
    * 
    * @example
    * description
    */
   description?: string;
+  /**
+   * @remarks
+   * The data storage location of the database.
+   */
   location?: string;
   /**
    * @remarks
-   * Owner.
+   * The owner.
    * 
    * @example
    * abc
@@ -33,7 +49,7 @@ export class DatabaseSummaryModel extends $dara.Model {
   owner?: string;
   /**
    * @remarks
-   * logical database name.
+   * The logical database name.
    * 
    * @example
    * testSchema
@@ -41,7 +57,7 @@ export class DatabaseSummaryModel extends $dara.Model {
   schemaName?: string;
   /**
    * @remarks
-   * Update time.
+   * The update time.
    * 
    * @example
    * 2023-01-05 13:17:55

package/src/models/DeleteAccountRequest.ts

@@ -29,13 +29,20 @@ export class DeleteAccountRequest extends $dara.Model {
    * @remarks
    * The database engine. Valid values:
    * 
-   * - **AnalyticDB** (default): the AnalyticDB for MySQL engine.
-   * - **Clickhouse**: the wide table engine.
+   * - **AnalyticDB** (default): AnalyticDB for MySQL.
+   * - **Clickhouse**: wide table engine.
    * 
    * @example
    * Clickhouse
    */
   engine?: string;
+  /**
+   * @remarks
+   * The name of the resource group.
+   * 
+   * @example
+   * test_group
+   */
   resourceGroupName?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DeleteAccountResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteAccountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 2FED790E-FB61-4721-8C1C-07C627FA5A19

package/src/models/DeleteKnowledgeFileRequest.ts

@@ -15,9 +15,15 @@ export class DeleteKnowledgeFileRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The location of the knowledge base document.
+   * The ID of the file.
    * 
-   * This parameter is required.
+   * @example
+   * 2131213
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The path of the knowledge base document.
    * 
    * @example
    * oss://bucket/doc.pdf
@@ -26,6 +32,7 @@ export class DeleteKnowledgeFileRequest extends $dara.Model {
   static names(): { [key: string]: string } {
     return {
       DBClusterId: 'DBClusterId',
+      fileId: 'FileId',
       fileLocation: 'FileLocation',
     };
   }
@@ -33,6 +40,7 @@ export class DeleteKnowledgeFileRequest extends $dara.Model {
   static types(): { [key: string]: any } {
     return {
       DBClusterId: 'string',
+      fileId: 'string',
       fileLocation: 'string',
     };
   }

package/src/models/DeleteKnowledgeFileResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteKnowledgeFileResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The file location. Currently, only OSS paths are supported.
+   * The file path. Currently, only OSS paths are supported.
    * 
    * @example
    * oss://bucket/doc.pdf
@@ -13,7 +13,7 @@ export class DeleteKnowledgeFileResponseBodyData extends $dara.Model {
   fileLocation?: string;
   /**
    * @remarks
-   * The prompt message.
+   * The message.
    * 
    * @example
    * Successful
@@ -21,10 +21,9 @@ export class DeleteKnowledgeFileResponseBodyData extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * - **true**: Successful.
-   * - **false**: Failed.
+   * Indicates whether the request is successful. Valid values:
+   * - **true**: The request is successful.
+   * - **false**: The request fails.
    * 
    * @example
    * true

package/src/models/DescribeAccountAllPrivilegesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAccountAllPrivilegesRequest extends $dara.Model {
   /**
    * @remarks
-   * The database account name for the cluster.
+   * The name of the database account in the cluster.
    * 
    * This parameter is required.
    * 
@@ -15,8 +15,8 @@ export class DescribeAccountAllPrivilegesRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * <props="china">The cluster ID for the Enterprise Edition, Basic Edition, or Data Lakehouse Edition.
-   * <props="intl">The cluster ID for the Data Lakehouse Edition.
+   * <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.
    * 
@@ -26,7 +26,7 @@ export class DescribeAccountAllPrivilegesRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * If the response is truncated, use the `Marker` value from the response in this field to retrieve the next set of results.
+   * If the returned results are truncated, you can set this parameter to the `Marker` value from the response to retrieve the subsequent entries.
    * 
    * @example
    * EXAMPLE

package/src/models/DescribeAccountAllPrivilegesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject extends $dara.Model {
   /**
    * @remarks
-   * The column name.
+   * The name of the column.
    * 
    * @example
    * id
@@ -13,7 +13,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject e
   column?: string;
   /**
    * @remarks
-   * The database name.
+   * The name of the database.
    * 
    * @example
    * tdb1
@@ -21,7 +21,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject e
   database?: string;
   /**
    * @remarks
-   * Description of the permission object.
+   * The description of the permission object.
    * 
    * @example
    * id of table
@@ -29,7 +29,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject e
   description?: string;
   /**
    * @remarks
-   * The table name.
+   * The name of the table.
    * 
    * @example
    * table1
@@ -65,12 +65,12 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject e
 export class DescribeAccountAllPrivilegesResponseBodyDataResult extends $dara.Model {
   /**
    * @remarks
-   * The permission object, represented as a trituple of database, table, and column. All fields are empty for Global-level permissions.
+   * The permission object, which is a triplet of the database, table, and column. All fields are empty when the permission level is Global.
    */
   privilegeObject?: DescribeAccountAllPrivilegesResponseBodyDataResultPrivilegeObject;
   /**
    * @remarks
-   * The permission level, returned by the `DescribeEnabledPrivileges` operation.
+   * The permission level, which is obtained from the `DescribeEnabledPrivileges` operation.
    * 
    * @example
    * Global
@@ -78,7 +78,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResult extends $dara.Mo
   privilegeType?: string;
   /**
    * @remarks
-   * List of permissions.
+   * The list of permissions.
    */
   privileges?: string[];
   static names(): { [key: string]: string } {
@@ -115,7 +115,7 @@ export class DescribeAccountAllPrivilegesResponseBodyDataResult extends $dara.Mo
 export class DescribeAccountAllPrivilegesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * If the `Truncated` field in the response is `true`, pass this value in subsequent calls to retrieve the next set of results.
+   * If the `Truncated` field in the response is `true`, specify the value of this field in the next call to retrieve the subsequent entries.
    * 
    * @example
    * 0573e74fd1ccb01739993a691e876074db6e1b6ad79f54115f0e98528432ba6a523cfec5780ade5189299cc3396f6ff7
@@ -123,12 +123,12 @@ export class DescribeAccountAllPrivilegesResponseBodyData extends $dara.Model {
   marker?: string;
   /**
    * @remarks
-   * List of permissions.
+   * The list of permissions.
    */
   result?: DescribeAccountAllPrivilegesResponseBodyDataResult[];
   /**
    * @remarks
-   * If the response is truncated, this field is `true`. Continue calling this operation until this field becomes `false`.
+   * Indicates whether the returned content is truncated. If the value is `true`, the returned content is truncated, and you must continue to call this operation to retrieve the remaining entries until the value is `false`.
    * 
    * @example
    * true
@@ -165,7 +165,7 @@ export class DescribeAccountAllPrivilegesResponseBodyData extends $dara.Model {
 export class DescribeAccountAllPrivilegesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Permission details.
+   * The permission details.
    */
   data?: DescribeAccountAllPrivilegesResponseBodyData;
   /**

package/src/models/DescribeAccountsRequest.ts

@@ -6,7 +6,7 @@ export class DescribeAccountsRequest extends $dara.Model {
   /**
    * @remarks
    * The database account.
-   * > If you do not specify this parameter, information about all database accounts is returned.
+   * > If you do not specify this parameter, the information about all database accounts is returned by default.
    * 
    * @example
    * test_accout
@@ -14,7 +14,7 @@ export class DescribeAccountsRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * <props="china">The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.
+   * <props="china">The ID of the cluster. The cluster can be of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition.
    * <props="intl">The ID of the Data Lakehouse Edition cluster.
    * 
    * This parameter is required.
@@ -27,8 +27,8 @@ export class DescribeAccountsRequest extends $dara.Model {
    * @remarks
    * The database engine. Valid values:
    * 
-   * - **AnalyticDB** (default): the AnalyticDB for MySQL engine.
-   * - **Clickhouse**: the wide table engine.
+   * - **AnalyticDB** (default): AnalyticDB for MySQL engine
+   * - **Clickhouse**: wide-table engine
    * 
    * @example
    * Clickhouse
@@ -38,6 +38,9 @@ export class DescribeAccountsRequest extends $dara.Model {
   /**
    * @remarks
    * The name of the resource group.
+   * 
+   * @example
+   * test_group
    */
   resourceGroupName?: string;
   static names(): { [key: string]: string } {

package/src/models/DescribeAdbMySqlColumnsRequest.ts

@@ -4,6 +4,12 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAdbMySqlColumnsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the external data source.
+   * 
+   * @example
+   * oss
+   * 
    * **if can be null:**
    * true
    */
@@ -13,7 +19,7 @@ export class DescribeAdbMySqlColumnsRequest extends $dara.Model {
    * <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 cluster IDs of all clusters in a specified region.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query the IDs of all clusters in the target region.
    * 
    * This parameter is required.
    * 
@@ -34,7 +40,7 @@ export class DescribeAdbMySqlColumnsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The database name.
+   * The name of the database.
    * 
    * @example
    * adb_demo
@@ -42,7 +48,7 @@ export class DescribeAdbMySqlColumnsRequest extends $dara.Model {
   schema?: string;
   /**
    * @remarks
-   * The table name.
+   * The name of the table.
    * 
    * @example
    * test

package/src/models/DescribeAdbMySqlColumnsResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeAdbMySqlColumnsResponseBodyColumns extends $dara.Model {
   comment?: string;
   /**
    * @remarks
-   * The column name.
+   * The name of the column.
    * 
    * @example
    * id
@@ -69,8 +69,8 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   /**
    * @remarks
    * 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.
+   * - If the request is successful, **Success** is returned.
+   * - If the request fails, a specific error code is returned.
    * 
    * @example
    * Success
@@ -78,7 +78,7 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * A9F013CD-0222-595E-8157-445969B97F03
@@ -86,7 +86,7 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The database name.
+   * The name of the database.
    * 
    * @example
    * adb_demo
@@ -94,7 +94,7 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   schema?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the call was successful. Valid values:
    * - **true**: The call was successful.
    * - **false**: The call failed.
    * 
@@ -104,7 +104,7 @@ export class DescribeAdbMySqlColumnsResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The table name.
+   * The name of the table.
    * 
    * @example
    * test

package/src/models/DescribeAdbMySqlSchemasRequest.ts

@@ -4,6 +4,12 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAdbMySqlSchemasRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the external data source.
+   * 
+   * @example
+   * oss
+   * 
    * **if can be null:**
    * true
    */
@@ -22,7 +28,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 region ID of a specified cluster.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the region ID of the specified cluster.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeAdbMySqlSchemasResponseBody.ts

@@ -6,8 +6,8 @@ export class DescribeAdbMySqlSchemasResponseBody extends $dara.Model {
   /**
    * @remarks
    * 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.
+   * - **Success**: The request is successful. 
+   * - Specific error code: An exception occurred.
    * 
    * @example
    * Success

package/src/models/DescribeAdbMySqlTablesRequest.ts

@@ -4,6 +4,12 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeAdbMySqlTablesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the external data source.
+   * 
+   * @example
+   * oss
+   * 
    * **if can be null:**
    * true
    */
@@ -22,7 +28,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 region ID of a specified cluster.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/454314.html) operation to query the region ID of the specified cluster.
    * 
    * This parameter is required.
    * 
@@ -32,7 +38,7 @@ export class DescribeAdbMySqlTablesRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The database name.
+   * The name of the database.
    * 
    * @example
    * adb_demo