@alicloud/esa20240910 3.3.0 → 3.4.0

package/src/models/ListUserRatePlanInstancesRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ListUserRatePlanInstancesRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to filter for rate plan instances that have a remaining site quota. Valid values:
+   * Specifies whether to filter plan instances that have remaining site quota. Valid values:
    * 
-   * - **true**: Returns only rate plan instances that have a remaining site quota.
-   * 
-   * - **false**: Returns all rate plan instances for the user.
+   * - **true**: Filters plan instances that have remaining site quota.
+   * - **false**: Queries all plan instances under the user.
    * 
    * @example
    * true
@@ -17,7 +16,7 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   checkRemainingSiteQuota?: string;
   /**
    * @remarks
-   * The ID of the rate plan instance to query.
+   * The plan instance ID. You can obtain the ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * @example
    * sp-xcdn-96wblslz****
@@ -25,7 +24,7 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. The default value is **1**. The value must be in the range of **1 to 100,000**.
+   * The page number to return in a paged query. Default value: **1**. Valid values: **1** to **100000**. Settings for paging take effect only when this parameter is specified.
    * 
    * @example
    * 1
@@ -33,22 +32,45 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * The number of entries per page in a paged query. Valid values: 1 to 500. This parameter is used for paging.
    * 
    * @example
    * 500
    */
   pageSize?: number;
+  /**
+   * @remarks
+   * The plan name in English.
+   * 
+   * @example
+   * entranceplan
+   */
   planNameEn?: string;
+  /**
+   * @remarks
+   * The plan type. Valid values:
+   * 
+   * - normal: fixed-version plan
+   * - enterprise: Enterprise Edition plan.
+   * 
+   * @example
+   * enterprise
+   */
   planType?: string;
-  remainingExpireDays?: number;
   /**
    * @remarks
-   * The sort field. By default, results are sorted by creation time. Valid values:
+   * Queries plan instances whose remaining validity period is within the specified number of days. The value must be a positive integer. Unit: days.
    * 
-   * - **CreateTime**: Sorts by creation time.
+   * @example
+   * 30
+   */
+  remainingExpireDays?: number;
+  /**
+   * @remarks
+   * The field by which to sort the results. By default, results are sorted by purchase time. Valid values:
    * 
-   * - **ExpireTime**: Sorts by expiration time.
+   * - **CreateTime**: purchase time.
+   * - **ExpireTime**: expiration time.
    * 
    * @example
    * CreateTime
@@ -56,11 +78,10 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
-   * The sort order. The default is descending. Valid values:
-   * 
-   * - **asc**: Sorts in ascending order.
+   * The sort order. Default value: desc. Valid values:
    * 
-   * - **desc**: Sorts in descending order.
+   * - **asc**: ascending order.
+   * - **desc**: descending order.
    * 
    * @example
    * asc
@@ -68,15 +89,11 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   sortOrder?: string;
   /**
    * @remarks
-   * The status of the rate plan instance. Valid values:
-   * 
-   * - **online**: The instance is in service.
-   * 
-   * - **offline**: The instance has expired and is unavailable.
-   * 
-   * - **disable**: The instance is released.
-   * 
-   * - **overdue**: The instance is overdue.
+   * The instance status. Valid values:
+   * - **online**: The plan instance is in normal service.
+   * - **offline**: The plan instance has expired but has not exceeded the grace period and is not active.
+   * - **disable**: The plan instance has been released.
+   * - **overdue**: The plan instance has an overdue payment.
    * 
    * @example
    * online
@@ -85,6 +102,20 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
    * false
    */
   status?: string;
+  /**
+   * @remarks
+   * The plan subscription type. Valid values:
+   * 
+   * - entranceplan: Free Edition (Chinese mainland)
+   * - entranceplan_intl: Free Edition (International)
+   * - basicplan: Basic Edition
+   * - standardplan: Standard Edition
+   * - advancedplan: Premium Edition
+   * - enterpriseplan: Enterprise Edition.
+   * 
+   * @example
+   * basicplan
+   */
   subscribeType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListUserRatePlanInstancesResponseBody.ts

@@ -24,12 +24,9 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfoSites extends $dar
    * The site status. Valid values:
    * 
    * - **pending**: The site is pending configuration.
-   * 
-   * - **active**: The site is active.
-   * 
+   * - **active**: The site is activated.
    * - **offline**: The site is offline.
-   * 
-   * - **moved**: The site has been replaced.
+   * - **moved**: The site has been superseded.
    * 
    * @example
    * pending
@@ -66,24 +63,39 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
    * The billing method. Valid values:
    * 
    * - **PREPAY**: subscription.
-   * 
    * - **POSTPAY**: pay-as-you-go.
    * 
    * @example
    * PREPAY
    */
   billingMode?: string;
-  botInstanceLevel?: string;
-  botRequest?: string;
   /**
    * @remarks
-   * The acceleration regions covered by the plan instance. Multiple values are separated by commas (,). Valid values:
+   * If this field is empty, the plan does not include a bot protection instance. If a value is returned, the plan includes a bot protection instance. Valid values:
    * 
-   * - **domestic**: The Chinese mainland.
+   * - enterprise_bot: Web Edition
    * 
-   * - **overseas**: Regions outside the Chinese mainland.
+   * - enterprise_bot_with_app: App Edition.
    * 
-   * - **global**: Global (including the Chinese mainland).
+   * @example
+   * enterprise_bot
+   */
+  botInstanceLevel?: string;
+  /**
+   * @remarks
+   * The prepaid bot protection requests included in the plan, in units of 10,000.
+   * 
+   * @example
+   * 100
+   */
+  botRequest?: string;
+  /**
+   * @remarks
+   * The acceleration regions to which sites can be bound under this plan instance. Multiple values are separated by commas (,). Valid values:
+   * 
+   * - **domestic**: China or the Chinese mainland.
+   * - **overseas**: Global (excluding China or the Chinese mainland).
+   * - **global**: Global (including China or the Chinese mainland).
    * 
    * @example
    * domestic,overseas
@@ -91,32 +103,74 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
   coverages?: string;
   /**
    * @remarks
-   * The creation time.
+   * The purchase time of the plan instance. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
-   * YYYY-MM-DDThh:mm:ssZ
+   * 2026-04-19T11:15:20Z
    */
   createTime?: string;
+  /**
+   * @remarks
+   * The prepaid China network acceleration traffic included in the plan, in GB.
+   * 
+   * @example
+   * 100
+   */
   crossborderTraffic?: string;
+  /**
+   * @remarks
+   * The Anti-DDoS instance specification for the Chinese mainland included in the plan.
+   * 
+   * @example
+   * cn_300
+   */
   ddosBurstableDomesticProtection?: string;
+  /**
+   * @remarks
+   * The Anti-DDoS instance specification outside the Chinese mainland included in the plan.
+   * 
+   * @example
+   * overseas_300
+   */
   ddosBurstableOverseasProtection?: string;
+  /**
+   * @remarks
+   * If this field is empty, the plan does not include an Anti-DDoS instance. If a value is returned, the plan includes an Anti-DDoS instance. The value is `esa_ddos_instance`.
+   * 
+   * @example
+   * esa_ddos_instance
+   */
   ddosInstanceLevel?: string;
   /**
    * @remarks
-   * The duration in months.
+   * The subscription duration of the plan instance. Unit: months.
    * 
    * @example
    * 3
    */
   duration?: number;
+  /**
+   * @remarks
+   * The prepaid Edge Routine (ER) requests included in the plan, in units of 10,000.
+   * 
+   * @example
+   * 100
+   */
   edgeRoutineRquest?: string;
+  /**
+   * @remarks
+   * The prepaid WAF requests included in the plan, in units of 10,000.
+   * 
+   * @example
+   * 100
+   */
   edgeWafRequest?: string;
   /**
    * @remarks
-   * The expiration time.
+   * The expiration time of the plan instance. The time is in ISO 8601 format and displayed in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
-   * YYYY-MM-DDThh:mm:ssZ
+   * 2026-04-19T11:15:20Z
    */
   expireTime?: string;
   /**
@@ -127,42 +181,71 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
    * sp-xcdn-96wblslz****
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The prepaid Layer 4 proxy traffic included in the plan, in GB, for the Chinese mainland.
+   * 
+   * @example
+   * 100
+   */
   layer4Traffic?: string;
+  /**
+   * @remarks
+   * The prepaid Layer 4 proxy traffic included in the plan, in GB, outside the Chinese mainland.
+   * 
+   * @example
+   * 100
+   */
   layer4TrafficIntl?: string;
   /**
    * @remarks
-   * The plan name.
+   * The plan name associated with the plan instance.
    * 
    * @example
    * basic
    */
   planName?: string;
-  planTraffic?: string;
   /**
    * @remarks
-   * The plan type. Valid values:
+   * The prepaid Layer 7 acceleration traffic included in the plan, in GB.
    * 
-   * - **normal**: The normal plan.
-   * 
-   * - **enterprise**: The enterprise plan.
+   * @example
+   * 100
+   */
+  planTraffic?: string;
+  /**
+   * @remarks
+   * The plan type associated with the plan instance. Valid values:
+   * - **normal**: fixed-version plan.
+   * - **enterprise**: Enterprise Edition plan.
    * 
    * @example
    * normal
    */
   planType?: string;
   /**
+   * @remarks
+   * The auto-renewal cycle. Unit: months.
+   * 
    * @example
    * 6
    */
   renewalDuration?: number;
   /**
+   * @remarks
+   * The auto-renewal status. Valid values:
+   * 
+   * - nomal: normal
+   * - auto_renewal: auto-renewal enabled
+   * - not_renewal: auto-renewal disabled.
+   * 
    * @example
    * nomal
    */
   renewalStatus?: string;
   /**
    * @remarks
-   * The site quota.
+   * The site quota for the plan instance.
    * 
    * @example
    * 1
@@ -170,25 +253,50 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
   siteQuota?: string;
   /**
    * @remarks
-   * The sites associated with this plan instance.
+   * The list of sites bound to the current plan instance.
    */
   sites?: ListUserRatePlanInstancesResponseBodyInstanceInfoSites[];
+  /**
+   * @remarks
+   * The prepaid smart routing requests included in the plan, in units of 10,000.
+   * 
+   * @example
+   * 100
+   */
   smartRoutingRequest?: string;
+  /**
+   * @remarks
+   * The prepaid HTTP requests included in the plan, in units of 10,000.
+   * 
+   * @example
+   * 100
+   */
   staticRequest?: string;
   /**
    * @remarks
    * The instance status. Valid values:
-   * 
-   * - **online**: The plan instance is active.
-   * 
-   * - **offline**: The plan instance is unavailable because it has expired but is still within the grace period.
-   * 
-   * - **disable**: The plan instance is released.
+   * - **online**: The plan instance is in normal service.
+   * - **offline**: The plan instance has expired but has not exceeded the grace period and is not active.
+   * - **disable**: The plan instance has been released.
    * 
    * @example
    * online
    */
   status?: string;
+  /**
+   * @remarks
+   * The plan subscription type. Valid values:
+   * 
+   * - entranceplan: Free Edition (Chinese mainland)
+   * - entranceplan_intl: Free Edition (International)
+   * - basicplan: Basic Edition
+   * - standardplan: Standard Edition
+   * - advancedplan: Premium Edition
+   * - enterpriseplan: Enterprise Edition.
+   * 
+   * @example
+   * basicplan
+   */
   subscribeType?: string;
   static names(): { [key: string]: string } {
     return {
@@ -269,12 +377,12 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
 export class ListUserRatePlanInstancesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * An array of plan instances that meet the specified criteria.
+   * The plan instances that match the specified conditions under the user.
    */
   instanceInfo?: ListUserRatePlanInstancesResponseBodyInstanceInfo[];
   /**
    * @remarks
-   * The page number.
+   * The current page number, which is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -282,7 +390,7 @@ export class ListUserRatePlanInstancesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The page size.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -298,7 +406,7 @@ export class ListUserRatePlanInstancesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total count of entries.
+   * The total number of entries.
    * 
    * @example
    * 68

package/src/models/ListUserRoutinesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUserRoutinesRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number of the returned page. Default value: 1. Valid values: 1 to 10.
+   * The page number. Default value: 1. Maximum value: 10.
    * 
    * @example
    * 1
@@ -21,7 +21,7 @@ export class ListUserRoutinesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The keyword used for fuzzy search.
+   * The keyword for fuzzy match.
    * 
    * @example
    * hello

package/src/models/ListUserRoutinesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUserRoutinesResponseBodyRoutines extends $dara.Model {
   /**
    * @remarks
-   * The time when the function was created.
+   * The time when the Edge Routine was created. The time follows the RFC 3339 standard in the UTC time zone.
    * 
    * @example
    * 2024-03-11T01:23:02.883361712Z
@@ -13,7 +13,7 @@ export class ListUserRoutinesResponseBodyRoutines extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The default record name to access.
+   * The default access record associated with the Routine.
    * 
    * @example
    * serverless-test-2.154edaf6.er.aliyun-esa.net
@@ -21,7 +21,7 @@ export class ListUserRoutinesResponseBodyRoutines extends $dara.Model {
   defaultRelatedRecord?: string;
   /**
    * @remarks
-   * The function description.
+   * The Routine description.
    * 
    * @example
    * ZWRpdCByb3V0aW5lIGNvbmZpZyBkZXNjcmlwdGlvbg==
@@ -29,7 +29,7 @@ export class ListUserRoutinesResponseBodyRoutines extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Specifies whether to include the Assets file tag.
+   * Indicates whether the Routine contains asset files.
    * 
    * @example
    * false
@@ -37,7 +37,7 @@ export class ListUserRoutinesResponseBodyRoutines extends $dara.Model {
   hasAssets?: boolean;
   /**
    * @remarks
-   * The function name.
+   * The Routine name.
    * 
    * @example
    * hello
@@ -75,7 +75,7 @@ export class ListUserRoutinesResponseBodyRoutines extends $dara.Model {
 export class ListUserRoutinesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: 1.
+   * The current page number.
    * 
    * @example
    * 1
@@ -91,7 +91,7 @@ export class ListUserRoutinesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The maximum number of functions supported by the billing plan.
+   * The Routine quota for the current plan.
    * 
    * @example
    * 20
@@ -107,12 +107,12 @@ export class ListUserRoutinesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The functions.
+   * The list of Routines.
    */
   routines?: ListUserRoutinesResponseBodyRoutines[];
   /**
    * @remarks
-   * The total count.
+   * The total number of entries.
    * 
    * @example
    * 3
@@ -120,7 +120,7 @@ export class ListUserRoutinesResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The number of functions that were already created.
+   * The number of Routines already created.
    * 
    * @example
    * 5

package/src/models/ListVideoProcessingsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListVideoProcessingsRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID, You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the ID.
+   * The configuration ID. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the configuration ID.
    * 
    * @example
    * 35281609698****
@@ -13,12 +13,7 @@ export class ListVideoProcessingsRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type. Use this parameter to query global configurations or feature configurations. This parameter takes effect only if the functionName parameter is passed.
-   * 
-   * Valid values:
-   * 
-   * *   global
-   * *   rule
+   * The configuration type. You can use this parameter to query global or rule configurations. This parameter takes effect only when functionName is specified.
    * 
    * @example
    * global
@@ -26,7 +21,7 @@ export class ListVideoProcessingsRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * The page number. Default value: 1.
+   * The page number for a paged query. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -34,7 +29,7 @@ export class ListVideoProcessingsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. Maximum value: 500. Default value: 500.
+   * The number of entries per page for a paged query. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -42,7 +37,7 @@ export class ListVideoProcessingsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The rule name. This parameter takes effect only when parameter functionName is specified.
+   * The rule name. You can use this parameter to query the rule that matches the specified name. This parameter takes effect only when functionName is specified.
    * 
    * @example
    * rule_example
@@ -50,7 +45,7 @@ export class ListVideoProcessingsRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -60,7 +55,7 @@ export class ListVideoProcessingsRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 1