@alicloud/polardb20170801 7.3.0 → 7.5.0

package/src/models/DescribeBackupsRequest.ts

@@ -13,11 +13,9 @@ export class DescribeBackupsRequest extends $dara.Model {
   backupId?: string;
   /**
    * @remarks
-   * The backup mode. Valid values:
-   * 
-   * - **Automated**: System automatic backup.
-   * 
-   * - **Manual**: Manual backup.
+   * The backup mode. Valid values: 
+   * * **Automated**: automatic backup.
+   * * **Manual**: manual backup.
    * 
    * @example
    * Automated
@@ -25,9 +23,9 @@ export class DescribeBackupsRequest extends $dara.Model {
   backupMode?: string;
   /**
    * @remarks
-   * The destination region for cross-region backup.
+   * The destination region for cross-region backups.
    * 
-   * > This parameter is supported only for PolarDB for MySQL.
+   * > Currently, only PolarDB for MySQL supports this parameter.
    * 
    * @example
    * cn-hangzhou
@@ -36,10 +34,8 @@ export class DescribeBackupsRequest extends $dara.Model {
   /**
    * @remarks
    * The backup status. Valid values:
-   * 
-   * - **Success**: The backup is complete.
-   * 
-   * - **Failed**: The backup failed.
+   * * **Success**: The backup is complete.
+   * * **Failed**: The backup failed.
    * 
    * @example
    * Success
@@ -57,7 +53,7 @@ export class DescribeBackupsRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The end time of the query. The end time must be later than the start time. Specify the time in `YYYY-MM-DDThh:mmZ` format (UTC time).
+   * The end of the time range to query. The end time must be later than the start time. Specify the time in the `YYYY-MM-DDThh:mmZ` format (UTC).
    * 
    * This parameter is required.
    * 
@@ -69,7 +65,7 @@ export class DescribeBackupsRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The page number. The value must be an integer greater than 0 and no greater than the maximum value of the Integer type. Default value: **1**.
+   * The page number. Set the value to an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: **1**.
    * 
    * @example
    * 1
@@ -77,13 +73,10 @@ export class DescribeBackupsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values:
-   * 
-   * - **30**
-   * 
-   * - **50**
-   * 
-   * - **100**
+   * The number of entries per page. Valid values: 
+   * * **30**
+   * * **50**
+   * * **100**
    * 
    * Default value: **30**.
    * 
@@ -95,7 +88,7 @@ export class DescribeBackupsRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The start time of the query. Specify the time in `YYYY-MM-DDThh:mmZ` format (UTC time).
+   * The beginning of the time range to query. Specify the time in the `YYYY-MM-DDThh:mmZ` format (UTC).
    * 
    * This parameter is required.
    * 

package/src/models/DescribeBackupsResponseBody.ts

@@ -12,6 +12,7 @@ export class DescribeBackupsResponseBodyItemsBackup extends $dara.Model {
   backupStatus?: string;
   backupType?: string;
   backupsLevel?: string;
+  comment?: string;
   consistentTime?: string;
   DBClusterId?: string;
   expectExpireTime?: string;
@@ -29,6 +30,7 @@ export class DescribeBackupsResponseBodyItemsBackup extends $dara.Model {
       backupStatus: 'BackupStatus',
       backupType: 'BackupType',
       backupsLevel: 'BackupsLevel',
+      comment: 'Comment',
       consistentTime: 'ConsistentTime',
       DBClusterId: 'DBClusterId',
       expectExpireTime: 'ExpectExpireTime',
@@ -49,6 +51,7 @@ export class DescribeBackupsResponseBodyItemsBackup extends $dara.Model {
       backupStatus: 'string',
       backupType: 'string',
       backupsLevel: 'string',
+      comment: 'string',
       consistentTime: 'string',
       DBClusterId: 'string',
       expectExpireTime: 'string',
@@ -121,13 +124,10 @@ export class DescribeBackupsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total size of level-2 backups in the specified region, in bytes.
-   * 
-   * > - Supported only for storage classes PSL4 and PSL5.
-   * >
-   * > - Supported only for clusters with the level-2 backup feature enabled.
-   * >
-   * > - If this field is not returned, the level-2 backup size is 0.
+   * The total size of level-2 backups in the specified region. Unit: bytes.
+   * > - Only PSL4 and PSL5 storage types are supported.
+   * > - Only clusters with the level-2 backup feature enabled are supported.
+   * > - If this parameter is not returned, the level-2 backup size is 0.
    * 
    * @example
    * 4639948800

package/src/models/DescribeBudgetPoliciesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBudgetPoliciesRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the consumer group or user. This parameter is required if BudgetDimensionType is set to ConsumerGroup or Consumer.
+   * The dimension object ID. This parameter is required when BudgetDimensionType is set to ConsumerGroup or Consumer.
    * 
    * @example
    * cg-p3gk2oh55c**
@@ -15,9 +15,8 @@ export class DescribeBudgetPoliciesRequest extends $dara.Model {
    * @remarks
    * The policy type. Valid values:
    * 
-   * - **ConsumerGroup**: The policy applies to a consumer group.
-   * 
-   * - **Consumer**: The policy applies to a user.
+   * - **ConsumerGroup**: total budget for a user group
+   * - **Consumer**: total budget for a user
    * 
    * @example
    * ConsumerGroup
@@ -51,15 +50,12 @@ export class DescribeBudgetPoliciesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Valid values:
-   * 
-   * - **30**
-   * 
-   * - **50**
+   * The number of entries per page. Valid values: 
+   * * **30**
+   * * **50**
+   * * **100**
    * 
-   * - **100**
-   * 
-   * The default value is **30**.
+   * Default value: **30**.
    * 
    * @example
    * 30
@@ -73,13 +69,13 @@ export class DescribeBudgetPoliciesRequest extends $dara.Model {
    * cn-beijing
    */
   regionId?: string;
+  scopeRefName?: string;
   /**
    * @remarks
    * The policy status. Valid values:
    * 
-   * - **Enabled**
-   * 
-   * - **Disabled**
+   * - **Enabled**: enabled
+   * - **Disenabled**: disabled
    * 
    * @example
    * Enabled
@@ -94,6 +90,7 @@ export class DescribeBudgetPoliciesRequest extends $dara.Model {
       pageNumber: 'PageNumber',
       pageSize: 'PageSize',
       regionId: 'RegionId',
+      scopeRefName: 'ScopeRefName',
       status: 'Status',
     };
   }
@@ -107,6 +104,7 @@ export class DescribeBudgetPoliciesRequest extends $dara.Model {
       pageNumber: 'number',
       pageSize: 'number',
       regionId: 'string',
+      scopeRefName: 'string',
       status: 'string',
     };
   }

package/src/models/DescribeBudgetPoliciesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The alert threshold, as a percentage (0 to 100).
+   * The alert threshold percentage. Valid values: 0 to 100.
    * 
    * @example
    * 80
@@ -13,7 +13,7 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
   alertThresholdPct?: string;
   /**
    * @remarks
-   * Indicates whether the alert threshold was triggered.
+   * Indicates whether the alert threshold has been triggered.
    * 
    * @example
    * false
@@ -21,7 +21,7 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
   alertTriggered?: boolean;
   /**
    * @remarks
-   * The ID of the dimension object. This parameter is required when `BudgetDimensionType` is set to `ConsumerGroup` or `Consumer`.
+   * The dimension object ID. This parameter is required when BudgetDimensionType is set to ConsumerGroup or Consumer.
    * 
    * @example
    * cg-p3gk2oh55c**
@@ -29,11 +29,10 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
   budgetDimensionRefId?: string;
   /**
    * @remarks
-   * The dimension of the budget policy. Valid values:
+   * The policy type. Valid values:
    * 
-   * - **ConsumerGroup**: consumer group
-   * 
-   * - **Consumer**: consumer
+   * - **ConsumerGroup**: total budget for a user group
+   * - **Consumer**: total budget for a user
    * 
    * @example
    * ConsumerGroup
@@ -41,7 +40,7 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
   budgetDimensionType?: string;
   /**
    * @remarks
-   * The number of budget points.
+   * The budget points.
    * 
    * @example
    * 10000
@@ -59,11 +58,9 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
    * @remarks
    * The budget type. Valid values:
    * 
-   * - **GlobalTotal**: Global budget
-   * 
-   * - **ConsumerTotal**: Consumer budget
-   * 
-   * - **ConsumerGroupTotal**: Consumer group budget
+   * - **GlobalTotal**: global total budget
+   * - **ConsumerTotal**: total budget for a user
+   * - **ConsumerGroupTotal**: total budget for a user group
    * 
    * @example
    * GlobalTotal
@@ -71,7 +68,7 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
   budgetType?: string;
   /**
    * @remarks
-   * Indicates whether the budget was exceeded.
+   * Indicates whether the quota has been exceeded.
    * 
    * @example
    * false
@@ -95,7 +92,7 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
   gmtModified?: string;
   /**
    * @remarks
-   * The gateway cluster ID.
+   * The gateway instance ID.
    * 
    * @example
    * pg-xxxxxxxx
@@ -103,7 +100,7 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
   gwClusterId?: string;
   /**
    * @remarks
-   * The day of the month (1 to 28) on which the budget is reset.
+   * The day of the month on which the budget resets. Valid values: 1 to 28.
    * 
    * @example
    * 2
@@ -111,11 +108,10 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
   resetDayOfMonth?: string;
   /**
    * @remarks
-   * The status of the policy. Valid values:
+   * The policy status. Valid values:
    * 
    * - **Enabled**: enabled
-   * 
-   * - **Disabled**: disabled
+   * - **Disenabled**: disabled
    * 
    * @example
    * Enabled
@@ -179,7 +175,7 @@ export class DescribeBudgetPoliciesResponseBodyItems extends $dara.Model {
 export class DescribeBudgetPoliciesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of budget policies.
+   * The list of budget policies.
    */
   items?: DescribeBudgetPoliciesResponseBodyItems[];
   /**
@@ -200,8 +196,8 @@ export class DescribeBudgetPoliciesResponseBody extends $dara.Model {
   pageRecordCount?: number;
   /**
    * @remarks
-   * The number of records to return on each page. Valid values: **30**, **50**, and **100**.
-   * 
+   * The number of entries per page. Valid values: **30**, **50**, and **100**.
+   *                               
    * Default value: **30**.
    * 
    * @example
@@ -210,7 +206,7 @@ export class DescribeBudgetPoliciesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 24A1990B-4F6E-482B-B8CB-75C612******

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',
     };