@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/AccessTokenModel.ts

@@ -0,0 +1,39 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AccessTokenModel extends $dara.Model {
+  accessToken?: string;
+  comment?: string;
+  createdAt?: string;
+  expiredAt?: string;
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      accessToken: 'AccessToken',
+      comment: 'Comment',
+      createdAt: 'CreatedAt',
+      expiredAt: 'ExpiredAt',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      accessToken: 'string',
+      comment: 'string',
+      createdAt: 'string',
+      expiredAt: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/AddKnowledgeFileRequest.ts

@@ -0,0 +1,88 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AddKnowledgeFileRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the AnalyticDB for MySQL cluster.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-bp19aaaaaa****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The file address. Currently, only OSS paths are supported.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * oss://bucket_name/file/path
+   */
+  fileLocation?: string;
+  /**
+   * @remarks
+   * The file type.
+   * 
+   * @example
+   * pdf
+   */
+  fileType?: string;
+  /**
+   * @remarks
+   * Specifies whether the file is a folder.
+   * 
+   * @example
+   * false
+   */
+  isDir?: boolean;
+  /**
+   * @remarks
+   * The file tags in JSON format.
+   * 
+   * @example
+   * {"type":"game"}
+   */
+  tags?: string;
+  /**
+   * @remarks
+   * The user who uploads the knowledge base file.
+   * 
+   * @example
+   * user1
+   */
+  uploadUser?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      fileLocation: 'FileLocation',
+      fileType: 'FileType',
+      isDir: 'IsDir',
+      tags: 'Tags',
+      uploadUser: 'UploadUser',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      fileLocation: 'string',
+      fileType: 'string',
+      isDir: 'boolean',
+      tags: 'string',
+      uploadUser: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/{DescribeLlmanswerResponse.ts → AddKnowledgeFileResponse.ts}

@@ -1,12 +1,12 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { DescribeLLMAnswerResponseBody } from "./DescribeLlmanswerResponseBody";
+import { AddKnowledgeFileResponseBody } from "./AddKnowledgeFileResponseBody";
 
 
-export class DescribeLLMAnswerResponse extends $dara.Model {
+export class AddKnowledgeFileResponse extends $dara.Model {
   headers?: { [key: string]: string };
   statusCode?: number;
-  body?: DescribeLLMAnswerResponseBody;
+  body?: AddKnowledgeFileResponseBody;
   static names(): { [key: string]: string } {
     return {
       headers: 'headers',
@@ -19,7 +19,7 @@ export class DescribeLLMAnswerResponse extends $dara.Model {
     return {
       headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
       statusCode: 'number',
-      body: DescribeLLMAnswerResponseBody,
+      body: AddKnowledgeFileResponseBody,
     };
   }
 

package/src/models/AddKnowledgeFileResponseBody.ts

@@ -0,0 +1,34 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AddKnowledgeFileResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/AllocateClusterPublicConnectionRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class AllocateClusterPublicConnectionRequest extends $dara.Model {
   /**
    * @remarks
-   * The prefix of the public endpoint.
+   * The prefix of the public connection address.
    * 
-   * *   The prefix can contain lowercase letters, digits, and hyphens (-). It must start with a lowercase letter.
-   * *   The prefix can be up to 30 characters in length.
+   * - It must begin with a lowercase letter and can contain only lowercase letters, digits, and hyphens (-).
+   * 
+   * - It must be no more than 30 characters long.
    * 
    * @example
    * test12
@@ -16,7 +17,8 @@ export class AllocateClusterPublicConnectionRequest extends $dara.Model {
   connectionStringPrefix?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
+   * <props="china">The cluster ID of an Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.
+   * <props="intl">The cluster ID of a Data Lakehouse Edition cluster.
    * 
    * This parameter is required.
    * 
@@ -26,20 +28,23 @@ export class AllocateClusterPublicConnectionRequest 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.
    * 
-   * *   **AnalyticDB** (default): the AnalyticDB for MySQL engine.
-   * *   **Clickhouse**: the wide table engine.
+   * - **Clickhouse**: the wide table engine.
    * 
    * @example
    * Clickhouse
    */
   engine?: string;
+  resourceGroupName?: string;
   static names(): { [key: string]: string } {
     return {
       connectionStringPrefix: 'ConnectionStringPrefix',
       DBClusterId: 'DBClusterId',
       engine: 'Engine',
+      resourceGroupName: 'ResourceGroupName',
     };
   }
 
@@ -48,6 +53,7 @@ export class AllocateClusterPublicConnectionRequest extends $dara.Model {
       connectionStringPrefix: 'string',
       DBClusterId: 'string',
       engine: 'string',
+      resourceGroupName: 'string',
     };
   }
 

package/src/models/ApplyAdviceByIdRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ApplyAdviceByIdRequest extends $dara.Model {
   /**
    * @remarks
-   * The date on which you want to apply the suggestion. Format: yyyyMMdd.
+   * The date when the suggestion was generated. Format: yyyyMMdd.
    * 
    * @example
    * 20221101
@@ -19,7 +19,21 @@ export class ApplyAdviceByIdRequest extends $dara.Model {
    * 0baf1f52-53df-487f-8292-99a03716****
    */
   adviceId?: string;
+  /**
+   * @remarks
+   * The adoption type.
+   * 
+   * @example
+   * DROP_INDEX
+   */
   applyType?: string;
+  /**
+   * @remarks
+   * Specifies whether to immediately start the build task.
+   * 
+   * @example
+   * true
+   */
   buildImmediately?: boolean;
   /**
    * @remarks

package/src/models/BatchApplyAdviceByIdListRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class BatchApplyAdviceByIdListRequest extends $dara.Model {
   /**
    * @remarks
-   * The date on which you want to apply the suggestion. Format: yyyyMMdd.
+   * The date when the suggestions were generated. Format: yyyyMMdd.
    * 
    * @example
    * 20221115
@@ -13,20 +13,32 @@ export class BatchApplyAdviceByIdListRequest extends $dara.Model {
   adviceDate?: number;
   /**
    * @remarks
-   * The IDs of the suggestions that you want to apply. Separate multiple IDs with commas (,).
+   * The list of suggestion IDs to apply in batches. Separate multiple suggestion IDs with commas (,).
    * 
    * @example
    * c2589ff3-e86c-4f19-80c8-2aeb7dd9****,53414470-ebf4-4a53-a312-8a1ad8fd****,6e8dce84-fec8-4b0b-9c04-b0cea12c****,b3b9703d-55ca-47e0-96dd-6a4a9dbf****
    */
   adviceIdList?: string;
+  /**
+   * @remarks
+   * The adoption type.
+   * 
+   * @example
+   * DROP_INDEX
+   */
   applyType?: string;
+  /**
+   * @remarks
+   * Specifies whether to immediately start a build task.
+   * 
+   * @example
+   * true
+   */
   buildImmediately?: boolean;
   /**
    * @remarks
    * The cluster ID.
    * 
-   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.
-   * 
    * This parameter is required.
    * 
    * @example

package/src/models/BindAccountRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class BindAccountRequest extends $dara.Model {
   /**
    * @remarks
-   * The standard account of the cluster.
+   * A standard database account.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class BindAccountRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
+   * ID of the cluster. Applies to Enterprise Edition, Basic Edition, or Data Lakehouse Edition clusters.
    * 
    * This parameter is required.
    * 
@@ -25,19 +25,23 @@ export class BindAccountRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The ID of the RAM user.
-   * 
-   * This parameter is required.
+   * ID of the Alibaba Cloud RAM user to bind.
    * 
    * @example
    * 1444832459****
    */
   ramUser?: string;
+  /**
+   * @remarks
+   * List of Alibaba Cloud RAM user IDs to bind. You can bind only one RAM user at a time. If you specify this parameter, the RamUser parameter is ignored.
+   */
+  ramUserList?: string[];
   static names(): { [key: string]: string } {
     return {
       accountName: 'AccountName',
       DBClusterId: 'DBClusterId',
       ramUser: 'RamUser',
+      ramUserList: 'RamUserList',
     };
   }
 
@@ -46,10 +50,14 @@ export class BindAccountRequest extends $dara.Model {
       accountName: 'string',
       DBClusterId: 'string',
       ramUser: 'string',
+      ramUserList: { 'type': 'array', 'itemType': 'string' },
     };
   }
 
   validate() {
+    if(Array.isArray(this.ramUserList)) {
+      $dara.Model.validateArray(this.ramUserList);
+    }
     super.validate();
   }
 

package/src/models/BindAccountResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class BindAccountResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * ID of the request.
    * 
    * @example
    * DFF27323-3868-5F8A-917D-5D1D06B6BC0D

package/src/models/BindAccountShrinkRequest.ts

@@ -0,0 +1,65 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class BindAccountShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * A standard database account.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * test_accout
+   */
+  accountName?: string;
+  /**
+   * @remarks
+   * ID of the cluster. Applies to Enterprise Edition, Basic Edition, or Data Lakehouse Edition clusters.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * amv-wz99d9nh532****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * ID of the Alibaba Cloud RAM user to bind.
+   * 
+   * @example
+   * 1444832459****
+   */
+  ramUser?: string;
+  /**
+   * @remarks
+   * List of Alibaba Cloud RAM user IDs to bind. You can bind only one RAM user at a time. If you specify this parameter, the RamUser parameter is ignored.
+   */
+  ramUserListShrink?: string;
+  static names(): { [key: string]: string } {
+    return {
+      accountName: 'AccountName',
+      DBClusterId: 'DBClusterId',
+      ramUser: 'RamUser',
+      ramUserListShrink: 'RamUserList',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      accountName: 'string',
+      DBClusterId: 'string',
+      ramUser: 'string',
+      ramUserListShrink: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CancelSparkReplStatementResponseBody.ts

@@ -61,7 +61,7 @@ export class CancelSparkReplStatementResponseBodyData extends $dara.Model {
    * The error message.
    * 
    * @example
-   * StackOverflow Exception:
+   * StackOverflow Exception：
    */
   error?: string;
   /**

package/src/models/CancelSparkWarehouseBatchSqlrequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CancelSparkWarehouseBatchSQLRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the client, which can be up to 16 characters in length. Specify a descriptive name that makes it easy to identify.
+   * The client name for auxiliary recording. The value is a meaningful string of up to 16 characters.
    * 
    * @example
    * DMS
@@ -21,7 +21,7 @@ export class CancelSparkWarehouseBatchSQLRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The query ID of the Spark SQL statement.
+   * The execution ID of the Spark SQL.
    * 
    * This parameter is required.
    * 

package/src/models/CancelSparkWarehouseBatchSqlresponseBody.ts

@@ -6,7 +6,7 @@ import { SparkBatchSQL } from "./SparkBatchSql";
 export class CancelSparkWarehouseBatchSQLResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned data.
+   * The returned result.
    * 
    * @example
    * 123

package/src/models/CheckFormationSchemaExistsRequest.ts

@@ -0,0 +1,77 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CheckFormationSchemaExistsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The cluster ID.
+   * 
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the cluster IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters in a region.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * amv-bp11q28kvl688****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable prefix mode. Valid values:
+   * 
+   * - true: Enable prefix mode.
+   * - false: Disable prefix mode.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * false
+   */
+  prefixMode?: boolean;
+  /**
+   * @remarks
+   * RegionId
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * schema 。
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * testdb01
+   */
+  schema?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      prefixMode: 'PrefixMode',
+      regionId: 'RegionId',
+      schema: 'Schema',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      prefixMode: 'boolean',
+      regionId: 'string',
+      schema: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CheckFormationSchemaExistsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { CheckFormationSchemaExistsResponseBody } from "./CheckFormationSchemaExistsResponseBody";
+
+
+export class CheckFormationSchemaExistsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: CheckFormationSchemaExistsResponseBody;
+  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: CheckFormationSchemaExistsResponseBody,
+    };
+  }
+
+  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/CheckFormationSchemaExistsResponseBody.ts

@@ -0,0 +1,84 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CheckFormationSchemaExistsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The status code.
+   * 
+   * @example
+   * 200
+   */
+  code?: string;
+  /**
+   * @remarks
+   * Indicates whether the schema exists.
+   * 
+   * @example
+   * false
+   */
+  data?: string;
+  /**
+   * @remarks
+   * The HTTP status code.
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message. OK is returned if the request was successful.
+   * 
+   * @example
+   * OK
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 82C80833-BE26-424D-B485-1ABC8431E14
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      httpStatusCode: 'HttpStatusCode',
+      message: 'Message',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: 'string',
+      httpStatusCode: 'number',
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+