@alicloud/polardb20170801 7.3.0 → 7.5.0

package/src/models/DescribeDbclusterPriceShrinkRequest.ts

@@ -0,0 +1,272 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeDBClusterPriceShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The cluster edition. Valid values:
+   * - Normal: Cluster Edition.
+   * - Basic: Single Node Edition.
+   * - ArchiveNormal: Archive Database.
+   * - SENormal: Standard Edition.
+   * - NormalMultimaster: Multi-master Cluster.
+   * 
+   * @example
+   * Normal
+   */
+  creationCategory?: string;
+  /**
+   * @remarks
+   * The cluster ID. Required for non-BUY scenarios.
+   * 
+   * @example
+   * pc-**************
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The node specifications. Required for the BUY scenario. Example format: polar.mysql.x4.large.
+   * 
+   * @example
+   * polar.mysql.x4.large
+   */
+  DBNodeClass?: string;
+  /**
+   * @remarks
+   * The list of node IDs to delete. Used when ModifyType is set to DELETE.
+   * 
+   * @example
+   * pi-**************
+   */
+  DBNodeIds?: string[];
+  /**
+   * @remarks
+   * The number of nodes. Valid for the BUY scenario. This value includes the read/write node. Minimum value: 1. Default value: 1.
+   * 
+   * @example
+   * 2
+   */
+  DBNodeNum?: number;
+  /**
+   * @remarks
+   * The list of heterogeneous specification change nodes. Used for specification change scenarios to specify the target specifications for each node.
+   */
+  DBNodesShrink?: string;
+  /**
+   * @remarks
+   * The database engine type. Required for the BUY scenario. Valid values: MySQL, PostgreSQL, and Oracle.
+   * 
+   * @example
+   * MySQL
+   */
+  DBType?: string;
+  /**
+   * @remarks
+   * The database engine version. Required for the BUY scenario. Valid values for MySQL: 5.6, 5.7, and 8.0. Valid values for PostgreSQL: 11 and 14. Valid values for Oracle: 11 and 14.
+   * 
+   * @example
+   * 8.0
+   */
+  DBVersion?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable the hot standby cluster. Valid values:
+   * - ON: Enable.
+   * - OFF: Disable.
+   * 
+   * Valid for the BUY and specification change scenarios.
+   * 
+   * @example
+   * ON
+   */
+  hotStandbyCluster?: string;
+  /**
+   * @remarks
+   * The specification change direction. Valid values:
+   * - ADD: add nodes.
+   * - DELETE: remove nodes.
+   * - UPGRADE: upgrade specifications.
+   * - DOWNGRADE: downgrade specifications.
+   * - HOT_STANDBY: hot standby change.
+   * - STORAGE: storage space change.
+   * - STORAGE_TYPE: storage type change.
+   * 
+   * @example
+   * UPGRADE
+   */
+  modifyType?: string;
+  /**
+   * @remarks
+   * The order type. Valid values:
+   * - BUY: new purchase.
+   * - CONVERT: billing method conversion.
+   * - RENEW: renewal.
+   * - UPGRADE: upgrade specifications or add nodes.
+   * - DOWNGRADE: downgrade specifications or remove nodes.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * BUY
+   */
+  orderType?: string;
+  /**
+   * @remarks
+   * The billing method. Required for the BUY and CONVERT scenarios. Valid values:
+   * - Prepaid: subscription.
+   * - Postpaid: pay-as-you-go.
+   * 
+   * @example
+   * Prepaid
+   */
+  payType?: string;
+  /**
+   * @remarks
+   * The subscription cycle. Valid values:
+   * - Month: monthly.
+   * - Year: yearly.
+   * 
+   * @example
+   * Month
+   */
+  period?: string;
+  /**
+   * @remarks
+   * The provisioned IOPS. Used for the Standard Edition (SENormal) scenario.
+   * 
+   * @example
+   * 1000
+   */
+  provisionedIops?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The serverless type. Valid values: AgileServerless.
+   * 
+   * @example
+   * AgileServerless
+   */
+  serverlessType?: string;
+  /**
+   * @remarks
+   * The storage billing type. Valid values:
+   * - Prepaid: subscription.
+   * - Postpaid: pay-as-you-go.
+   * 
+   * @example
+   * Prepaid
+   */
+  storageChargeType?: string;
+  /**
+   * @remarks
+   * The storage space, in GB. Used for prepaid storage or storage specification change scenarios.
+   * 
+   * @example
+   * 50
+   */
+  storageSpace?: string;
+  /**
+   * @remarks
+   * The storage type. Valid values:
+   * - PSL5: high performance.
+   * - PSL4: standard.
+   * - ESSDPL0
+   * - ESSDPL1
+   * - ESSDPL2
+   * - ESSDPL3
+   * - ESSDAUTOPL
+   * 
+   * @example
+   * PSL5
+   */
+  storageType?: string;
+  /**
+   * @remarks
+   * The subscription duration. Used together with Period. Valid for the BUY, CONVERT, and RENEW scenarios when the billing method is Prepaid.
+   * 
+   * @example
+   * 1
+   */
+  usedTime?: string;
+  /**
+   * @remarks
+   * The zone ID. We recommend that you specify this parameter for the BUY scenario.
+   * 
+   * @example
+   * cn-hangzhou-h
+   */
+  zoneId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      creationCategory: 'CreationCategory',
+      DBClusterId: 'DBClusterId',
+      DBNodeClass: 'DBNodeClass',
+      DBNodeIds: 'DBNodeIds',
+      DBNodeNum: 'DBNodeNum',
+      DBNodesShrink: 'DBNodes',
+      DBType: 'DBType',
+      DBVersion: 'DBVersion',
+      hotStandbyCluster: 'HotStandbyCluster',
+      modifyType: 'ModifyType',
+      orderType: 'OrderType',
+      payType: 'PayType',
+      period: 'Period',
+      provisionedIops: 'ProvisionedIops',
+      regionId: 'RegionId',
+      serverlessType: 'ServerlessType',
+      storageChargeType: 'StorageChargeType',
+      storageSpace: 'StorageSpace',
+      storageType: 'StorageType',
+      usedTime: 'UsedTime',
+      zoneId: 'ZoneId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      creationCategory: 'string',
+      DBClusterId: 'string',
+      DBNodeClass: 'string',
+      DBNodeIds: { 'type': 'array', 'itemType': 'string' },
+      DBNodeNum: 'number',
+      DBNodesShrink: 'string',
+      DBType: 'string',
+      DBVersion: 'string',
+      hotStandbyCluster: 'string',
+      modifyType: 'string',
+      orderType: 'string',
+      payType: 'string',
+      period: 'string',
+      provisionedIops: 'string',
+      regionId: 'string',
+      serverlessType: 'string',
+      storageChargeType: 'string',
+      storageSpace: 'string',
+      storageType: 'string',
+      usedTime: 'string',
+      zoneId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.DBNodeIds)) {
+      $dara.Model.validateArray(this.DBNodeIds);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeDbclusterSslrequest.ts

@@ -6,8 +6,7 @@ export class DescribeDBClusterSSLRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to view detailed information about all clusters under your account, including cluster IDs.
+   * >You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/98094.html) operation to query the details of all clusters under your account, including the cluster ID.
    * 
    * This parameter is required.
    * 
@@ -17,6 +16,11 @@ export class DescribeDBClusterSSLRequest extends $dara.Model {
   DBClusterId?: string;
   ownerAccount?: string;
   ownerId?: number;
+  /**
+   * @example
+   * pfs-xxx
+   */
+  pfsInstanceId?: string;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   static names(): { [key: string]: string } {
@@ -24,6 +28,7 @@ export class DescribeDBClusterSSLRequest extends $dara.Model {
       DBClusterId: 'DBClusterId',
       ownerAccount: 'OwnerAccount',
       ownerId: 'OwnerId',
+      pfsInstanceId: 'PfsInstanceId',
       resourceOwnerAccount: 'ResourceOwnerAccount',
       resourceOwnerId: 'ResourceOwnerId',
     };
@@ -34,6 +39,7 @@ export class DescribeDBClusterSSLRequest extends $dara.Model {
       DBClusterId: 'string',
       ownerAccount: 'string',
       ownerId: 'number',
+      pfsInstanceId: 'string',
       resourceOwnerAccount: 'string',
       resourceOwnerId: 'number',
     };

package/src/models/DescribeDbclusterSslresponseBody.ts

@@ -13,13 +13,13 @@ export class DescribeDBClusterSSLResponseBodyItems extends $dara.Model {
   DBEndpointId?: string;
   /**
    * @remarks
-   * Indicates whether automatic rotation of SSL certificates is enabled. Valid values:
+   * Indicates whether automatic SSL certificate rotation is enabled. Valid values:
    * 
-   * - **Enable**: enabled
+   * - **Enable**: Enabled.
    * 
-   * - **Disable**: disabled
+   * - **Disable**: Disabled.
    * 
-   * > This parameter is supported only when the database engine is compatible with PostgreSQL or Oracle syntax.
+   * > This parameter is supported only when the database engine is PostgreSQL-compatible or Oracle-syntax-compatible.
    * 
    * @example
    * Enable
@@ -27,7 +27,7 @@ export class DescribeDBClusterSSLResponseBodyItems extends $dara.Model {
   SSLAutoRotate?: string;
   /**
    * @remarks
-   * The SSL connection endpoint.
+   * The SSL connection address.
    * 
    * @example
    * pc-************.mysql.polardb.rds.aliyuncs.com
@@ -35,11 +35,10 @@ export class DescribeDBClusterSSLResponseBodyItems extends $dara.Model {
   SSLConnectionString?: string;
   /**
    * @remarks
-   * Indicates whether SSL encryption is enabled. Valid values:
+   * Indicates whether Secure Sockets Layer (SSL) encryption is enabled. Valid values:
    * 
-   * - **Enabled**: enabled.
-   * 
-   * - **Disabled**: disabled.
+   * - **Enabled**: Enabled.
+   * - **Disabled**: Shutdown.
    * 
    * @example
    * Enabled
@@ -47,7 +46,7 @@ export class DescribeDBClusterSSLResponseBodyItems extends $dara.Model {
   SSLEnabled?: string;
   /**
    * @remarks
-   * The certificate validity period. Format: `yyyy-MM-ddTHH:mm:ssZ` (UTC time).
+   * The expiration time of the SSL certificate. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format (UTC).
    * 
    * @example
    * 2021-11-13T07:14:22Z
@@ -85,7 +84,7 @@ export class DescribeDBClusterSSLResponseBodyItems extends $dara.Model {
 export class DescribeDBClusterSSLResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of SSL connection information.
+   * The list of SSL connection information.
    */
   items?: DescribeDBClusterSSLResponseBodyItems[];
   /**
@@ -98,11 +97,11 @@ export class DescribeDBClusterSSLResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether automatic rotation of SSL certificates is enabled. Valid values:
+   * Indicates whether automatic SSL certificate rotation is enabled. Valid values:
    * 
-   * - **Enable**: enabled
+   * - **Enable**: Enabled.
    * 
-   * - **Disable**: disabled
+   * - **Disable**: Disabled.
    * 
    * > This parameter is supported only for PolarDB for MySQL.
    * 

package/src/models/DescribePolarFsAttributeResponseBody.ts

@@ -42,6 +42,84 @@ export class DescribePolarFsAttributeResponseBodyCustomBucketPathList extends $d
   }
 }
 
+export class DescribePolarFsAttributeResponseBodyEndpointItemsAddressItems extends $dara.Model {
+  connectionString?: string;
+  IPAddress?: string;
+  netType?: string;
+  port?: string;
+  VPCId?: string;
+  vSwitchId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      connectionString: 'ConnectionString',
+      IPAddress: 'IPAddress',
+      netType: 'NetType',
+      port: 'Port',
+      VPCId: 'VPCId',
+      vSwitchId: 'VSwitchId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      connectionString: 'string',
+      IPAddress: 'string',
+      netType: 'string',
+      port: 'string',
+      VPCId: 'string',
+      vSwitchId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribePolarFsAttributeResponseBodyEndpointItems extends $dara.Model {
+  addressItems?: DescribePolarFsAttributeResponseBodyEndpointItemsAddressItems[];
+  /**
+   * @example
+   * ep-xxxxxxxxx
+   */
+  DBEndpointId?: string;
+  /**
+   * @example
+   * S3Gateway
+   */
+  endpointType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      addressItems: 'AddressItems',
+      DBEndpointId: 'DBEndpointId',
+      endpointType: 'EndpointType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      addressItems: { 'type': 'array', 'itemType': DescribePolarFsAttributeResponseBodyEndpointItemsAddressItems },
+      DBEndpointId: 'string',
+      endpointType: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.addressItems)) {
+      $dara.Model.validateArray(this.addressItems);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class DescribePolarFsAttributeResponseBodyMountInfo extends $dara.Model {
   /**
    * @remarks
@@ -103,7 +181,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   accelerateType?: string;
   /**
    * @remarks
-   * The acceleration storage space, in GB.
+   * The acceleration storage space. Unit: GB.
    * 
    * @example
    * 1000
@@ -111,9 +189,9 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   acceleratedStorageSpace?: number;
   /**
    * @remarks
-   * Indicates whether the acceleration cache is enabled. Valid values:
-   * - **ON**: enabled.
-   * - **OFF**: disabled.
+   * Specifies whether the acceleration cache is enabled. Valid values:
+   * - **ON**: Enabled.
+   * - **OFF**: Disabled.
    * 
    * @example
    * ON
@@ -121,7 +199,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   acceleratingEnable?: string;
   /**
    * @remarks
-   * The bandwidth, in MB/s.
+   * The bandwidth. Unit: MB/s.
    * 
    * @example
    * 100
@@ -129,7 +207,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   bandwidth?: number;
   /**
    * @remarks
-   * The bandwidth baseline, in MB/s/TiB.
+   * The bandwidth baseline. Unit: MB/s/TiB.
    * 
    * @example
    * 100
@@ -137,7 +215,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   bandwidthBaseLine?: number;
   /**
    * @remarks
-   * The storage bucket ID.
+   * The bucket ID.
    * 
    * @example
    * xxx
@@ -186,21 +264,23 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
    * The list of custom storage paths.
    */
   customBucketPathList?: DescribePolarFsAttributeResponseBodyCustomBucketPathList[];
+  DBEndpointId?: string;
   /**
    * @remarks
    * The database ecosystem type. Valid values: 
    * * **MySQL**
-   * * **PostgreSQL**.
+   * * **PostgreSQL**
    * 
    * @example
    * MySQL
    */
   DBType?: string;
+  endpointItems?: DescribePolarFsAttributeResponseBodyEndpointItems[];
   /**
    * @remarks
    * The expiration time of the cluster.
    * 
-   * > This parameter is returned only for clusters whose billing method is **Prepaid** (subscription). An empty value is returned for **Postpaid** (pay-as-you-go) clusters.
+   * > This parameter is returned only for clusters that use the **Prepaid** (subscription) billing method. An empty value is returned for **Postpaid** (pay-as-you-go) clusters.
    * 
    * @example
    * 2025-10-10T16:00:00Z
@@ -209,7 +289,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   /**
    * @remarks
    * Indicates whether the cluster has expired.
-   * > This parameter is returned only for clusters whose billing method is **Prepaid** (subscription).
+   * > This parameter is returned only for clusters that use the **Prepaid** (subscription) billing method.
    * 
    * @example
    * false
@@ -227,22 +307,25 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
    * @remarks
    * The lock mode. Valid values: 
    * 
-   * - **Unlock**: not locked.
-   * - **ManualLock**: manually locked. 
-   * - **LockByExpiration**: automatically locked due to cluster expiration.
+   * - **Unlock**: Not locked.
+   * - **ManualLock**: Manually locked. 
+   * - **LockByExpiration**: Automatically locked due to cluster expiration.
    * 
    * @example
    * Unlock
    */
   lockMode?: string;
+  maxscaleEndpointId?: string;
+  metaConnString?: string;
   /**
    * @example
    * pc-xxxxxxxxxxxxxxxxx
    */
   metaInstanceName?: string;
+  metaMxsConnString?: string;
   /**
    * @remarks
-   * The metadata URL for Fuse mounting (encrypted).
+   * The encrypted metadata URL for Fuse mounting.
    * 
    * @example
    * e6cc1d2e2a6fa292038d999fda6501*****
@@ -299,7 +382,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   /**
    * @remarks
    * The instance version. Valid values:
-   * - **PolarFS 2.0**: 2.0
+   * - **PolarFS 2.0**: 2.0.
    * - **PolarFS 1.0**: 1.0.
    * 
    * @example
@@ -356,7 +439,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   securityGroupId?: string;
   /**
    * @remarks
-   * The storage space, in GB.
+   * The storage space. Unit: GB.
    * 
    * @example
    * 1000
@@ -364,11 +447,11 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   storageSpace?: number;
   /**
    * @remarks
-   * Valid values for the High-performance Edition storage type:
+   * The storage type for the High-performance Edition. Valid values:
    * * **ESSDPL1**
    * * **ESSDPL0**
    * 
-   * Valid values for the Basic Edition storage type:
+   * The storage type for the Basic Edition. Valid values:
    * * **city_redundancy**: zone-redundant storage.
    * 
    * @example
@@ -377,12 +460,22 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   storageType?: string;
   /**
    * @remarks
-   * The used storage space, in bytes.
+   * The used storage space. Unit: bytes.
    * 
    * @example
    * 3012558848
    */
   storageUsed?: number;
+  /**
+   * @example
+   * lakebase_acc
+   */
+  userDefaultAccName?: string;
+  /**
+   * @example
+   * EncryptedSecretKey==
+   */
+  userDefaultAccSk?: string;
   /**
    * @remarks
    * The VPC ID.
@@ -420,12 +513,17 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
       createTime: 'CreateTime',
       customBucketPath: 'CustomBucketPath',
       customBucketPathList: 'CustomBucketPathList',
+      DBEndpointId: 'DBEndpointId',
       DBType: 'DBType',
+      endpointItems: 'EndpointItems',
       expireTime: 'ExpireTime',
       expired: 'Expired',
       fileSystemId: 'FileSystemId',
       lockMode: 'LockMode',
+      maxscaleEndpointId: 'MaxscaleEndpointId',
+      metaConnString: 'MetaConnString',
       metaInstanceName: 'MetaInstanceName',
+      metaMxsConnString: 'MetaMxsConnString',
       metaUrl: 'MetaUrl',
       minorVersion: 'MinorVersion',
       mountInfo: 'MountInfo',
@@ -443,6 +541,8 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
       storageSpace: 'StorageSpace',
       storageType: 'StorageType',
       storageUsed: 'StorageUsed',
+      userDefaultAccName: 'UserDefaultAccName',
+      userDefaultAccSk: 'UserDefaultAccSk',
       VPCId: 'VPCId',
       vSwitchId: 'VSwitchId',
       zoneId: 'ZoneId',
@@ -462,12 +562,17 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
       createTime: 'string',
       customBucketPath: 'string',
       customBucketPathList: { 'type': 'array', 'itemType': DescribePolarFsAttributeResponseBodyCustomBucketPathList },
+      DBEndpointId: 'string',
       DBType: 'string',
+      endpointItems: { 'type': 'array', 'itemType': DescribePolarFsAttributeResponseBodyEndpointItems },
       expireTime: 'string',
       expired: 'string',
       fileSystemId: 'string',
       lockMode: 'string',
+      maxscaleEndpointId: 'string',
+      metaConnString: 'string',
       metaInstanceName: 'string',
+      metaMxsConnString: 'string',
       metaUrl: 'string',
       minorVersion: 'string',
       mountInfo: DescribePolarFsAttributeResponseBodyMountInfo,
@@ -485,6 +590,8 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
       storageSpace: 'number',
       storageType: 'string',
       storageUsed: 'number',
+      userDefaultAccName: 'string',
+      userDefaultAccSk: 'string',
       VPCId: 'string',
       vSwitchId: 'string',
       zoneId: 'string',
@@ -495,6 +602,9 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
     if(Array.isArray(this.customBucketPathList)) {
       $dara.Model.validateArray(this.customBucketPathList);
     }
+    if(Array.isArray(this.endpointItems)) {
+      $dara.Model.validateArray(this.endpointItems);
+    }
     if(this.mountInfo && typeof (this.mountInfo as any).validate === 'function') {
       (this.mountInfo as any).validate();
     }