@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/ListTransportLayerApplicationsResponseBody.ts

@@ -5,11 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends $dara.Model {
   /**
    * @remarks
-   * Client IP pass-through protocol, supports:
-   * - **off**: No pass-through.
-   * - **PPv1**: PROXY Protocol v1, supports client IP pass-through for TCP protocol.
-   * - **PPv2**: PROXY Protocol v2, supports client IP pass-through for TCP and UDP protocols.
-   * - **SPP**: Simple Proxy Protocol, supports client IP pass-through for UDP protocol.
+   * 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.
    * 
    * @example
    * off
@@ -17,19 +21,21 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   clientIPPassThroughMode?: string;
   /**
    * @remarks
-   * Comment information for the rule.
+   * The comment for the rule.
    * 
    * @example
-   * test
+   * Test
    */
   comment?: string;
   /**
    * @remarks
-   * Edge port. Supports:
+   * The edge port. The following formats are supported:
+   * 
+   * - A single port, for example, `80`.
+   * 
+   * - A port range, for example, `81-85`, which includes ports 81, 82, 83, 84, and 85.
    * 
-   * - A single port, e.g., 80.
-   * - Port range, e.g., 81-85, representing ports 81, 82, 83, 84, 85.
-   * - Combination of ports and port ranges, separated by commas, e.g., 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, 90.
+   * - 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.
    * 
    * @example
    * 80
@@ -37,10 +43,11 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   edgePort?: string;
   /**
    * @remarks
-   * Forwarding rule protocol, with values:
+   * The protocol of the forwarding rule. Valid values:
    * 
-   * - TCP: TCP protocol.
-   * - UDP: UDP protocol.
+   * - **TCP**: The TCP protocol.
+   * 
+   * - **UDP**: The UDP protocol.
    * 
    * @example
    * TCP
@@ -48,7 +55,7 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   protocol?: string;
   /**
    * @remarks
-   * Layer 4 acceleration rule ID.
+   * The unique ID of the forwarding rule.
    * 
    * @example
    * 20258028****
@@ -56,7 +63,7 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   ruleId?: number;
   /**
    * @remarks
-   * Specific value of the source, which needs to match the source type.
+   * The origin address. The value of this parameter must match the `SourceType`.
    * 
    * @example
    * 1.1.1.1
@@ -64,10 +71,11 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   source?: string;
   /**
    * @remarks
-   * Source port. Supports:
+   * The origin port. The following formats are supported:
+   * 
+   * - A single port. If you specify a single origin port, you can use any valid combination of edge ports.
    * 
-   * - A single port, when the source port is a single port, any valid combination of edge ports is supported.
-   * - Port range, only when the edge port is a port range, the source port can be set to a port range, and the range size must be consistent with the edge port. For example, if the edge port is 90-93, the source port cannot be set to 81-85 because the source port range is 5 and the edge port range is 3, which are inconsistent.
+   * - 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.
    * 
    * @example
    * 80
@@ -75,11 +83,15 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
   sourcePort?: string;
   /**
    * @remarks
-   * Source type, supports:
-   * - **ip**: IP.
-   * - **domain**: Domain name.
-   * - **OP**: Origin pool.
-   * - **LB**: Load balancer.
+   * The origin type. Valid values:
+   * 
+   * - **ip**: An IP address.
+   * 
+   * - **domain**: A domain name.
+   * 
+   * - **OP**: An origin pool.
+   * 
+   * - **LB**: A load balancer.
    * 
    * @example
    * ip
@@ -121,7 +133,27 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsRules extends
 }
 
 export class ListTransportLayerApplicationsResponseBodyApplicationsStaticIpV4List extends $dara.Model {
+  /**
+   * @remarks
+   * The IP address.
+   * 
+   * @example
+   * 1.1.1.2
+   */
   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.
+   * 
+   * - unknown: The IP address is being provisioned.
+   * 
+   * @example
+   * healthy
+   */
   status?: string;
   static names(): { [key: string]: string } {
     return {
@@ -149,7 +181,7 @@ export class ListTransportLayerApplicationsResponseBodyApplicationsStaticIpV4Lis
 export class ListTransportLayerApplicationsResponseBodyApplications extends $dara.Model {
   /**
    * @remarks
-   * Layer 4 application ID.
+   * The transport layer application ID.
    * 
    * @example
    * 170997271816****
@@ -157,7 +189,7 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   applicationId?: number;
   /**
    * @remarks
-   * CNAME domain name corresponding to the Layer 4 acceleration application. This field is not empty only when the site is accessed via CNAME.
+   * The CNAME for the transport layer application. This parameter is returned only when the site is onboarded by using a CNAME record.
    * 
    * @example
    * example.com.ialicdn.com
@@ -165,9 +197,10 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   cname?: string;
   /**
    * @remarks
-   * Whether to enable China mainland network access optimization. It is disabled by default. The value range is:
+   * Specifies whether cross-border optimization is enabled for Chinese mainland network access. By default, this feature is disabled. Valid values:
    * 
    * - on: Enabled.
+   * 
    * - off: Disabled.
    * 
    * @example
@@ -176,9 +209,10 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   crossBorderOptimization?: string;
   /**
    * @remarks
-   * IP access rule switch. When enabled, the IP access rules in WAF take effect on the Layer 4 application.
+   * Specifies whether the IP access rule feature is enabled. When enabled, the IP access rules in WAF apply to this transport layer application.
    * 
    * - on: Enabled.
+   * 
    * - off: Disabled.
    * 
    * @example
@@ -187,16 +221,20 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   ipAccessRule?: string;
   /**
    * @remarks
-   * IPv6 switch.
+   * Specifies whether IPv6 is enabled.
    * 
    * @example
    * on
    */
   ipv6?: string;
+  /**
+   * @remarks
+   * Specifies whether keep-alive protection is enabled.
+   */
   keepAliveProtection?: string;
   /**
    * @remarks
-   * Domain name of the Layer 4 application.
+   * The domain name of the transport layer application.
    * 
    * @example
    * test.example.com
@@ -204,12 +242,12 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   recordName?: string;
   /**
    * @remarks
-   * List of forwarding rules.
+   * A list of forwarding rules.
    */
   rules?: ListTransportLayerApplicationsResponseBodyApplicationsRules[];
   /**
    * @remarks
-   * Number of forwarding rules contained in the Layer 4 acceleration application.
+   * The number of forwarding rules in the transport layer application.
    * 
    * @example
    * 1
@@ -217,24 +255,38 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
   rulesCount?: number;
   /**
    * @remarks
-   * Site ID.
+   * The site ID.
    * 
    * @example
    * 36556540048****
    */
   siteId?: number;
+  /**
+   * @remarks
+   * Specifies whether the static IP feature is enabled. By default, this feature is disabled. Valid values:
+   * 
+   * - on: Enabled.
+   * 
+   * - off: Disabled.
+   * 
+   * @example
+   * on
+   */
   staticIp?: string;
   /**
    * @remarks
+   * A list of static IPv4 addresses assigned to the application when the static IP feature is enabled.
+   * 
    * This parameter is required.
    */
   staticIpV4List?: ListTransportLayerApplicationsResponseBodyApplicationsStaticIpV4List[];
   /**
    * @remarks
-   * Status of the Layer 4 application
+   * 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.
    * 
-   * - **deploying**: Deploying. In this state, modification and deletion are not allowed.
-   * - **active**: Active.
+   * - **active**: The application is running.
    * 
    * @example
    * active
@@ -294,12 +346,12 @@ export class ListTransportLayerApplicationsResponseBodyApplications extends $dar
 export class ListTransportLayerApplicationsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * List of transport layer applications.
+   * A list of transport layer applications.
    */
   applications?: ListTransportLayerApplicationsResponseBodyApplications[];
   /**
    * @remarks
-   * Current page number.
+   * The current page number.
    * 
    * @example
    * 1
@@ -307,7 +359,7 @@ export class ListTransportLayerApplicationsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Page size.
+   * The number of entries per page.
    * 
    * @example
    * 1
@@ -315,7 +367,7 @@ export class ListTransportLayerApplicationsResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
@@ -323,7 +375,7 @@ export class ListTransportLayerApplicationsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Total number of transport layer applications.
+   * The total number of transport layer applications.
    * 
    * @example
    * 1

package/src/models/ListUserRatePlanInstancesRequest.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListUserRatePlanInstancesRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to query only the plans that have remaining quota for associating websites. Valid values:
+   * Specifies whether to filter for rate plan instances that have a remaining site quota. Valid values:
    * 
-   * *   true: queries only the plans that have remaining quota for associating websites.
-   * *   false: queries all plans in your account.
+   * - **true**: Returns only rate plan instances that have a remaining site quota.
+   * 
+   * - **false**: Returns all rate plan instances for the user.
    * 
    * @example
    * true
@@ -16,7 +17,7 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   checkRemainingSiteQuota?: string;
   /**
    * @remarks
-   * The plan ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The ID of the rate plan instance to query.
    * 
    * @example
    * sp-xcdn-96wblslz****
@@ -24,7 +25,7 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number. Valid values: **1** to **100000**. Default value: **1**.
+   * The page number. The default value is **1**. The value must be in the range of **1 to 100,000**.
    * 
    * @example
    * 1
@@ -32,7 +33,7 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries to return on each page.
    * 
    * @example
    * 500
@@ -43,10 +44,11 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   remainingExpireDays?: number;
   /**
    * @remarks
-   * The sorting field. By default, the queried plans are sorted by purchase time. Valid values:
+   * The sort field. By default, results are sorted by creation time. Valid values:
+   * 
+   * - **CreateTime**: Sorts by creation time.
    * 
-   * *   CreateTime: the time when the plans were purchased.
-   * *   ExpireTime: the time when the plans expire.
+   * - **ExpireTime**: Sorts by expiration time.
    * 
    * @example
    * CreateTime
@@ -54,10 +56,11 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   sortBy?: string;
   /**
    * @remarks
-   * The order in which you want to sort the query results. Default value: desc. Valid values:
+   * The sort order. The default is descending. Valid values:
+   * 
+   * - **asc**: Sorts in ascending order.
    * 
-   * *   asc: in ascending order.
-   * *   desc: in descending order.
+   * - **desc**: Sorts in descending order.
    * 
    * @example
    * asc
@@ -65,12 +68,15 @@ export class ListUserRatePlanInstancesRequest extends $dara.Model {
   sortOrder?: string;
   /**
    * @remarks
-   * The plan status. Valid values:
+   * 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.
    * 
-   * *   online: The plan is in service.
-   * *   offline: The plan has expired within an allowable period. In this state, the plan is unavailable.
-   * *   disable: The plan is released.
-   * *   overdue: The plan is stopped due to overdue payments.
+   * - **overdue**: The instance is overdue.
    * 
    * @example
    * online

package/src/models/ListUserRatePlanInstancesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUserRatePlanInstancesResponseBodyInstanceInfoSites extends $dara.Model {
   /**
    * @remarks
-   * The website ID.
+   * The site ID.
    * 
    * @example
    * 123456****
@@ -13,7 +13,7 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfoSites extends $dar
   siteId?: number;
   /**
    * @remarks
-   * The website name.
+   * The site name.
    * 
    * @example
    * example.com
@@ -21,12 +21,15 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfoSites extends $dar
   siteName?: string;
   /**
    * @remarks
-   * The website status. Valid values:
+   * The site status. Valid values:
    * 
-   * *   pending: The website is to be configured.
-   * *   active: The website is active.
-   * *   offline: The website is suspended.
-   * *   moved: The website has been added and verified by another Alibaba Cloud account.
+   * - **pending**: The site is pending configuration.
+   * 
+   * - **active**: The site is active.
+   * 
+   * - **offline**: The site is offline.
+   * 
+   * - **moved**: The site has been replaced.
    * 
    * @example
    * pending
@@ -62,8 +65,9 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
    * @remarks
    * The billing method. Valid values:
    * 
-   * *   PREPAY: subscription.
-   * *   POSTPAY: pay-as-you-go.
+   * - **PREPAY**: subscription.
+   * 
+   * - **POSTPAY**: pay-as-you-go.
    * 
    * @example
    * PREPAY
@@ -73,11 +77,13 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
   botRequest?: string;
   /**
    * @remarks
-   * The service locations for the websites that can be associated with the plan. Multiple values are separated by commas (,). Valid values:
+   * The acceleration regions covered by the plan instance. Multiple values are separated by commas (,). Valid values:
    * 
-   * *   domestic: the Chinese mainland.
-   * *   overseas: outside the Chinese mainland.
-   * *   global: global.
+   * - **domestic**: The Chinese mainland.
+   * 
+   * - **overseas**: Regions outside the Chinese mainland.
+   * 
+   * - **global**: Global (including the Chinese mainland).
    * 
    * @example
    * domestic,overseas
@@ -85,7 +91,7 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
   coverages?: string;
   /**
    * @remarks
-   * The time when the plan was purchased.
+   * The creation time.
    * 
    * @example
    * YYYY-MM-DDThh:mm:ssZ
@@ -97,7 +103,7 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
   ddosInstanceLevel?: string;
   /**
    * @remarks
-   * The subscription duration of the plan. Unit: month.
+   * The duration in months.
    * 
    * @example
    * 3
@@ -107,7 +113,7 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
   edgeWafRequest?: string;
   /**
    * @remarks
-   * The time when the plan expires.
+   * The expiration time.
    * 
    * @example
    * YYYY-MM-DDThh:mm:ssZ
@@ -115,7 +121,7 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
   expireTime?: string;
   /**
    * @remarks
-   * The plan ID.
+   * The plan instance ID.
    * 
    * @example
    * sp-xcdn-96wblslz****
@@ -136,16 +142,27 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
    * @remarks
    * The plan type. Valid values:
    * 
-   * *   normal
-   * *   enterprise
+   * - **normal**: The normal plan.
+   * 
+   * - **enterprise**: The enterprise plan.
    * 
    * @example
    * normal
    */
   planType?: string;
+  /**
+   * @example
+   * 6
+   */
+  renewalDuration?: number;
+  /**
+   * @example
+   * nomal
+   */
+  renewalStatus?: string;
   /**
    * @remarks
-   * The maximum number of websites that can be associated with the plan.
+   * The site quota.
    * 
    * @example
    * 1
@@ -153,18 +170,20 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
   siteQuota?: string;
   /**
    * @remarks
-   * The websites that have been associated with the plan.
+   * The sites associated with this plan instance.
    */
   sites?: ListUserRatePlanInstancesResponseBodyInstanceInfoSites[];
   smartRoutingRequest?: string;
   staticRequest?: string;
   /**
    * @remarks
-   * The plan status. Valid values:
+   * 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.
    * 
-   * *   online: The plan is in service.
-   * *   offline: The plan has expired within an allowable period. In this state, the plan is unavailable.
-   * *   disable: The plan is released.
+   * - **disable**: The plan instance is released.
    * 
    * @example
    * online
@@ -192,6 +211,8 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
       planName: 'PlanName',
       planTraffic: 'PlanTraffic',
       planType: 'PlanType',
+      renewalDuration: 'RenewalDuration',
+      renewalStatus: 'RenewalStatus',
       siteQuota: 'SiteQuota',
       sites: 'Sites',
       smartRoutingRequest: 'SmartRoutingRequest',
@@ -222,6 +243,8 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
       planName: 'string',
       planTraffic: 'string',
       planType: 'string',
+      renewalDuration: 'number',
+      renewalStatus: 'string',
       siteQuota: 'string',
       sites: { 'type': 'array', 'itemType': ListUserRatePlanInstancesResponseBodyInstanceInfoSites },
       smartRoutingRequest: 'string',
@@ -246,7 +269,7 @@ export class ListUserRatePlanInstancesResponseBodyInstanceInfo extends $dara.Mod
 export class ListUserRatePlanInstancesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The queried plans.
+   * An array of plan instances that meet the specified criteria.
    */
   instanceInfo?: ListUserRatePlanInstancesResponseBodyInstanceInfo[];
   /**
@@ -259,7 +282,7 @@ export class ListUserRatePlanInstancesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The page size.
    * 
    * @example
    * 10
@@ -275,7 +298,7 @@ export class ListUserRatePlanInstancesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total count of entries.
    * 
    * @example
    * 68
@@ -283,7 +306,7 @@ export class ListUserRatePlanInstancesResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The total number of pages returned.
+   * The total number of pages.
    * 
    * @example
    * 1

package/src/models/ListUserRoutinesRequest.ts

@@ -8,7 +8,7 @@ export class ListUserRoutinesRequest extends $dara.Model {
    * The page number of the returned page. Default value: 1. Valid values: 1 to 10.
    * 
    * @example
-   * ListUserRoutines
+   * 1
    */
   pageNumber?: number;
   /**