@alicloud/polardb20170801 8.2.5 → 8.3.1

package/src/models/DescribeKbsyncLinksRequest.ts

@@ -21,6 +21,22 @@ export class DescribeKBSyncLinksRequest extends $dara.Model {
    * pkb-xxxxx
    */
   knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The page number of the query results. Default value: 1.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of synchronization links returned per page. Valid values: 10, 20, 30, 50, 100, 200, and 500. Default value: 30.
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
   /**
    * @remarks
    * The region ID.
@@ -35,6 +51,8 @@ export class DescribeKBSyncLinksRequest extends $dara.Model {
     return {
       imPlatform: 'ImPlatform',
       knowledgeBaseId: 'KnowledgeBaseId',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
       regionId: 'RegionId',
     };
   }
@@ -43,6 +61,8 @@ export class DescribeKBSyncLinksRequest extends $dara.Model {
     return {
       imPlatform: 'string',
       knowledgeBaseId: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
       regionId: 'string',
     };
   }

package/src/models/DescribeKbsyncLinksResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeKBSyncLinksResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The client identifier.
+   * The client ID.
    * 
    * @example
    * cli_xxxxxxbe8
@@ -122,6 +122,22 @@ export class DescribeKBSyncLinksResponseBody extends $dara.Model {
    * The list of synchronization links.
    */
   items?: DescribeKBSyncLinksResponseBodyItems[];
+  /**
+   * @remarks
+   * The page number of the current results.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of records per page in the current results.
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
   /**
    * @remarks
    * Id of the request
@@ -130,17 +146,31 @@ export class DescribeKBSyncLinksResponseBody extends $dara.Model {
    * EB07CFF0-D8A4-5C76-AED7-D00E26FC2***
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The total number of synchronization links that match the query conditions.
+   * 
+   * @example
+   * 1
+   */
+  totalRecordCount?: number;
   static names(): { [key: string]: string } {
     return {
       items: 'Items',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
       requestId: 'RequestId',
+      totalRecordCount: 'TotalRecordCount',
     };
   }
 
   static types(): { [key: string]: any } {
     return {
       items: { 'type': 'array', 'itemType': DescribeKBSyncLinksResponseBodyItems },
+      pageNumber: 'number',
+      pageSize: 'number',
       requestId: 'string',
+      totalRecordCount: 'number',
     };
   }
 

package/src/models/ModifyDbclusterEndpointRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBClusterEndpointRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to automatically add new nodes to the endpoint. Valid values:
+   * Specifies whether new nodes are automatically added to the endpoint. Valid values: 
    * 
-   * - **Enable**: Automatically adds new nodes.
-   * 
-   * - **Disable**: Does not automatically add new nodes. This is the default value.
+   * - **Enable**: New nodes are automatically added.
+   * - **Disable**: New nodes are not automatically added. (Default)
    * 
    * @example
    * Enable
@@ -35,7 +34,7 @@ export class ModifyDBClusterEndpointRequest extends $dara.Model {
   DBEndpointDescription?: string;
   /**
    * @remarks
-   * The ID of the cluster endpoint.
+   * The cluster endpoint ID.
    * 
    * This parameter is required.
    * 
@@ -45,83 +44,60 @@ export class ModifyDBClusterEndpointRequest extends $dara.Model {
   DBEndpointId?: string;
   /**
    * @remarks
-   * The advanced configurations of the cluster endpoint in JSON format. You can set the consistency level, transaction splitting, whether the primary node accepts read requests, the connection pool, and other settings.
-   * 
-   * - Sets the load balancing policy. Format: `{\\"LoadBalancePolicy\\":\\"policy\\"}`. Valid values:
-   * 
-   *   - **0**: Connections-based load balancing (default)
-   * 
-   *   - **1**: Active requests-based load balancing
-   * 
-   * - Specifies whether the primary node accepts read requests. Format: `{\\"MasterAcceptReads\\":\\"value\\"}`. Valid values:
-   * 
-   *   - **on**: The primary node accepts read requests (default).
-   * 
-   *   - **off**: The primary node does not accept read requests.
-   * 
-   * - Enables or disables transaction splitting. Format: `{\\"DistributedTransaction\\":\\"value\\"}`. Valid values:
-   * 
-   *   - **on**: Enables transaction splitting (default).
-   * 
-   *   - **off**: Disables transaction splitting.
-   * 
-   * - Sets the consistency level. Format: `{\\"ConsistLevel\\":\\"level\\"}`. Valid values:
+   * The advanced configuration of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling.
    * 
-   *   - **0**: Eventual consistency (weak)
+   * * To set the load balancing policy, use the format `{\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}`. Valid values:   
+   *     * **0**: connection-based load balancing (default)
+   *     * **1**: active-request-based load balancing
    * 
-   *   - **1**: Session consistency (medium) (default)
+   * * To set whether the primary node accepts read requests, use the format `{\\"MasterAcceptReads\\":\\"Whether the primary node accepts reads\\"}`. Valid values:
+   *     * **on**: The primary node accepts read requests. (Default)
+   *     * **off**: The primary node does not accept read requests.
    * 
-   *   - **2**: Global consistency (strong)
+   * * To set transaction splitting, use the format `{\\"DistributedTransaction\\":\\"Transaction splitting\\"}`. Valid values:
+   *     * **on**: Transaction splitting is enabled. (Default)
+   *     * **off**: Transaction splitting is disabled.
    * 
-   * - Sets the timeout period for a global consistency read. Format: `{\\"ConsistTimeout\\":\\"timeout\\"}`. Valid values: 0 to 60000. Default value: 20. Unit: ms.
+   * * To set the consistency level, use the format `{\\"ConsistLevel\\":\\"Consistency level\\"}`. Valid values:
+   *     * **0**: eventual consistency (weak)
+   *     * **1**: session consistency (medium) (default)
+   *     * **2**: global consistency (strong)
    * 
-   * - Sets the timeout period for a session consistency read. Format: `{\\"ConsistSessionTimeout\\":\\"timeout\\"}`. Valid values: 0 to 60000. Default value: 0. Unit: ms.
+   * * To set the global consistency read timeout period, use the format `{\\"ConsistTimeout\\":\\"Global consistency read timeout\\"}`. Valid values: 0 to 60000. Default value: 20. Unit: ms.
    * 
-   * - Sets the policy for handling timeouts of global or session consistency reads. Format: `{\\"ConsistTimeoutAction\\":\\"policy\\"}`. Valid values:
+   * * To set the session consistency read timeout period, use the format `{\\"ConsistSessionTimeout\\":\\"Session consistency read timeout\\"}`. Valid values: 0 to 60000. Default value: 0. Unit: ms.
    * 
-   *   - **0**: Forwards read requests to the primary node (default).
+   * * To set the global (or session) consistency read timeout policy, use the format `{\\"ConsistTimeoutAction\\":\\"Global consistency read timeout policy\\"}`. Valid values:
+   *     * **0**: Forward the read request to the primary node. (Default)
+   *     * **1**: The proxy returns the error message `wait replication complete timeout, please retry` to the application.
    * 
-   *   - **1**: The proxy returns the error message \\`wait replication complete timeout, please retry\\` to the application.
+   * * To set the connection pool, use the format `{\\"ConnectionPersist\\":\\"Connection pool\\"}`. Valid values:
+   *     * **off**: The connection pool is disabled. (Default)
+   *     * **Session**: The session-level connection pool is enabled.
+   *     * **Transaction**: The transaction-level connection pooling is enabled.
    * 
-   * - Sets the connection pool type. Format: `{\\"ConnectionPersist\\":\\"type\\"}`. Valid values:
+   * * To set parallel query, use the format `{\\"MaxParallelDegree\\":\\"Parallel query\\"}`. Valid values:
+   *     * **on**: Parallel query is enabled.
+   *     * **off**: Parallel query is disabled. (Default)
    * 
-   *   - **off**: Disables the connection pool (default).
+   * * To set automatic request distribution among row offload reads from primary nodes, use the format `{\\"EnableHtapImci\\":\\"Automatic request distribution among row store and column store\\"}`. Valid values:
+   *     * **on**: Automatic request distribution among row offload reads from primary nodes is enabled.
+   *     * **off**: Automatic request distribution among row offload reads from primary nodes is disabled. (Default)
    * 
-   *   - **Session**: Enables the session-level connection pool.
    * 
-   *   - **Transaction**: Enables the transaction-level connection pool.
+   * * To set whether to enable overload protection, use the format `{\\"EnableOverloadThrottle\\":\\"Whether to enable overload protection\\"}`. Valid values:
+   *     * **on**: Overload protection is enabled.
+   *     * **off**: Overload protection is disabled. (Default)
    * 
-   * - Enables or disables parallel query. Format: `{\\"MaxParallelDegree\\":\\"value\\"}`. Valid values:
+   * * To set node weights, use the format `{\\"NodesWeight\\":{\\"Node ID\\":\\"Weight value\\"}}`.
    * 
-   *   - **on**: Enables parallel query.
-   * 
-   *   - **off**: Disables parallel query (default).
-   * 
-   * - Enables or disables automatic routing of requests to the row store or column store. Format: `{\\"EnableHtapImci\\":\\"value\\"}`. Valid values:
-   * 
-   *   - **on**: Enables automatic routing.
-   * 
-   *   - **off**: Disables automatic routing (default).
-   * 
-   * - Enables or disables overload protection. Format: `{\\"EnableOverloadThrottle\\":\\"value\\"}`. Valid values:
-   * 
-   *   - **on**: Enables overload protection.
-   * 
-   *   - **off**: Disables overload protection (default).
-   * 
-   * > * You can set transaction splitting, whether the primary node accepts read requests, the connection pool, and overload protection only when the read/write mode of the cluster endpoint for PolarDB for MySQL is set to ReadWrite (automatic read/write splitting).
-   * >
-   * > * If the read/write mode of a cluster endpoint for PolarDB for MySQL is **ReadOnly**, both **connections-based** and **active requests-based** load balancing policies are supported. If the read/write mode is **ReadWrite** (automatic read/write splitting), only the **active requests-based** load balancing policy is supported.
-   * >
-   * > * You can enable automatic routing to the row store or column store if the read/write mode of the cluster endpoint for PolarDB for MySQL is **ReadWrite** (automatic read/write splitting), or if the read/write mode is **ReadOnly** and the load balancing policy is **active requests-based**.
-   * >
-   * > * Only PolarDB for MySQL supports global consistency.
-   * >
-   * > * If you set the **ReadWriteMode** parameter to **ReadOnly**, you can only set the consistency level to **0**.
-   * >
-   * > * You can set the consistency level, transaction splitting, whether the primary node accepts read requests, and the connection pool at the same time. For example: `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.
-   * >
-   * > * The transaction splitting setting is constrained by the consistency level. For example, you cannot enable transaction splitting if the consistency level is **0** (eventual consistency). You can enable transaction splitting if the consistency level is **1** (session consistency) or **2** (global consistency).
+   * > * Transaction splitting, whether the primary node accepts read requests, connection pooling, and overload protection can be configured only when the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadWrite (automatic read/write splitting)**.
+   * > * When the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadOnly**, both **connection-based load balancing** and **active-request-based load balancing** policies are supported. The **ReadWrite (automatic read/write splitting)** mode supports only the **active-request-based load balancing** policy.
+   * > * Automatic request distribution among row offload reads from primary nodes can be configured when the read/write mode of the PolarDB for MySQL cluster endpoint is **ReadWrite (automatic read/write splitting)**, or when the read/write mode is **ReadOnly** and the load balancing policy is **active-request-based load balancing**.
+   * > * Only PolarDB for MySQL supports setting the consistency level to global consistency.
+   * > * If **ReadWriteMode** is set to **ReadOnly**, the consistency level can only be set to **0**.
+   * > * You can configure the consistency level, transaction splitting, whether the primary node accepts read requests, and connection pooling at the same time. Example: `{\\"ConsistLevel\\":\\"1\\",\\"DistributedTransaction\\":\\"on\\",\\"ConnectionPersist\\":\\"Session\\",\\"MasterAcceptReads\\":\\"on\\"}`.
+   * > * Transaction splitting is constrained by the consistency level. For example, transaction splitting cannot be enabled when the consistency level is **0**. Transaction splitting can be enabled when the consistency level is **1** or **2**.
    * 
    * @example
    * {"ConsistLevel":"1","DistributedTransaction":"on","MasterAcceptReads":"off","ConnectionPersist": "on"}
@@ -129,17 +105,14 @@ export class ModifyDBClusterEndpointRequest extends $dara.Model {
   endpointConfig?: string;
   /**
    * @remarks
-   * The nodes to be added to the endpoint for read request distribution. Separate multiple node IDs with commas (,). The original nodes are used by default.
-   * 
-   * > - For PolarDB for MySQL, specify the node IDs.
-   * >
-   * > - For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Oracle Compatible), specify the node roles, such as `Writer,Reader1,Reader2`.
-   * >
-   * > - If you set **ReadWriteMode** to **ReadOnly**, you can attach only one node. However, if this node fails, the endpoint may be unavailable for up to one hour. Do not use this configuration in a production environment. Select at least two nodes to improve availability.
-   * >
-   * > - If you set **ReadWriteMode** to **ReadWrite**, you must select at least two nodes.
-   * >   \\* For PolarDB for MySQL, you can select any two nodes. If both nodes are read-only nodes, write requests are sent to the primary node.
-   * >   \\* For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Oracle Compatible), you must include the primary node.
+   * The read load nodes to add to the endpoint. Separate multiple nodes with commas (,). Default value: the existing nodes.
+   * 
+   * > * For PolarDB for MySQL, specify node IDs.
+   * > * For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), specify node role names, such as `Writer,Reader1,Reader2`.
+   * > * If **ReadWriteMode** is set to **ReadOnly**, you can mount only one node. However, if this node fails, the endpoint may be unavailable for up to 1 hour. Do not use this configuration in production environments. Select at least 2 nodes to improve availability.
+   * > * If **ReadWriteMode** is set to **ReadWrite**, select at least 2 nodes.
+   *     * PolarDB for MySQL allows you to select any two nodes. If both nodes are read-only nodes, write requests are forwarded to the primary node.
+   *     * PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle) require the primary node to be included.
    * 
    * @example
    * pi-**************,pi-*************
@@ -149,11 +122,11 @@ export class ModifyDBClusterEndpointRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The policy for handling global consistency timeouts. Valid values:
+   * The timeout policy for global consistency. Valid values:
    * 
-   * - **0**: Forwards the request to the primary node.
+   * - **0**: Send the request to the primary node.
    * 
-   * - **2**: Degrades the request. If a global consistency read times out, the query is automatically degraded to a regular request. The client does not receive an error message.
+   * - **2**: Timeout degradation. When the global consistency read times out, the query is automatically degraded to regular requests, and the client does not receive an error message.
    * 
    * @example
    * 0
@@ -171,9 +144,8 @@ export class ModifyDBClusterEndpointRequest extends $dara.Model {
    * @remarks
    * The read/write mode. Valid values:
    * 
-   * - **ReadWrite**: Read/write (automatic read/write splitting)
-   * 
-   * - **ReadOnly**: Read-only
+   * - **ReadWrite**: read/write (automatic read/write splitting)
+   * - **ReadOnly**: read-only
    * 
    * @example
    * ReadWrite
@@ -185,9 +157,9 @@ export class ModifyDBClusterEndpointRequest extends $dara.Model {
    * @remarks
    * Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:
    * 
-   * - **ON**: Enable
+   * - **ON**: Enabled.
    * 
-   * - **OFF**: Disable
+   * - **OFF**: Disabled.
    * 
    * @example
    * on

package/src/models/RegisterKnowledgeBaseFileRequest.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class RegisterKnowledgeBaseFileRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The OSS object key of the uploaded file, excluding the oss://BucketName/ prefix.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf
+   */
+  filePath?: string;
+  /**
+   * @remarks
+   * The knowledge base ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-2ze123456789abcd
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The ID of the region where the knowledge base resides.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      filePath: 'FilePath',
+      knowledgeBaseId: 'KnowledgeBaseId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      filePath: 'string',
+      knowledgeBaseId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/RegisterKnowledgeBaseFileResponse.ts

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

@@ -0,0 +1,86 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class RegisterKnowledgeBaseFileResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The file ID, which is generated by the server based on the ETL rules for native OSS files.
+   * 
+   * @example
+   * 3566626f-3cc5-57a3-904c-e777b39baa3d
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The file name.
+   * 
+   * @example
+   * example.pdf
+   */
+  fileName?: string;
+  /**
+   * @remarks
+   * The OSS object key of the registered file.
+   * 
+   * @example
+   * pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf
+   */
+  filePath?: string;
+  /**
+   * @remarks
+   * Indicates whether an existing idempotent record is matched. Valid values:
+   * - true: An existing idempotent record is matched.
+   * - false: No existing idempotent record is matched.
+   * 
+   * @example
+   * false
+   */
+  idempotent?: boolean;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9C3E5A7B-12D4-4F68-9A01-2B3C4D5E6F70
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The file processing status.
+   * 
+   * @example
+   * DISPATCHED
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      fileId: 'FileId',
+      fileName: 'FileName',
+      filePath: 'FilePath',
+      idempotent: 'Idempotent',
+      requestId: 'RequestId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fileId: 'string',
+      fileName: 'string',
+      filePath: 'string',
+      idempotent: 'boolean',
+      requestId: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/RetrievalKnowledgeBaseRequest.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class RetrievalKnowledgeBaseRequest extends $dara.Model {
   /**
    * @remarks
-   * The unique ID of the knowledge base.
+   * The unique identifier of the knowledge base. You can specify multiple knowledge bases separated by commas. A maximum of 50 knowledge bases can be specified.
    * 
    * This parameter is required.
    * 
    * @example
-   * pkb-xxxxx
+   * pkb-1xxxxx,pkb-2xxxxx
    */
   knowledgeBaseId?: string;
   /**