@alicloud/polardb20170801 7.2.0 → 7.4.0

package/dist/models/CreateDbclusterEndpointRequest.d.ts

@@ -2,11 +2,9 @@ import * as $dara from '@darabonba/typescript';
 export declare class CreateDBClusterEndpointRequest extends $dara.Model {
     /**
      * @remarks
-     * Specifies whether to automatically add new nodes to the endpoint. Valid values:
-     *
-     * - **Enable**: Automatically adds new nodes to the endpoint.
-     *
-     * - **Disable** (default): Does not automatically add new nodes to the endpoint.
+     * Specifies whether new nodes are automatically added to this endpoint. Valid values:
+     * * **Enable**: New nodes are automatically added to this endpoint.
+     * * **Disable** (default): New nodes are not automatically added to this endpoint.
      *
      * @example
      * Disable
@@ -14,7 +12,7 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
     autoAddNewNodes?: string;
     /**
      * @remarks
-     * A client-generated token to ensure the idempotence of the request. The token must be unique, case-sensitive, and a maximum of 64 ASCII characters.
+     * The client token that is used to ensure the idempotence of the request and prevent repeated submissions. The token is generated by the client, must be unique across requests, is case-sensitive, and cannot exceed 64 ASCII characters in length.
      *
      * @example
      * 6000170000591aed949d0f******************
@@ -40,73 +38,41 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
     DBEndpointDescription?: string;
     /**
      * @remarks
-     * The advanced configurations for the custom cluster endpoint, specified as a JSON string. You can configure features such as consistency level, transaction splitting, whether the primary node accepts read requests, connection pool, and load balancing policy.
-     *
-     * - Specifies the load balancing policy. The format is {"LoadBalancePolicy":"policy"}. Valid values:
-     *
-     *   - **0**: connections-based load balancing (default).
-     *
-     *   - **1**: active requests-based load balancing.
-     *
-     * - Specifies the consistency level. The format is `{"ConsistLevel":"level"}`. Valid values:
-     *
-     *   - **0**: eventual consistency.
-     *
-     *   - **1**: session consistency (default).
-     *
-     *   - **2**: global consistency.
-     *
-     * - Specifies whether to enable transaction splitting. The format is `{"DistributedTransaction":"status"}`. Valid values:
-     *
-     *   - **on**: enables transaction splitting (default).
-     *
-     *   - **off**: disables transaction splitting.
-     *
-     * - Specifies whether the primary node accepts read requests. The format is `{"MasterAcceptReads":"status"}`. Valid values:
-     *
-     *   - **on**: The primary node accepts read requests.
-     *
-     *   - **off**: The primary node does not accept read requests (default).
-     *
-     * - Specifies whether to enable the connection pool. The format is `{"ConnectionPersist":"status"}`. Valid values:
-     *
-     *   - **off**: disables the connection pool (default).
-     *
-     *   - **Session**: enables the session-level connection pool.
-     *
-     *   - **Transaction**: enables the transaction-level connection pool.
-     *
-     * - Specifies the degree of parallelism for a parallel query. The format is {"MaxParallelDegree":"degree"}. Valid values:
-     *
-     *   - A specific integer that specifies the degree of parallelism. For example: "MaxParallelDegree":"2".
-     *
-     *   - **off**: disables parallel query (default).
-     *
-     * - Specifies whether to enable automatic routing between row store and column store. The format is {"EnableHtapImci":"status"}. Valid values:
-     *
-     *   - **on**: enables automatic routing.
-     *
-     *   - **off**: disables automatic routing (default).
-     *
-     * - Specifies whether to enable overload protection. The format is {"EnableOverloadThrottle":"status"}. Valid values:
-     *
-     *   - **on**: enables overload protection.
-     *
-     *   - **off**: disables overload protection (default).
-     *
-     * > * You can configure transaction splitting, whether the primary node accepts read requests, the connection pool, and overload protection only for a PolarDB for MySQL endpoint in **ReadWrite** (automatic read/write splitting) mode.
-     * >
-     * > * A PolarDB for MySQL cluster endpoint in **ReadOnly** mode supports both **connections-based load balancing** and **active requests-based load balancing**. An endpoint in **ReadWrite** (automatic read/write splitting) mode supports only **active requests-based load balancing**.
-     * >
-     * > * You can enable automatic routing between row store and 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 load balancing**.
-     * >
-     * > * Only PolarDB for MySQL clusters support global consistency.
-     * >
-     * > * If you set **ReadWriteMode** to **ReadOnly**, the consistency level must be **0** (eventual consistency).
-     * >
-     * > * You can configure the consistency level, transaction splitting, whether the primary node accepts read requests, and the connection pool at the same time. Example: `{"ConsistLevel":"1","DistributedTransaction":"on","ConnectionPersist":"Session","MasterAcceptReads":"on"}`.
-     * >
-     * > * The setting for transaction splitting depends on the consistency level. For example, if you set the consistency level to **0** (eventual consistency), you cannot enable transaction splitting. If you set the consistency level to **1** (session consistency) or **2** (global consistency), you can enable transaction splitting.
+     * The advanced configurations of the cluster endpoint in JSON format. You can configure the consistency level, transaction splitting, offload reads from primary node, and connection pool settings.
+     * * Load balancing policy. Format: {\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}. Valid values:
+     *    * **0**: connection-based load balancing (default).
+     *    * **1**: active-request-based load balancing.
+     * * Consistency level. Format: `{"ConsistLevel":"Consistency level"}`. Valid values:
+     *     * **0**: eventual consistency.
+     *     * **1**: session consistency (default).
+     *     * **2**: global consistency.
+     * * Transaction splitting. Format: `{"DistributedTransaction":"Transaction splitting"}`. Valid values:
+     *     * **on**: enables transaction splitting (default).
+     *     * **off**: disables transaction splitting.
+     * * Offload reads from primary node. Format: `{"MasterAcceptReads":"Offload reads from primary node"}`. Valid values:
+     *     * **on**: the primary node accepts read requests.
+     *     * **off**: the primary node does not accept read requests (default).
+     * * Connection pool. Format: `{"ConnectionPersist":"Connection pool"}`. Valid values:
+     *     * **off**: disables the connection pool (default).
+     *     * **Session**: enables session-level connection pooling.
+     *     * **Transaction**: enables transaction-level connection pooling.
+     * * Parallel query. Format: {\\"MaxParallelDegree\\":\\"Parallel query\\"}. Valid values:
+     *     * A specific degree of parallelism. Example: "MaxParallelDegree":"2".
+     *     * **off**: disables parallel query (default).
+     * * Automatic request distribution among row store and column store nodes. Format: {\\"EnableHtapImci\\":\\"Automatic request distribution among row store and column store nodes\\"}. Valid values:
+     *     * **on**: enables automatic request distribution among row store and column store nodes.
+     *     * **off**: disables automatic request distribution among row store and column store nodes (default).
+     * * Overload protection. Format: {\\"EnableOverloadThrottle\\":\\"Overload protection\\"}. Valid values:
+     *    * **on**: enables overload protection.
+     *    * **off**: disables overload protection (default).
+     *
+     * > * Transaction splitting, offload reads from primary node, connection pool, 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** are supported. The **ReadWrite (automatic read/write splitting)** mode supports only **active-request-based load balancing**.
+     * >* Automatic request distribution among row store and column store 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, offload reads from primary node, and connection pool 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"}
@@ -114,7 +80,11 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
     endpointConfig?: string;
     /**
      * @remarks
-     * The type of the custom cluster endpoint. Set the value to **Custom**.
+     * The type of the custom cluster endpoint. Valid values:
+     *
+     * - **Custom**: custom cluster endpoint.
+     *
+     * - **DynamoDB**: DynamoDB endpoint.
      *
      * This parameter is required.
      *
@@ -124,17 +94,14 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
     endpointType?: string;
     /**
      * @remarks
-     * The nodes to associate with the endpoint. Separate multiple node IDs with a comma (,). If you omit this parameter, all nodes in the cluster are added by default.
-     *
-     * > - For a PolarDB for MySQL cluster, specify the node IDs.
-     * >
-     * > - For a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (compatible with Oracle) cluster, specify the roles of the nodes, such as `Writer,Reader1,Reader2`.
-     * >
-     * > - If you set **ReadWriteMode** to **ReadOnly**, you can associate only one node with the endpoint. If this node fails, the endpoint may be unavailable for up to 1 hour. This configuration is not recommended for a production environment. To improve availability, associate at least two nodes with the endpoint.
-     * >
-     * > - If you set **ReadWriteMode** to **ReadWrite**, you must associate at least two nodes with the endpoint.
-     * >   \\* For a PolarDB for MySQL cluster, you can select any two nodes. If both nodes are read-only nodes, write requests are routed to the primary node.
-     * >   \\* For a PolarDB for PostgreSQL cluster or a PolarDB for PostgreSQL (compatible with Oracle) cluster, the primary node must be included.
+     * The read load nodes to add to the endpoint. Separate multiple nodes with commas (,). By default, all nodes are added.
+     *
+     * > * 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.
+     *     * For PolarDB for MySQL, you can select any two nodes. If both nodes are read-only nodes, write requests are forwarded to the primary node.
+     *     * For PolarDB for PostgreSQL and PolarDB for PostgreSQL (Compatible with Oracle), the primary node must be included.
      *
      * @example
      * pi-**********,pi-*********
@@ -143,17 +110,20 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
     ownerAccount?: string;
     ownerId?: number;
     /**
+     * @remarks
+     * The PolarFs instance ID.
+     *
      * @example
      * pfs-test****
      */
     polarFsInstanceId?: string;
     /**
      * @remarks
-     * The policy for handling global consistency read timeouts. Valid values:
+     * The timeout policy for global consistency. Valid values:
      *
-     * - **0**: Send the request to the primary node.
+     * - **0**: sends the request to the primary node.
      *
-     * - **2**: Downgrade to a regular request. If a global consistency read times out, the query is automatically downgraded, and the client does not receive an error.
+     * - **2**: timeout degradation. After a global consistency read times out, the query is automatically degraded to regular requests, and the client does not receive an error message.
      *
      * @example
      * 0
@@ -172,7 +142,6 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
      * The read/write mode. Valid values:
      *
      * - **ReadWrite**: read/write (automatic read/write splitting).
-     *
      * - **ReadOnly** (default): read-only.
      *
      * @example
@@ -183,22 +152,28 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
     resourceOwnerId?: number;
     /**
      * @remarks
-     * Specifies whether to enable global consistency (high-performance mode). Valid values:
+     * Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:
      *
-     * - **ON**: Enables the feature.
+     * - **ON**: enabled.
      *
-     * - **OFF**: Disables the feature.
+     * - **OFF**: disabled.
      *
      * @example
      * on
      */
     sccMode?: string;
     /**
+     * @remarks
+     * The VPC ID.
+     *
      * @example
      * vpc-2zehr7ghqovftils0****
      */
     VPCId?: string;
     /**
+     * @remarks
+     * The vSwitch ID.
+     *
      * @example
      * vsw-2ze775gnf7jn33ua****
      */

package/dist/models/CreateDbclusterEndpointRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"CreateDbclusterEndpointRequest.js","sourceRoot":"","sources":["../../src/models/CreateDbclusterEndpointRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,8BAA+B,SAAQ,KAAK,CAAC,KAAK;IA4M7D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,iBAAiB;YAClC,WAAW,EAAE,aAAa;YAC1B,WAAW,EAAE,aAAa;YAC1B,qBAAqB,EAAE,uBAAuB;YAC9C,cAAc,EAAE,gBAAgB;YAChC,YAAY,EAAE,cAAc;YAC5B,KAAK,EAAE,OAAO;YACd,YAAY,EAAE,cAAc;YAC5B,OAAO,EAAE,SAAS;YAClB,iBAAiB,EAAE,mBAAmB;YACtC,qBAAqB,EAAE,uBAAuB;YAC9C,mBAAmB,EAAE,qBAAqB;YAC1C,aAAa,EAAE,eAAe;YAC9B,oBAAoB,EAAE,sBAAsB;YAC5C,eAAe,EAAE,iBAAiB;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,WAAW,EAAE,QAAQ;YACrB,WAAW,EAAE,QAAQ;YACrB,qBAAqB,EAAE,QAAQ;YAC/B,cAAc,EAAE,QAAQ;YACxB,YAAY,EAAE,QAAQ;YACtB,KAAK,EAAE,QAAQ;YACf,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,QAAQ;YACjB,iBAAiB,EAAE,QAAQ;YAC3B,qBAAqB,EAAE,QAAQ;YAC/B,mBAAmB,EAAE,QAAQ;YAC7B,aAAa,EAAE,QAAQ;YACvB,oBAAoB,EAAE,QAAQ;YAC9B,eAAe,EAAE,QAAQ;YACzB,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,QAAQ;YACf,SAAS,EAAE,QAAQ;SACpB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAjQD,wEAiQC"}
+{"version":3,"file":"CreateDbclusterEndpointRequest.js","sourceRoot":"","sources":["../../src/models/CreateDbclusterEndpointRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,8BAA+B,SAAQ,KAAK,CAAC,KAAK;IAmL7D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,iBAAiB;YAClC,WAAW,EAAE,aAAa;YAC1B,WAAW,EAAE,aAAa;YAC1B,qBAAqB,EAAE,uBAAuB;YAC9C,cAAc,EAAE,gBAAgB;YAChC,YAAY,EAAE,cAAc;YAC5B,KAAK,EAAE,OAAO;YACd,YAAY,EAAE,cAAc;YAC5B,OAAO,EAAE,SAAS;YAClB,iBAAiB,EAAE,mBAAmB;YACtC,qBAAqB,EAAE,uBAAuB;YAC9C,mBAAmB,EAAE,qBAAqB;YAC1C,aAAa,EAAE,eAAe;YAC9B,oBAAoB,EAAE,sBAAsB;YAC5C,eAAe,EAAE,iBAAiB;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,WAAW;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,eAAe,EAAE,QAAQ;YACzB,WAAW,EAAE,QAAQ;YACrB,WAAW,EAAE,QAAQ;YACrB,qBAAqB,EAAE,QAAQ;YAC/B,cAAc,EAAE,QAAQ;YACxB,YAAY,EAAE,QAAQ;YACtB,KAAK,EAAE,QAAQ;YACf,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,QAAQ;YACjB,iBAAiB,EAAE,QAAQ;YAC3B,qBAAqB,EAAE,QAAQ;YAC/B,mBAAmB,EAAE,QAAQ;YAC7B,aAAa,EAAE,QAAQ;YACvB,oBAAoB,EAAE,QAAQ;YAC9B,eAAe,EAAE,QAAQ;YACzB,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,QAAQ;YACf,SAAS,EAAE,QAAQ;SACpB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAxOD,wEAwOC"}