@alicloud/polardb20170801 7.4.0 → 7.5.0

package/src/models/DescribeDbclusterPriceResponseBody.ts

@@ -0,0 +1,279 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeDBClusterPriceResponseBodyPriceInfoCouponsCoupon extends $dara.Model {
+  couponNo?: string;
+  isSelected?: string;
+  name?: string;
+  static names(): { [key: string]: string } {
+    return {
+      couponNo: 'CouponNo',
+      isSelected: 'IsSelected',
+      name: 'Name',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      couponNo: 'string',
+      isSelected: 'string',
+      name: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeDBClusterPriceResponseBodyPriceInfoCoupons extends $dara.Model {
+  coupon?: DescribeDBClusterPriceResponseBodyPriceInfoCouponsCoupon[];
+  static names(): { [key: string]: string } {
+    return {
+      coupon: 'Coupon',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      coupon: { 'type': 'array', 'itemType': DescribeDBClusterPriceResponseBodyPriceInfoCouponsCoupon },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.coupon)) {
+      $dara.Model.validateArray(this.coupon);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeDBClusterPriceResponseBodyPriceInfoRuleIds extends $dara.Model {
+  ruleId?: string[];
+  static names(): { [key: string]: string } {
+    return {
+      ruleId: 'RuleId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ruleId: { 'type': 'array', 'itemType': 'string' },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.ruleId)) {
+      $dara.Model.validateArray(this.ruleId);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeDBClusterPriceResponseBodyPriceInfo extends $dara.Model {
+  coupons?: DescribeDBClusterPriceResponseBodyPriceInfoCoupons;
+  /**
+   * @remarks
+   * The currency unit.
+   * 
+   * @example
+   * CNY
+   */
+  currency?: string;
+  /**
+   * @remarks
+   * The discount amount.
+   * 
+   * @example
+   * 1978.2
+   */
+  discountPrice?: number;
+  /**
+   * @remarks
+   * The original price.
+   * 
+   * @example
+   * 1099.0
+   */
+  originalPrice?: number;
+  ruleIds?: DescribeDBClusterPriceResponseBodyPriceInfoRuleIds;
+  /**
+   * @remarks
+   * The final price, which is the original price minus the discount.
+   * 
+   * @example
+   * 165.0
+   */
+  tradePrice?: number;
+  static names(): { [key: string]: string } {
+    return {
+      coupons: 'Coupons',
+      currency: 'Currency',
+      discountPrice: 'DiscountPrice',
+      originalPrice: 'OriginalPrice',
+      ruleIds: 'RuleIds',
+      tradePrice: 'TradePrice',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      coupons: DescribeDBClusterPriceResponseBodyPriceInfoCoupons,
+      currency: 'string',
+      discountPrice: 'number',
+      originalPrice: 'number',
+      ruleIds: DescribeDBClusterPriceResponseBodyPriceInfoRuleIds,
+      tradePrice: 'number',
+    };
+  }
+
+  validate() {
+    if(this.coupons && typeof (this.coupons as any).validate === 'function') {
+      (this.coupons as any).validate();
+    }
+    if(this.ruleIds && typeof (this.ruleIds as any).validate === 'function') {
+      (this.ruleIds as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeDBClusterPriceResponseBodyRulesRule extends $dara.Model {
+  name?: string;
+  ruleId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      name: 'Name',
+      ruleId: 'RuleId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      name: 'string',
+      ruleId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeDBClusterPriceResponseBodyRules extends $dara.Model {
+  rule?: DescribeDBClusterPriceResponseBodyRulesRule[];
+  static names(): { [key: string]: string } {
+    return {
+      rule: 'Rule',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      rule: { 'type': 'array', 'itemType': DescribeDBClusterPriceResponseBodyRulesRule },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.rule)) {
+      $dara.Model.validateArray(this.rule);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeDBClusterPriceResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The order type. Valid values:
+   * * BUY: new purchase.
+   * * UPGRADE: specification change.
+   * * RENEW: renewal.
+   * * CONVERT: billing method conversion.
+   * 
+   * @example
+   * BUY
+   */
+  orderType?: string;
+  /**
+   * @remarks
+   * The price details.
+   */
+  priceInfo?: DescribeDBClusterPriceResponseBodyPriceInfo;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 7E2FE3BB-C677-5FF9-9FC5-XXX
+   */
+  requestId?: string;
+  rules?: DescribeDBClusterPriceResponseBodyRules;
+  /**
+   * @remarks
+   * Indicates whether discounts are allowed.
+   * 
+   * @example
+   * False
+   */
+  showDiscount?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      orderType: 'OrderType',
+      priceInfo: 'PriceInfo',
+      requestId: 'RequestId',
+      rules: 'Rules',
+      showDiscount: 'ShowDiscount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      orderType: 'string',
+      priceInfo: DescribeDBClusterPriceResponseBodyPriceInfo,
+      requestId: 'string',
+      rules: DescribeDBClusterPriceResponseBodyRules,
+      showDiscount: 'boolean',
+    };
+  }
+
+  validate() {
+    if(this.priceInfo && typeof (this.priceInfo as any).validate === 'function') {
+      (this.priceInfo as any).validate();
+    }
+    if(this.rules && typeof (this.rules as any).validate === 'function') {
+      (this.rules as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

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.
    *