@alicloud/polardb20170801 7.4.0 → 7.5.0

package/src/models/DescribeConsumersRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeConsumersRequest extends $dara.Model {
   /**
    * @remarks
-   * The consumer group ID.
+   * The user group ID.
    * 
    * @example
    * cg-xxxxxxxx
@@ -13,12 +13,14 @@ export class DescribeConsumersRequest extends $dara.Model {
   consumerGroupId?: string;
   /**
    * @remarks
-   * The consumer ID.
+   * The user ID.
    * 
    * @example
    * c-mqveroemc***
    */
   consumerId?: string;
+  consumerName?: string;
+  consumerNameList?: string;
   /**
    * @remarks
    * The gateway instance ID.
@@ -31,7 +33,7 @@ export class DescribeConsumersRequest extends $dara.Model {
   gwClusterId?: string;
   /**
    * @remarks
-   * The page number. The default value is 1.
+   * The page number. Default value: 1.
    * 
    * @example
    * 1
@@ -39,13 +41,11 @@ export class DescribeConsumersRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Valid values are:
-   * 
-   * - **30**
-   * 
-   * - **50**
-   * 
-   * - **100**. The default is **30**.
+   * The number of entries per page. Valid values:
+   * * **30**
+   * * **50**
+   * * **100**
+   * Default value: **30**.
    * 
    * @example
    * 30
@@ -63,6 +63,8 @@ export class DescribeConsumersRequest extends $dara.Model {
     return {
       consumerGroupId: 'ConsumerGroupId',
       consumerId: 'ConsumerId',
+      consumerName: 'ConsumerName',
+      consumerNameList: 'ConsumerNameList',
       gwClusterId: 'GwClusterId',
       pageNumber: 'PageNumber',
       pageSize: 'PageSize',
@@ -74,6 +76,8 @@ export class DescribeConsumersRequest extends $dara.Model {
     return {
       consumerGroupId: 'string',
       consumerId: 'string',
+      consumerName: 'string',
+      consumerNameList: 'string',
       gwClusterId: 'string',
       pageNumber: 'number',
       pageSize: 'number',

package/src/models/DescribeConsumersResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeConsumersResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The models that the consumer is allowed to access, specified as a JSON array in string format.
+   * The list of supported models.
    * 
    * @example
    * "[]"
@@ -13,7 +13,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   allowedModels?: string;
   /**
    * @remarks
-   * The full API key. This value is returned only by this operation.
+   * The full API key, returned only in this response.
    * 
    * @example
    * xxxxxxxx
@@ -21,7 +21,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   apiKey?: string;
   /**
    * @remarks
-   * The consumer group ID.
+   * The user group ID.
    * 
    * @example
    * cg-xxxxxx
@@ -29,7 +29,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   consumerGroupId?: string;
   /**
    * @remarks
-   * The consumer group name.
+   * The user group name.
    * 
    * @example
    * test
@@ -37,7 +37,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   consumerGroupName?: string;
   /**
    * @remarks
-   * The consumer ID.
+   * The user ID.
    * 
    * @example
    * c-mqveroemc***
@@ -45,7 +45,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   consumerId?: string;
   /**
    * @remarks
-   * The time when the consumer was created.
+   * The creation time.
    * 
    * @example
    * 2026-01-28T09:56:03+08:00
@@ -53,7 +53,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   gmtCreated?: string;
   /**
    * @remarks
-   * The time when the consumer was last modified.
+   * The update time.
    * 
    * @example
    * 2026-01-04T16:09:29+08:00
@@ -61,7 +61,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   gmtModified?: string;
   /**
    * @remarks
-   * The total usage.
+   * The total cumulative usage.
    * 
    * @example
    * 1000
@@ -69,7 +69,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   lifetimeCostCount?: number;
   /**
    * @remarks
-   * The total number of tokens consumed.
+   * The total cost for the current month.
    * 
    * @example
    * 100
@@ -77,7 +77,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   lifetimeTokenCount?: number;
   /**
    * @remarks
-   * The month-to-date usage.
+   * The usage for the current month.
    * 
    * @example
    * 10
@@ -85,7 +85,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   mtdCostCount?: number;
   /**
    * @remarks
-   * The number of tokens consumed month-to-date.
+   * The total cumulative cost.
    * 
    * @example
    * 10000
@@ -93,7 +93,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   mtdTokenCount?: number;
   /**
    * @remarks
-   * The consumer name.
+   * The username.
    * 
    * @example
    * test
@@ -101,7 +101,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The consumer nickname.
+   * The nickname.
    * 
    * @example
    * yonghu
@@ -155,7 +155,7 @@ export class DescribeConsumersResponseBodyItems extends $dara.Model {
 export class DescribeConsumersResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of consumers.
+   * The list of users.
    */
   items?: DescribeConsumersResponseBodyItems[];
   /**
@@ -168,7 +168,7 @@ export class DescribeConsumersResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned on the current page.
+   * The number of records on the current page.
    * 
    * @example
    * 1
@@ -176,7 +176,7 @@ export class DescribeConsumersResponseBody extends $dara.Model {
   pageRecordCount?: number;
   /**
    * @remarks
-   * The page size. Valid values: 30, 50, and 100. The default value is 30.
+   * The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.
    * 
    * @example
    * 30
@@ -184,7 +184,7 @@ export class DescribeConsumersResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * Id of the request
    * 
    * @example
    * 24A1990B-4F6E-482B-B8CB-75C612******

package/src/models/DescribeDbclusterAccessWhitelistRequest.ts

@@ -15,6 +15,11 @@ export class DescribeDBClusterAccessWhitelistRequest extends $dara.Model {
   DBClusterId?: string;
   ownerAccount?: string;
   ownerId?: number;
+  /**
+   * @example
+   * pfs-xxx
+   */
+  pfsInstanceId?: string;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   static names(): { [key: string]: string } {
@@ -22,6 +27,7 @@ export class DescribeDBClusterAccessWhitelistRequest extends $dara.Model {
       DBClusterId: 'DBClusterId',
       ownerAccount: 'OwnerAccount',
       ownerId: 'OwnerId',
+      pfsInstanceId: 'PfsInstanceId',
       resourceOwnerAccount: 'ResourceOwnerAccount',
       resourceOwnerId: 'ResourceOwnerId',
     };
@@ -32,6 +38,7 @@ export class DescribeDBClusterAccessWhitelistRequest extends $dara.Model {
       DBClusterId: 'string',
       ownerAccount: 'string',
       ownerId: 'number',
+      pfsInstanceId: 'string',
       resourceOwnerAccount: 'string',
       resourceOwnerId: 'number',
     };

package/src/models/DescribeDbclusterPriceRequest.ts

@@ -0,0 +1,315 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeDBClusterPriceRequestDBNodes extends $dara.Model {
+  /**
+   * @remarks
+   * The target node specifications.
+   * 
+   * @example
+   * polar.mysql.x4.large
+   */
+  DBNodeClass?: string;
+  /**
+   * @remarks
+   * The node ID.
+   * 
+   * @example
+   * pi-**************
+   */
+  DBNodeId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBNodeClass: 'DBNodeClass',
+      DBNodeId: 'DBNodeId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBNodeClass: 'string',
+      DBNodeId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeDBClusterPriceRequest 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.
+   */
+  DBNodes?: DescribeDBClusterPriceRequestDBNodes[];
+  /**
+   * @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',
+      DBNodes: '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',
+      DBNodes: { 'type': 'array', 'itemType': DescribeDBClusterPriceRequestDBNodes },
+      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);
+    }
+    if(Array.isArray(this.DBNodes)) {
+      $dara.Model.validateArray(this.DBNodes);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeDbclusterPriceResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeDBClusterPriceResponseBody } from "./DescribeDbclusterPriceResponseBody";
+
+
+export class DescribeDBClusterPriceResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeDBClusterPriceResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeDBClusterPriceResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+