@alicloud/esa20240910 3.2.0 → 3.4.0

package/src/models/ListTransportLayerApplicationsResponseBody.ts

@@ -5,15 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether and how to pass the client\\"s IP address to the origin server. Valid values:
-   * 
-   * - **off**: Disables client IP pass-through.
-   * 
-   * - **PPv1**: The PROXY Protocol v1, which supports client IP pass-through for TCP traffic.
-   * 
-   * - **PPv2**: The PROXY Protocol v2, which supports client IP pass-through for both TCP and UDP traffic.
-   * 
-   * - **SPP**: The Simple Proxy Protocol, which supports client IP pass-through for UDP traffic.
+   * The client IP pass-through protocol. Supported values:
+   * - **off**: Disabled.
+   * - **PPv1**: PROXY Protocol v1, which supports client IP pass-through for TCP protocol.
+   * - **PPv2**: PROXY Protocol v2, which supports client IP pass-through for TCP and UDP protocols.
+   * - **SPP**: Simple Proxy Protocol, which supports client IP pass-through for UDP protocol.
    * 
    * @example
    * off
@@ -29,13 +25,11 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   comment?: string;
   /**
    * @remarks
-   * The edge port. The following formats are supported:
+   * The edge port. Supported formats:
    * 
-   * - A single port, for example, `80`.
-   * 
-   * - A port range, for example, `81-85`, which includes ports 81, 82, 83, 84, and 85.
-   * 
-   * - A combination of ports and port ranges separated by commas, for example, `80,81-85,90`, which includes ports 80, 81, 82, 83, 84, 85, and 90.
+   * - A single port, such as 80.
+   * - A port range, such as 81-85, which represents ports 81, 82, 83, 84, and 85.
+   * - A combination of ports and port ranges separated by commas, such as 80,81-85,90, which represents ports 80, 81, 82, 83, 84, 85, and 90.
    * 
    * @example
    * 80
@@ -45,9 +39,8 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
    * @remarks
    * The protocol of the forwarding rule. Valid values:
    * 
-   * - **TCP**: The TCP protocol.
-   * 
-   * - **UDP**: The UDP protocol.
+   * - TCP: TCP protocol.
+   * - UDP: UDP protocol.
    * 
    * @example
    * TCP
@@ -55,7 +48,7 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   protocol?: string;
   /**
    * @remarks
-   * The unique ID of the forwarding rule.
+   * The Layer 4 acceleration rule ID.
    * 
    * @example
    * 20258028****
@@ -63,7 +56,7 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   ruleId?: number;
   /**
    * @remarks
-   * The origin address. The value of this parameter must match the `SourceType`.
+   * The specific value of the origin, which must match the origin type.
    * 
    * @example
    * 1.1.1.1
@@ -71,11 +64,10 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   source?: string;
   /**
    * @remarks
-   * The origin port. The following formats are supported:
+   * The origin port. Supported formats:
    * 
-   * - A single port. If you specify a single origin port, you can use any valid combination of edge ports.
-   * 
-   * - A port range. The origin port can be a port range only if the edge port is also a port range. The number of ports in the origin port range must be the same as that in the edge port range. For example, if the edge port range is `90-93` (which contains 4 ports), you cannot set the origin port range to `81-85` (which contains 5 ports) because their sizes do not match.
+   * - A single port. When the origin port is a single port, any valid combination of edge ports is supported.
+   * - A port range. The origin port can be set to a port range only when the edge port is a port range, and the range size must be the same as that of the edge port. For example, if the edge port is 90-93, the origin port cannot be set to 81-85, because the origin port range size is 5 while the edge port range size is 3, which are inconsistent.
    * 
    * @example
    * 80
@@ -83,15 +75,11 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   sourcePort?: string;
   /**
    * @remarks
-   * The origin type. Valid values:
-   * 
-   * - **ip**: An IP address.
-   * 
-   * - **domain**: A domain name.
-   * 
-   * - **OP**: An origin pool.
-   * 
-   * - **LB**: A load balancer.
+   * The origin type. Supported values:
+   * - **ip**: IP address.
+   * - **domain**: Domain name.
+   * - **OP**: Origin pool.
+   * - **LB**: Load balancer.
    * 
    * @example
    * ip
@@ -143,13 +131,11 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsStaticIpV4Lis
   address?: string;
   /**
    * @remarks
-   * The health status of the IP address. Valid values:
-   * 
-   * - healthy: The IP address is passing health checks.
-   * 
-   * - unhealthy: The IP address is failing health checks.
+   * The status of the IP address. Valid values:
    * 
-   * - unknown: The IP address is being provisioned.
+   * - healthy: Healthy.
+   * - unhealthy: Unhealthy.
+   * - unknown: IP address is being prepared.
    * 
    * @example
    * healthy
@@ -181,7 +167,7 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsStaticIpV4Lis
 export class ListTransportLayerApplicationsResponseBodyApplications extends $dara.Model {
   /**
    * @remarks
-   * The transport layer application ID.
+   * The Layer 4 application ID.
    * 
    * @example
    * 170997271816****
@@ -189,7 +175,7 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   applicationId?: number;
   /**
    * @remarks
-   * The CNAME for the transport layer application. This parameter is returned only when the site is onboarded by using a CNAME record.
+   * The CNAME domain name corresponding to the Layer 4 acceleration application. This field is non-empty only when the site is connected via the CNAME method.
    * 
    * @example
    * example.com.ialicdn.com
@@ -197,10 +183,9 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   cname?: string;
   /**
    * @remarks
-   * Specifies whether cross-border optimization is enabled for Chinese mainland network access. By default, this feature is disabled. Valid values:
+   * Indicates whether mainland China network access optimization is enabled. Disabled by default. Valid values:
    * 
    * - on: Enabled.
-   * 
    * - off: Disabled.
    * 
    * @example
@@ -209,10 +194,9 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   crossBorderOptimization?: string;
   /**
    * @remarks
-   * Specifies whether the IP access rule feature is enabled. When enabled, the IP access rules in WAF apply to this transport layer application.
+   * The IP access rule switch. When enabled, the IP access rules in WAF take effect for the Layer 4 application.
    * 
    * - on: Enabled.
-   * 
    * - off: Disabled.
    * 
    * @example
@@ -221,7 +205,10 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   ipAccessRule?: string;
   /**
    * @remarks
-   * Specifies whether IPv6 is enabled.
+   * The IPv6 switch. Valid values:
+   * 
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -229,12 +216,18 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   ipv6?: string;
   /**
    * @remarks
-   * Specifies whether keep-alive protection is enabled.
+   * Indicates whether keep-alive protection is enabled. Disabled by default. Valid values:
+   * 
+   * - on: Enabled.
+   * - off: Disabled.
+   * 
+   * @example
+   * off
    */
   keepAliveProtection?: string;
   /**
    * @remarks
-   * The domain name of the transport layer application.
+   * The domain name of the Layer 4 application.
    * 
    * @example
    * test.example.com
@@ -242,12 +235,12 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   recordName?: string;
   /**
    * @remarks
-   * A list of forwarding rules.
+   * The list of forwarding rules.
    */
   rules?: ListTransportLayerApplicationsResponseBodyApplicationsRules[];
   /**
    * @remarks
-   * The number of forwarding rules in the transport layer application.
+   * The number of forwarding rules contained in the Layer 4 acceleration application.
    * 
    * @example
    * 1
@@ -263,10 +256,9 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   siteId?: number;
   /**
    * @remarks
-   * Specifies whether the static IP feature is enabled. By default, this feature is disabled. Valid values:
+   * Indicates whether static IP is enabled. Disabled by default. Valid values:
    * 
    * - on: Enabled.
-   * 
    * - off: Disabled.
    * 
    * @example
@@ -275,18 +267,17 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   staticIp?: string;
   /**
    * @remarks
-   * A list of static IPv4 addresses assigned to the application when the static IP feature is enabled.
+   * The list of static IPv4 addresses assigned to this Layer 4 application after the static IP feature is enabled.
    * 
    * This parameter is required.
    */
   staticIpV4List?: ListTransportLayerApplicationsResponseBodyApplicationsStaticIpV4List[];
   /**
    * @remarks
-   * The status of the transport layer application. Valid values:
-   * 
-   * - **deploying**: The application is being deployed. You cannot modify or delete the application in this state.
+   * The status of the Layer 4 application.
    * 
-   * - **active**: The application is running.
+   * - **deploying**: Deploying. Modification and deletion are not allowed in this state.
+   * - **active**: Active.
    * 
    * @example
    * active
@@ -346,12 +337,12 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
 export class ListTransportLayerApplicationsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of transport layer applications.
+   * The list of Layer 4 applications.
    */
   applications?: ListTransportLayerApplicationsResponseBodyApplications[];
   /**
    * @remarks
-   * The current page number.
+   * The current page number, same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -375,7 +366,7 @@ export class ListTransportLayerApplicationsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of transport layer applications.
+   * The total number of Layer 4 applications.
    * 
    * @example
    * 1

package/src/models/ListUploadTasksRequest.ts

@@ -5,7 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListUploadTasksRequest extends $dara.Model {
   /**
    * @remarks
-   * The time when the task ends. Specify the time in the YYYY-MM-DDThh:mm:ssZ format.
+   * The end time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).
+   * >Notice: StartTime and EndTime must be provided together to define the query time window. An error is returned if either one is missing..
    * 
    * @example
    * 2019-12-06T12:00:00Z
@@ -13,7 +14,8 @@ export class ListUploadTasksRequest extends $dara.Model {
   endTime?: 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 obtain this value by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * >Notice: This parameter is required when you call the ListUploadTasks operation..
    * 
    * @example
    * 123456****
@@ -21,7 +23,8 @@ export class ListUploadTasksRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The time when the task starts. Specify the time in the YYYY-MM-DDThh:mm:ssZ format.
+   * The start time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).
+   * >Notice: StartTime and EndTime must be provided together to define the query time window. An error is returned if either one is missing..
    * 
    * @example
    * 2018-11-29T00:00:00Z
@@ -31,10 +34,10 @@ export class ListUploadTasksRequest extends $dara.Model {
    * @remarks
    * The task type. Valid values:
    * 
-   * *   **file**: purges the cache by file URL.
-   * *   **preload**: prefetches files.
-   * *   **directory**: purges the cache by directory.
-   * *   **ignoreparams**: purges the cache by URL with specified parameters ignored.
+   * - **file**: URL file purge.
+   * - **preload**: resource prefetch.
+   * - **directory**: directory purge.
+   * - **ignoreparams**: purge with parameters ignored.
    * 
    * @example
    * file

package/src/models/ListUploadTasksResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUploadTasksResponseBodyTasks extends $dara.Model {
   /**
    * @remarks
-   * The time when the task was created.
+   * The creation time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).
    * 
    * @example
    * 2023-07-26T01:56:15Z
@@ -13,7 +13,7 @@ export class ListUploadTasksResponseBodyTasks extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The error message returned when the file upload task failed.
+   * The error message returned when the file upload task fails.
    * 
    * @example
    * invalid url
@@ -21,12 +21,12 @@ export class ListUploadTasksResponseBodyTasks extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The error code. Multiple error codes are separated by commas (,).
+   * The error code. Multiple error codes are separated by commas. Valid values:
    * 
-   * *   **InvalidUrl**: The URL format is incorrect.
-   * *   **InvalidDomain**: The domain ownership fails to be verified.
-   * *   **QuotaExcess**: The quota limit has been reached.
-   * *   **OtherErrors**: Other errors.
+   * - **InvalidUrl**: The URL format is invalid.
+   * - **InvalidDomain**: The domain name ownership verification failed.
+   * - **QuotaExcess**: The quota limit is exceeded.
+   * - **OtherErrors**: Other errors occurred.
    * 
    * @example
    * InvalidUrl,InvalidDomain
@@ -34,11 +34,10 @@ export class ListUploadTasksResponseBodyTasks extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The task status.
-   * 
-   * *   **Complete**: The task is complete.
-   * *   **Refreshing**: The task is in progress.
-   * *   **Failed**: The task failed.
+   * The task status. Valid values:
+   * - **Complete**: The task is complete.
+   * - **Refreshing**: The task is in progress.
+   * - **Failed**: The task failed.
    * 
    * @example
    * Complete
@@ -48,10 +47,10 @@ export class ListUploadTasksResponseBodyTasks extends $dara.Model {
    * @remarks
    * The task type. Valid values:
    * 
-   * *   **file**: purges the cache by file URL.
-   * *   **preload**: prefetches files.
-   * *   **directory**: purges the cache by directory.
-   * *   **ignoreparams**: purges the cache by URL with specified parameters ignored.
+   * - **file**: URL file purge.
+   * - **preload**: resource prefetch.
+   * - **directory**: directory purge.
+   * - **ignoreparams**: purge with parameters ignored.
    * 
    * @example
    * file
@@ -109,7 +108,7 @@ export class ListUploadTasksResponseBodyTasks extends $dara.Model {
 export class ListUploadTasksResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-A198-72F8FD6D****
@@ -117,7 +116,7 @@ export class ListUploadTasksResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The file upload tasks.
+   * The list of file upload tasks.
    */
   tasks?: ListUploadTasksResponseBodyTasks[];
   static names(): { [key: string]: string } {

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 {