@alicloud/polardb20170801 7.12.0 → 7.12.2

package/src/models/DescribeApplicationPerformanceShrinkRequest.ts

@@ -0,0 +1,164 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeApplicationPerformanceShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The application cluster ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pa-**************
+   */
+  applicationId?: string;
+  /**
+   * @remarks
+   * The user.
+   * 
+   * @example
+   * c-xxxxxxx
+   */
+  consumer?: string;
+  /**
+   * @remarks
+   * The user group.
+   * 
+   * @example
+   * cg-xxxxxx
+   */
+  consumerGroup?: string;
+  /**
+   * @remarks
+   * The downsampling policy.
+   * 
+   * @example
+   * raw_sample
+   */
+  downsample?: string;
+  /**
+   * @remarks
+   * The end step number.
+   * 
+   * @example
+   * 100
+   */
+  endStep?: number;
+  /**
+   * @remarks
+   * The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC).
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2020-09-23T01:00Z
+   */
+  endTime?: string;
+  /**
+   * @remarks
+   * The data granularity of performance data. Valid values:
+   * - 5
+   * - 30
+   * - 60
+   * - 600
+   * - 1800
+   * - 3600
+   * - 86400
+   * 
+   * @example
+   * 5
+   */
+  interval?: string;
+  /**
+   * @remarks
+   * The performance metrics to query. Separate multiple values with commas (,).
+   * 
+   * > **Note** You can specify up to 5 performance metrics.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * PolarDBSupabaseMemUsage
+   */
+  key?: string;
+  /**
+   * @remarks
+   * The maximum number of data points to return.
+   * 
+   * @example
+   * 1000
+   */
+  maxPoints?: number;
+  /**
+   * @remarks
+   * The model service.
+   * 
+   * @example
+   * ms-xxxxxx
+   */
+  modelService?: string;
+  /**
+   * @remarks
+   * The start step number.
+   * 
+   * @example
+   * 1
+   */
+  startStep?: number;
+  /**
+   * @remarks
+   * The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format (UTC).
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 2020-09-23T01:01Z
+   */
+  startTime?: string;
+  filterShrink?: string;
+  static names(): { [key: string]: string } {
+    return {
+      applicationId: 'ApplicationId',
+      consumer: 'Consumer',
+      consumerGroup: 'ConsumerGroup',
+      downsample: 'Downsample',
+      endStep: 'EndStep',
+      endTime: 'EndTime',
+      interval: 'Interval',
+      key: 'Key',
+      maxPoints: 'MaxPoints',
+      modelService: 'ModelService',
+      startStep: 'StartStep',
+      startTime: 'StartTime',
+      filterShrink: 'filter',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      applicationId: 'string',
+      consumer: 'string',
+      consumerGroup: 'string',
+      downsample: 'string',
+      endStep: 'number',
+      endTime: 'string',
+      interval: 'string',
+      key: 'string',
+      maxPoints: 'number',
+      modelService: 'string',
+      startStep: 'number',
+      startTime: 'string',
+      filterShrink: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeCostRulesRequest.ts

@@ -3,6 +3,22 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeCostRulesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Filters by effective target type. Valid values: global, consumerGroup, and consumer.
+   * 
+   * @example
+   * global
+   */
+  effectiveTargetType?: string;
+  /**
+   * @remarks
+   * Filters by effective target value.
+   * 
+   * @example
+   * user
+   */
+  effectiveTargetValue?: string;
   /**
    * @remarks
    * The gateway instance ID.
@@ -15,7 +31,7 @@ export class DescribeCostRulesRequest extends $dara.Model {
   gwClusterId?: string;
   /**
    * @remarks
-   * The model name, such as `gpt-4` or `qwen-turbo`.
+   * The model name, such as gpt-4 or qwen-turbo.
    * 
    * @example
    * qwen3-max
@@ -40,12 +56,9 @@ export class DescribeCostRulesRequest extends $dara.Model {
   /**
    * @remarks
    * The number of entries per page. Valid values:
-   * 
-   * - **30**
-   * 
-   * - **50**
-   * 
-   * - **100**
+   * * **30**
+   * * **50**
+   * * **100**
    * 
    * Default value: 30.
    * 
@@ -63,6 +76,8 @@ export class DescribeCostRulesRequest extends $dara.Model {
   regionId?: string;
   static names(): { [key: string]: string } {
     return {
+      effectiveTargetType: 'EffectiveTargetType',
+      effectiveTargetValue: 'EffectiveTargetValue',
       gwClusterId: 'GwClusterId',
       modelName: 'ModelName',
       modelServiceId: 'ModelServiceId',
@@ -74,6 +89,8 @@ export class DescribeCostRulesRequest extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      effectiveTargetType: 'string',
+      effectiveTargetValue: 'string',
       gwClusterId: 'string',
       modelName: 'string',
       modelServiceId: 'string',

package/src/models/DescribeCostRulesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCostRulesResponseBodyItems extends $dara.Model {
   /**
    * @remarks
-   * The cost in points per one million cached tokens.
+   * The cost points per million cache tokens. Default value: 0.
    * 
    * @example
    * 0
@@ -21,7 +21,23 @@ export class DescribeCostRulesResponseBodyItems extends $dara.Model {
   costRuleId?: string;
   /**
    * @remarks
-   * The time when the cost rule was created.
+   * The effective target type.
+   * 
+   * @example
+   * global
+   */
+  effectiveTargetType?: string;
+  /**
+   * @remarks
+   * The effective target value.
+   * 
+   * @example
+   * user
+   */
+  effectiveTargetValue?: string;
+  /**
+   * @remarks
+   * The creation time.
    * 
    * @example
    * 2026-01-04T16:09:29+08:00
@@ -29,7 +45,7 @@ export class DescribeCostRulesResponseBodyItems extends $dara.Model {
   gmtCreated?: string;
   /**
    * @remarks
-   * The time when the cost rule was last updated.
+   * The last modification time.
    * 
    * @example
    * 2024-10-16 16:46:20
@@ -45,7 +61,7 @@ export class DescribeCostRulesResponseBodyItems extends $dara.Model {
   gwClusterId?: string;
   /**
    * @remarks
-   * The cost in points per one million input tokens.
+   * The cost points per million input tokens. Default value: 0.
    * 
    * @example
    * 0
@@ -69,7 +85,7 @@ export class DescribeCostRulesResponseBodyItems extends $dara.Model {
   modelServiceId?: string;
   /**
    * @remarks
-   * The cost in points per one million output tokens.
+   * The cost points per million output tokens. Default value: 0.
    * 
    * @example
    * 0
@@ -79,6 +95,8 @@ export class DescribeCostRulesResponseBodyItems extends $dara.Model {
     return {
       cacheCostPointsPerMillion: 'CacheCostPointsPerMillion',
       costRuleId: 'CostRuleId',
+      effectiveTargetType: 'EffectiveTargetType',
+      effectiveTargetValue: 'EffectiveTargetValue',
       gmtCreated: 'GmtCreated',
       gmtModified: 'GmtModified',
       gwClusterId: 'GwClusterId',
@@ -93,6 +111,8 @@ export class DescribeCostRulesResponseBodyItems extends $dara.Model {
     return {
       cacheCostPointsPerMillion: 'string',
       costRuleId: 'string',
+      effectiveTargetType: 'string',
+      effectiveTargetValue: 'string',
       gmtCreated: 'string',
       gmtModified: 'string',
       gwClusterId: 'string',
@@ -115,7 +135,7 @@ export class DescribeCostRulesResponseBodyItems extends $dara.Model {
 export class DescribeCostRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of cost rules.
+   * The list of cost rules.
    */
   items?: DescribeCostRulesResponseBodyItems[];
   /**
@@ -136,7 +156,7 @@ export class DescribeCostRulesResponseBody extends $dara.Model {
   pageRecordCount?: number;
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.
    * 
    * @example
    * 30
@@ -144,7 +164,7 @@ export class DescribeCostRulesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 24A1990B-4F6E-482B-B8CB-75C612******

package/src/models/DescribePolarFsAttributeRequest.ts

@@ -14,7 +14,7 @@ export class DescribePolarFsAttributeRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The PolarLakebase instance ID.
+   * The Polarlakebase instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/DescribePolarFsAttributeResponseBody.ts

@@ -43,11 +43,56 @@ export class DescribePolarFsAttributeResponseBodyCustomBucketPathList extends $d
 }
 
 export class DescribePolarFsAttributeResponseBodyEndpointItemsAddressItems extends $dara.Model {
+  /**
+   * @remarks
+   * The endpoint of the protocol connection.
+   * 
+   * @example
+   * aclsh-prd-pdb12-rw.rwlb.rds.aliyuncs.com
+   */
   connectionString?: string;
+  /**
+   * @remarks
+   * The IP address.
+   * 
+   * @example
+   * 47.116.9.224
+   */
   IPAddress?: string;
+  /**
+   * @remarks
+   * The network type of the connection string. Valid values:
+   * * **Public**: public endpoint.
+   * * **Private**: private endpoint.
+   * * **Inner**: private endpoint (classic network).
+   * 
+   * @example
+   * Public
+   */
   netType?: string;
+  /**
+   * @remarks
+   * The port number.
+   * 
+   * @example
+   * 3306
+   */
   port?: string;
+  /**
+   * @remarks
+   * The VPC ID.
+   * 
+   * @example
+   * vpc-**********
+   */
   VPCId?: string;
+  /**
+   * @remarks
+   * The vSwitch ID.
+   * 
+   * @example
+   * vsw-**************
+   */
   vSwitchId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -81,13 +126,23 @@ export class DescribePolarFsAttributeResponseBodyEndpointItemsAddressItems exten
 }
 
 export class DescribePolarFsAttributeResponseBodyEndpointItems extends $dara.Model {
+  /**
+   * @remarks
+   * The list of addresses.
+   */
   addressItems?: DescribePolarFsAttributeResponseBodyEndpointItemsAddressItems[];
   /**
+   * @remarks
+   * The endpoint ID.
+   * 
    * @example
    * ep-xxxxxxxxx
    */
   DBEndpointId?: string;
   /**
+   * @remarks
+   * The endpoint type. Valid values: Nas, S3Gateway, and others.
+   * 
    * @example
    * S3Gateway
    */
@@ -181,7 +236,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   accelerateType?: string;
   /**
    * @remarks
-   * The acceleration storage space. Unit: GB.
+   * The acceleration storage space, in GB.
    * 
    * @example
    * 1000
@@ -189,7 +244,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   acceleratedStorageSpace?: number;
   /**
    * @remarks
-   * Specifies whether the acceleration cache is enabled. Valid values:
+   * Indicates whether the acceleration cache is enabled. Valid values:
    * - **ON**: Enabled.
    * - **OFF**: Disabled.
    * 
@@ -199,7 +254,23 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   acceleratingEnable?: string;
   /**
    * @remarks
-   * The bandwidth. Unit: MB/s.
+   * The list of authorized RAM role ARNs, separated by commas.
+   * 
+   * @example
+   * arn:sts::123456:assumed-role/myrole/*
+   */
+  authorizedUserArnIds?: string;
+  /**
+   * @remarks
+   * The list of authorized UIDs, separated by commas.
+   * 
+   * @example
+   * 1234567890,9876543210
+   */
+  authorizedUserIds?: string;
+  /**
+   * @remarks
+   * The bandwidth, in MB/s.
    * 
    * @example
    * 100
@@ -207,7 +278,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   bandwidth?: number;
   /**
    * @remarks
-   * The bandwidth baseline. Unit: MB/s/TiB.
+   * The bandwidth baseline, in MB/s/TiB.
    * 
    * @example
    * 100
@@ -223,7 +294,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   bucketId?: string;
   /**
    * @remarks
-   * The PolarLakebase edition. Valid values:
+   * The Polarlakebase edition. Valid values:
    * 
    * - **high_performance**: High-performance Edition.
    * 
@@ -264,6 +335,13 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
    * The list of custom storage paths.
    */
   customBucketPathList?: DescribePolarFsAttributeResponseBodyCustomBucketPathList[];
+  /**
+   * @remarks
+   * The endpoint ID.
+   * 
+   * @example
+   * pe-zo1z5qw5nb39s699n
+   */
   DBEndpointId?: string;
   /**
    * @remarks
@@ -275,12 +353,16 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
    * MySQL
    */
   DBType?: string;
+  /**
+   * @remarks
+   * The list of endpoints, including endpoint information for NAS, S3Gateway, and other types.
+   */
   endpointItems?: DescribePolarFsAttributeResponseBodyEndpointItems[];
   /**
    * @remarks
    * The expiration time of the cluster.
    * 
-   * > 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.
+   * > 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.
    * 
    * @example
    * 2025-10-10T16:00:00Z
@@ -289,7 +371,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   /**
    * @remarks
    * Indicates whether the cluster has expired.
-   * > This parameter is returned only for clusters that use the **Prepaid** (subscription) billing method.
+   * > This parameter is returned only for clusters whose billing method is **Prepaid** (subscription).
    * 
    * @example
    * false
@@ -315,17 +397,41 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
    * Unlock
    */
   lockMode?: string;
+  /**
+   * @remarks
+   * The proxy endpoint ID.
+   * 
+   * @example
+   * pe-cz9inwqec7ifd98c3
+   */
   maxscaleEndpointId?: string;
+  /**
+   * @remarks
+   * The metadata service cluster endpoint.
+   * 
+   * @example
+   * pc-x67w12d2d5t13mt88.pg.polardb.rds.aliyuncs.com
+   */
   metaConnString?: string;
   /**
+   * @remarks
+   * The metadata instance name.
+   * 
    * @example
    * pc-xxxxxxxxxxxxxxxxx
    */
   metaInstanceName?: string;
+  /**
+   * @remarks
+   * The metadata proxy service cluster endpoint.
+   * 
+   * @example
+   * pc-y3610mp168p3bb740.rwlb.rds.aliyuncs.com
+   */
   metaMxsConnString?: string;
   /**
    * @remarks
-   * The encrypted metadata URL for Fuse mounting.
+   * The metadata address for Fuse mount (encrypted).
    * 
    * @example
    * e6cc1d2e2a6fa292038d999fda6501*****
@@ -357,7 +463,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   payType?: string;
   /**
    * @remarks
-   * The description of the PolarLakebase instance.
+   * The description of the Polarlakebase instance.
    * 
    * @example
    * pfs-xxx
@@ -365,7 +471,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   polarFsInstanceDescription?: string;
   /**
    * @remarks
-   * The PolarLakebase instance ID.
+   * The Polarlakebase instance ID.
    * 
    * @example
    * pfs-2ze0i74ka607*****
@@ -373,7 +479,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   polarFsInstanceId?: string;
   /**
    * @remarks
-   * The PolarLakebase instance status.
+   * The Polarlakebase instance status.
    * 
    * @example
    * Running
@@ -382,8 +488,8 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   /**
    * @remarks
    * The instance version. Valid values:
-   * - **PolarFS 2.0**: 2.0.
-   * - **PolarFS 1.0**: 1.0.
+   * - **PolarFS 2.0**: 2.0
+   * - **PolarFS 1.0**: 1.0
    * 
    * @example
    * PolarFS 2.0
@@ -415,7 +521,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   relativeDbClusterId?: string;
   /**
    * @remarks
-   * The instance ID of the associated PolarLakebase instance.
+   * The instance ID of the associated Polarlakebase instance.
    * 
    * @example
    * pfs-**********
@@ -439,7 +545,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   securityGroupId?: string;
   /**
    * @remarks
-   * The storage space. Unit: GB.
+   * The storage space, in GB.
    * 
    * @example
    * 1000
@@ -452,7 +558,7 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
    * * **ESSDPL0**
    * 
    * The storage type for the Basic Edition. Valid values:
-   * * **city_redundancy**: zone-redundant storage.
+   * * **city_redundancy**: cross-zone redundancy.
    * 
    * @example
    * essdpl1
@@ -460,18 +566,24 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
   storageType?: string;
   /**
    * @remarks
-   * The used storage space. Unit: bytes.
+   * The storage usage, in bytes.
    * 
    * @example
    * 3012558848
    */
   storageUsed?: number;
   /**
+   * @remarks
+   * The default user account name for S3 Gateway.
+   * 
    * @example
    * lakebase_acc
    */
   userDefaultAccName?: string;
   /**
+   * @remarks
+   * The default user account key for S3 Gateway (encrypted ciphertext).
+   * 
    * @example
    * EncryptedSecretKey==
    */
@@ -505,6 +617,8 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
       accelerateType: 'AccelerateType',
       acceleratedStorageSpace: 'AcceleratedStorageSpace',
       acceleratingEnable: 'AcceleratingEnable',
+      authorizedUserArnIds: 'AuthorizedUserArnIds',
+      authorizedUserIds: 'AuthorizedUserIds',
       bandwidth: 'Bandwidth',
       bandwidthBaseLine: 'BandwidthBaseLine',
       bucketId: 'BucketId',
@@ -554,6 +668,8 @@ export class DescribePolarFsAttributeResponseBody extends $dara.Model {
       accelerateType: 'string',
       acceleratedStorageSpace: 'number',
       acceleratingEnable: 'string',
+      authorizedUserArnIds: 'string',
+      authorizedUserIds: 'string',
       bandwidth: 'number',
       bandwidthBaseLine: 'number',
       bucketId: 'string',