@alicloud/polardb20170801 8.4.2 → 9.0.0

package/src/models/CreateDbclusterEndpointZonalRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDBClusterEndpointZonalRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to automatically add new nodes to this endpoint. Valid values:
+   * Specifies whether new nodes are automatically added to this endpoint. Valid values:
    * 
    * - Enable: New nodes are automatically added to this endpoint.
-   * 
-   * - Disable: New nodes are not automatically added to this endpoint. This is the default value.
+   * - Disable (default): New nodes are not automatically added to this endpoint.
    * 
    * @example
    * Disable
@@ -17,7 +16,7 @@ export class CreateDBClusterEndpointZonalRequest extends $dara.Model {
   autoAddNewNodes?: string;
   /**
    * @remarks
-   * A client token that is used to ensure the idempotence of the request. The client generates the value, which must be unique among different requests. The token is case-sensitive and can be up to 64 ASCII characters in length.
+   * 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******************
@@ -43,73 +42,41 @@ export class CreateDBClusterEndpointZonalRequest extends $dara.Model {
   DBEndpointDescription?: string;
   /**
    * @remarks
-   * The advanced configurations of the cluster endpoint, specified in the JSON format. This parameter supports settings for consistency level, transaction splitting, offloading reads from the primary node, and the connection pool.
-   * 
-   * - Sets the load balancing policy. The format is {"LoadBalancePolicy":"policy"}. Valid values:
-   * 
-   *   - **0**: Connections-based load balancing. This is the default value.
-   * 
-   *   - **1**: Active requests-based load balancing.
-   * 
-   * - Sets the consistency level. The format is `{"ConsistLevel":"level"}`. Valid values:
-   * 
-   *   - **0**: Eventual consistency.
-   * 
-   *   - **1**: Session consistency. This is the default value.
-   * 
-   *   - **2**: Global consistency.
-   * 
-   * - Sets transaction splitting. The format is `{"DistributedTransaction":"on/off"}`. Valid values:
-   * 
-   *   - **on**: Enables transaction splitting. This is the default value.
-   * 
-   *   - **off**: Disables transaction splitting.
-   * 
-   * - Specifies whether the primary node accepts read requests. The format is `{"MasterAcceptReads":"on/off"}`. Valid values:
-   * 
-   *   - **on**: The primary node accepts read requests.
-   * 
-   *   - **off**: The primary node does not accept read requests. This is the default value.
-   * 
-   * - Sets the connection pool. The format is `{"ConnectionPersist":"type"}`. Valid values:
-   * 
-   *   - **off**: Disables the connection pool. This is the default value.
-   * 
-   *   - **Session**: Enables the session-level connection pool.
-   * 
-   *   - **Transaction**: Enables transaction-level connection pooling.
-   * 
-   * - Sets parallel query. The format is {"MaxParallelDegree":"degree"}. Valid values:
-   * 
-   *   - A specific number of concurrent queries. Example: "MaxParallelDegree":"2".
-   * 
-   *   - **off**: Disables parallel query. This is the default value.
-   * 
-   * - Sets automatic routing for row store and column store. The format is {"EnableHtapImci":"on/off"}. Valid values:
-   * 
-   *   - **on**: Enables automatic routing for row store and column store.
-   * 
-   *   - **off**: Disables automatic routing for row store and column store. This is the default value.
-   * 
-   * - Specifies whether to enable overload protection. The format is {"EnableOverloadThrottle":"on/off"}. Valid values:
-   * 
-   *   - **on**: Enables overload protection.
-   * 
-   *   - **off**: Disables overload protection. This is the default value.
-   * 
-   * > * You can set transaction splitting, specify whether the primary node accepts read requests, configure the connection pool, and enable overload protection only when the read/write mode of the cluster endpoint for a PolarDB for MySQL cluster is set to \\*\\*ReadWrite\\*\\* (automatic read/write splitting).
-   * >
-   * > * When the read/write mode of the cluster endpoint for a PolarDB for MySQL cluster is set to **ReadOnly**, both **connections-based load balancing** and **active requests-based load balancing** are supported. When the read/write mode is set to **ReadWrite** (automatic read/write splitting), only **active requests-based load balancing** is supported.
-   * >
-   * > * You can enable automatic routing for row store and column store when the read/write mode of the cluster endpoint for a PolarDB for MySQL cluster is set to **ReadWrite** (automatic read/write splitting), or when the read/write mode is set to **ReadOnly** and the load balancing policy is set to **active requests-based load balancing**.
-   * >
-   * > * Only PolarDB for MySQL supports setting the consistency level to global consistency.
-   * >
-   * > * If you set the **ReadWriteMode** parameter to **ReadOnly**, you can only set the consistency level to **0**.
-   * >
-   * > * You can configure the consistency level, transaction splitting, whether the primary node accepts reads, 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, if the consistency level is set to **0**, you cannot enable transaction splitting. If the consistency level is set to **1** or **2**, 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.
+   * * Configure the load balancing policy. Format: {\\"LoadBalancePolicy\\":\\"Load balancing policy\\"}. Valid values:
+   *    * **0**: connection-based load balancing (default).
+   *    * **1**: active-request-based load balancing.
+   * * Configure the consistency level. Format: `{"ConsistLevel":"Consistency level"}`. Valid values:
+   *     * **0**: eventual consistency.
+   *     * **1**: session consistency (default).
+   *     * **2**: global consistency.
+   * * Configure transaction splitting. Format: `{"DistributedTransaction":"Transaction splitting"}`. Valid values:
+   *     * **on**: enables transaction splitting (default).
+   *     * **off**: disables transaction splitting.
+   * * Configure whether the primary node accepts read requests. 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).
+   * * Configure the connection pool. Format: `{"ConnectionPersist":"Connection pool"}`. Valid values:
+   *     * **off**: disables the connection pool (default).
+   *     * **Session**: enables the session-level connection pool.
+   *     * **Transaction**: enables the transaction-level connection pooling.
+   * * Configure parallel query. Format: {\\"MaxParallelDegree\\":\\"Parallel query\\"}. Valid values:
+   *     * A specific degree of parallelism. Example: "MaxParallelDegree":"2".
+   *     * **off**: disables parallel query (default).
+   * * Configure automatic request distribution among row store and column store nodes. Format: {\\"EnableHtapImci\\":\\"Automatic request distribution among row store and column store\\"}. 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).
+   * * Configure whether to enable overload protection. Format: {\\"EnableOverloadThrottle\\":\\"Enable 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 set to **read/write (automatic read/write splitting)**.
+   * >* When the read/write mode of the PolarDB for MySQL cluster endpoint is **read-only**, both **connection-based load balancing** and **active-request-based load balancing** are supported. When the read/write mode is **read/write (automatic read/write splitting)**, only **active-request-based load balancing** is supported.
+   * >* 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 **read/write (automatic read/write splitting)**, or when the read/write mode is **read-only** and the load balancing policy is **active-request-based load balancing**.
+   * >* Only PolarDB for MySQL supports setting the consistency level to global consistency.
+   * >* If the **ReadWriteMode** parameter 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"}`.
+   * >* The transaction splitting setting is constrained by the consistency level. For example, when the consistency level is set to **0**, transaction splitting cannot be enabled. When the consistency level is set to **1** or **2**, transaction splitting can be enabled.
    * 
    * @example
    * {"ConsistLevel": "1","DistributedTransaction": "on"}
@@ -117,7 +84,7 @@ export class CreateDBClusterEndpointZonalRequest extends $dara.Model {
   endpointConfig?: string;
   /**
    * @remarks
-   * The type of the custom cluster endpoint. The value is fixed to **Custom**.
+   * The type of the custom cluster endpoint. Set the value to **Custom**.
    * 
    * This parameter is required.
    * 
@@ -127,7 +94,7 @@ export class CreateDBClusterEndpointZonalRequest extends $dara.Model {
   endpointType?: string;
   /**
    * @remarks
-   * The read-only nodes to be added to the endpoint. Separate multiple node IDs with commas (,). By default, all nodes are added.
+   * The read load nodes to add to the endpoint. Separate multiple nodes with commas (,). By default, all nodes are included.
    * 
    * @example
    * pi-**************,pi-*************
@@ -137,11 +104,11 @@ export class CreateDBClusterEndpointZonalRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The policy for handling global consistency timeouts. Valid values:
+   * The timeout policy for global consistency. Valid values:
    * 
    * - 0: Sends the request to the primary node.
    * 
-   * - 2: Degrades to regular requests. If a global consistency read times out, the query is automatically degraded to a regular request, and the client does not receive an error message.
+   * - 2: Timeout degradation. When 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
@@ -159,9 +126,8 @@ export class CreateDBClusterEndpointZonalRequest extends $dara.Model {
    * @remarks
    * The read/write mode. Valid values:
    * 
-   * - ReadWrite: read and write (automatic read/write splitting).
-   * 
-   * - ReadOnly: read-only. This is the default value.
+   * - ReadWrite: read/write (automatic read/write splitting).
+   * - ReadOnly (default): read-only.
    * 
    * @example
    * ReadOnly
@@ -171,11 +137,11 @@ export class CreateDBClusterEndpointZonalRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * Specifies whether to enable the global consistency (high-performance mode) feature for the node. Valid values:
+   * Specifies whether to enable global consistency (high-performance mode) for the node. Valid values:
    * 
-   * - ON: Enables the feature.
+   * - ON: Enabled.
    * 
-   * - OFF: Disables the feature.
+   * - OFF: Disabled.
    * 
    * @example
    * on