@alicloud/polardb20170801 5.4.0 → 5.4.1

package/dist/client.d.ts

@@ -2453,6 +2453,10 @@ export declare class DescribeDBClusterSSLResponseBodyItems extends $dara.Model {
      * pe-************
      */
     DBEndpointId?: string;
+    /**
+     * @example
+     * Enable
+     */
     SSLAutoRotate?: string;
     /**
      * @remarks
@@ -2558,7 +2562,7 @@ export declare class DescribeDBClusterVersionResponseBodyProxyRevisionVersionLis
      * *   **BETA**: a preview version
      *
      * @example
-     * Stable
+     * LTS
      */
     releaseType?: string;
     /**
@@ -4217,7 +4221,17 @@ export declare class DescribeGlobalDatabaseNetworkResponseBodyDBClustersDBNodes
 export declare class DescribeGlobalDatabaseNetworkResponseBodyDBClusters extends $dara.Model {
     /**
      * @remarks
-     * The edition of the cluster.
+     * The edition of the cluster. Valid values:
+     *
+     * Normal: Cluster Edition Basic: Single Node Edition Archive: X-Engine Edition NormalMultimaster: Multi-master Cluster Edition SENormal: Standard Edition
+     *
+     * >
+     *
+     * *   PolarDB for PostgreSQL clusters that run the PostgreSQL 11 database engine do not support Single Node Edition.
+     *
+     * *   PolarDB for MySQL 8.0 and 5.7 clusters, and PolarDB for PostgreSQL clusters that run the PostgreSQL 14 database engine support Standard Edition.
+     *
+     * *   PolarDB for MySQL 8.0 clusters support X-Engine Edition and Multi-master Cluster Edition.
      *
      * @example
      * Normal
@@ -5917,7 +5931,7 @@ export declare class DescribeVSwitchesResponseBodyVSwitchs extends $dara.Model {
     cidrBlock?: string;
     /**
      * @remarks
-     * The descriptions of the vSwitch.
+     * The description of the vSwitch.
      *
      * @example
      * vSwitchDescription
@@ -8338,8 +8352,10 @@ export declare class CreateDBClusterEndpointRequest extends $dara.Model {
     resourceOwnerId?: number;
     /**
      * @remarks
-     * Whether the node has enabled the global consistency (high-performance mode) feature. The value range is as follows:
-     * - **ON**: Enabled - **OFF**: Disabled
+     * Specifies whether to enable the global consistency (high-performance mode) feature for the nodes. Valid values:
+     *
+     * *   **ON**
+     * *   **OFF**
      *
      * @example
      * on
@@ -8727,12 +8743,18 @@ export declare class CreateDBNodesRequest extends $dara.Model {
     DBNode?: CreateDBNodesRequestDBNode[];
     /**
      * @remarks
-     * The type of the node. Valid values:
+     * The node type. Valid values:
      *
      * *   RO
      * *   STANDBY
      * *   DLNode
      *
+     * Enumerated values:
+     *
+     * *   DLNode: AI node
+     * *   STANDBY: standby node
+     * *   RO: read-only node
+     *
      * @example
      * RO
      */
@@ -10196,10 +10218,17 @@ export declare class DeleteDBNodesRequest extends $dara.Model {
     DBNodeId?: string[];
     /**
      * @remarks
-     * The type of the node. Valid values:
+     * The node type. Valid values:
      *
      * *   RO
      * *   STANDBY
+     * *   DLNode
+     *
+     * Enumerated values:
+     *
+     * *   DLNode: AI node
+     * *   STANDBY: standby node
+     * *   RO: read-only node
      *
      * @example
      * RO
@@ -11079,6 +11108,11 @@ export declare class DescribeActivationCodesRequest extends $dara.Model {
      * 2233****445566
      */
     aliyunOrderId?: string;
+    /**
+     * @example
+     * aa:bb:cc:dd:ee:ff
+     */
+    macAddress?: string;
     ownerAccount?: string;
     ownerId?: number;
     /**
@@ -11099,6 +11133,11 @@ export declare class DescribeActivationCodesRequest extends $dara.Model {
     pageSize?: number;
     resourceOwnerAccount?: string;
     resourceOwnerId?: number;
+    /**
+     * @example
+     * 3312548696141831911
+     */
+    systemIdentifier?: string;
     static names(): {
         [key: string]: string;
     };
@@ -11205,11 +11244,21 @@ export declare class DescribeActiveOperationTasksRequest extends $dara.Model {
     ownerAccount?: string;
     ownerId?: number;
     /**
+     * @remarks
+     * The page number of the page to return. The value must be an integer that is greater than 0. Default value: 1.
+     *
      * @example
      * 1
      */
     pageNumber?: number;
     /**
+     * @remarks
+     * The number of entries per page. Valid values:
+     *
+     * *   **30** (default)
+     * *   **50**
+     * *   **100**
+     *
      * @example
      * 30
      */
@@ -14291,6 +14340,10 @@ export declare class DescribeDBClusterTDEResponseBody extends $dara.Model {
      * 2a4f4ac2-****-****-****-************
      */
     encryptionKey?: string;
+    /**
+     * @example
+     * Enabled
+     */
     encryptionKeyStatus?: string;
     /**
      * @remarks
@@ -14873,7 +14926,7 @@ export declare class DescribeDBClustersWithBackupsRequest extends $dara.Model {
     pageNumber?: number;
     /**
      * @remarks
-     * The number of entries to return on each page. Valid values:
+     * The number of entries per page. Valid values:
      *
      * *   **30**
      * *   **50**
@@ -15631,7 +15684,7 @@ export declare class DescribeDasConfigRequest extends $dara.Model {
 export declare class DescribeDasConfigResponseBody extends $dara.Model {
     /**
      * @remarks
-     * Id of the request
+     * The request ID.
      *
      * @example
      * 593AE1C5-B70C-463F-9207-074639******
@@ -15639,7 +15692,10 @@ export declare class DescribeDasConfigResponseBody extends $dara.Model {
     requestId?: string;
     /**
      * @remarks
-     * Indicates whether the automatic storage expansion feature is enabled for the standard cluster.
+     * Specifies whether to enable automatic storage scaling for the Standard Edition cluster. Valid values:
+     *
+     * *   Enable
+     * *   Disable
      *
      * @example
      * Enable
@@ -15647,9 +15703,9 @@ export declare class DescribeDasConfigResponseBody extends $dara.Model {
     storageAutoScale?: string;
     /**
      * @remarks
-     * The maximum storage capacity of the standard cluster that is scaled up. Unit: GB.
+     * The maximum storage capacity that is allowed for storage automatic scaling of the Standard Edition cluster. Unit: GB.
      *
-     * >  This parameter is returned when the StorageAutoScale parameter is set to Enable.
+     * >  This parameter is valid only when the StorageAutoScale parameter is set to Enable.
      *
      * @example
      * 800
@@ -16182,7 +16238,7 @@ export declare class DescribeGlobalDatabaseNetworksRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * The page number. Default value: 1. The value must be an integer that is greater than 0.
+     * The number of the page to return. Default value: 1. The value must be an integer that is greater than 0.
      *
      * @example
      * 1
@@ -16190,7 +16246,7 @@ export declare class DescribeGlobalDatabaseNetworksRequest extends $dara.Model {
     pageNumber?: number;
     /**
      * @remarks
-     * The number of entries to return on each page. Default value: 30. Valid values:
+     * The number of entries per page. Default value: 30. Valid values:
      *
      * *   30
      * *   50
@@ -16654,7 +16710,7 @@ export declare class DescribeLicenseOrdersRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * The type of the package. Valid values:
+     * The plan type. Valid values:
      *
      * *   single_node_subscribe: Single-node Edition (Subscription).
      * *   single_node_long_term: Single-node Edition (Long-term).
@@ -17504,7 +17560,7 @@ export declare class DescribePendingMaintenanceActionRequest extends $dara.Model
     ownerId?: number;
     /**
      * @remarks
-     * The page number. The value of this parameter must be an integer that is greater than 0. Default value: **1**.
+     * The number of the page to return. Specify the parameter to a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.
      *
      * @example
      * 1
@@ -17512,7 +17568,7 @@ export declare class DescribePendingMaintenanceActionRequest extends $dara.Model
     pageNumber?: number;
     /**
      * @remarks
-     * The number of entries per page. Valid values: **30**, **50**, or **100**.
+     * The number of entries per page. Valid values: **30**, **50**, and **100**.
      *
      * Default value: **30**.
      *
@@ -18113,9 +18169,9 @@ export declare class DescribeSlowLogRecordsRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * Page number, with a range greater than 0 and not exceeding the maximum value of Integer.
+     * The page number. The value must be an integer that is greater than 0.
      *
-     * The default value is **1**.
+     * Default value: **1**.
      *
      * @example
      * 1
@@ -18123,12 +18179,13 @@ export declare class DescribeSlowLogRecordsRequest extends $dara.Model {
     pageNumber?: number;
     /**
      * @remarks
-     * Number of records per page, with the following options:
-     * * **30**
-     * * **50**
-     * * **100**
+     * The number of entries per page. Valid values:
      *
-     * The default value is **30**.
+     * *   **30**
+     * *   **50**
+     * *   **100**
+     *
+     * Default value: **30**.
      *
      * @example
      * 30
@@ -18295,7 +18352,7 @@ export declare class DescribeSlowLogsRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * The number of the page to return. Valid values: any non-zero positive integer.
+     * The page number. Pages start from 1.
      *
      * Default value: 1.
      *
@@ -18477,7 +18534,7 @@ export declare class DescribeTasksRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * The page number of the page to return. The value is an integer that is greater than 0.
+     * The page number. Pages start from page 1.
      *
      * Default value: **1**.
      *
@@ -18487,7 +18544,7 @@ export declare class DescribeTasksRequest extends $dara.Model {
     pageNumber?: number;
     /**
      * @remarks
-     * The number of entries to return per page. Valid values: **30**, **50**, and **100**.
+     * The number of entries per page. Valid values: **30**, **50**, and **100**.
      *
      * Default value: **30**.
      *
@@ -18746,7 +18803,7 @@ export declare class DescribeVSwitchesRequest extends $dara.Model {
     pageNumber?: number;
     /**
      * @remarks
-     * The number of entries to return per page. Maximum value: 50. Default value: 50.
+     * The number of entries to return on each page. Maximum value: 50. The default value is 50.
      *
      * @example
      * 50
@@ -18754,7 +18811,7 @@ export declare class DescribeVSwitchesRequest extends $dara.Model {
     pageSize?: number;
     /**
      * @remarks
-     * The ID of the region where the vSwitch belongs.
+     * The ID of the region where the vSwitch is deployed.
      *
      * @example
      * cn-hangzhou
@@ -18835,7 +18892,7 @@ export declare class DescribeVSwitchesResponseBody extends $dara.Model {
     totalCount?: number;
     /**
      * @remarks
-     * The details of the vSwitch.
+     * The vSwitches.
      */
     vSwitchs?: DescribeVSwitchesResponseBodyVSwitchs[];
     static names(): {
@@ -21307,11 +21364,6 @@ export declare class ModifyDBClusterEndpointRequest extends $dara.Model {
      * *   **ON**
      * *   **OFF**
      *
-     * Valid values:
-     *
-     * *   on
-     * *   off
-     *
      * @example
      * on
      */
@@ -21850,7 +21902,7 @@ export declare class ModifyDBClusterPrimaryZoneRequest extends $dara.Model {
     zoneId?: string;
     /**
      * @remarks
-     * The type of the zone. Valid values:
+     * The zone type. Valid values:
      *
      * *   **Primary**: primary zone
      * *   **Standby**: secondary zone
@@ -22254,7 +22306,6 @@ export declare class ModifyDBClusterServerlessConfRequest extends $dara.Model {
      *
      * @example
      * normal
-     * flexible
      */
     serverlessRuleMode?: string;
     /**
@@ -22323,6 +22374,14 @@ export declare class ModifyDBClusterServerlessConfResponse extends $dara.Model {
 }
 export declare class ModifyDBClusterStoragePerformanceRequest extends $dara.Model {
     /**
+     * @remarks
+     * Specifies whether to enable the I/O Burst feature for the ESSD AutoPL disk. Valid value:
+     *
+     * *   **true**
+     * *   **false** (default)
+     *
+     * >  This parameter is available only when the StorageType parameter is set to ESSDAUTOPL.
+     *
      * @example
      * false
      */
@@ -26924,7 +26983,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
-     * > You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
+     * >  You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
      *
      * @param request - DescribeDetachedBackupsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -26936,7 +26995,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * Before you call this operation, make sure that the PolarDB cluster is in the **Released** state. You must also confirm that the **Retain All Backups Permanently** or **Retain Last Automatic Backup Permanently** backup retention policy takes effect after you release the cluster. If you delete all backup sets after the cluster is released, you cannot use this API operation to query the cluster.
-     * > You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
+     * >  You can call the [DescribeDBClusterAttribute](https://help.aliyun.com/document_detail/98181.html) operation to query the cluster status.
      *
      * @param request - DescribeDetachedBackupsRequest
      * @returns DescribeDetachedBackupsResponse
@@ -27154,7 +27213,7 @@ export default class Client extends OpenApi {
      */
     describePendingMaintenanceAction(request: DescribePendingMaintenanceActionRequest): Promise<DescribePendingMaintenanceActionResponse>;
     /**
-     * Queries the numbers of pending events of different task types.
+     * Queries the numbers of scheduled events for different types of tasks.
      *
      * @param request - DescribePendingMaintenanceActionsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -27162,7 +27221,7 @@ export default class Client extends OpenApi {
      */
     describePendingMaintenanceActionsWithOptions(request: DescribePendingMaintenanceActionsRequest, runtime: $dara.RuntimeOptions): Promise<DescribePendingMaintenanceActionsResponse>;
     /**
-     * Queries the numbers of pending events of different task types.
+     * Queries the numbers of scheduled events for different types of tasks.
      *
      * @param request - DescribePendingMaintenanceActionsRequest
      * @returns DescribePendingMaintenanceActionsResponse