@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/CreateTransportLayerApplicationRequest.ts

@@ -5,11 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   /**
    * @remarks
-   * Client IP pass-through protocol, supporting:
-   * - **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.
+   * The client IP passthrough protocol. Valid values:
+   * 
+   * - **off**: Disables client IP passthrough.
+   * 
+   * - **PPv1**: PROXY Protocol v1. Preserves the client IP address for TCP connections.
+   * 
+   * - **PPv2**: PROXY Protocol v2. Preserves the client IP address for TCP and UDP connections.
+   * 
+   * - **SPP**: Simple Proxy Protocol. Preserves the client IP address for UDP connections.
    * 
    * This parameter is required.
    * 
@@ -19,21 +23,23 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   clientIPPassThroughMode?: string;
   /**
    * @remarks
-   * Comment information for the rule (optional).
+   * An optional comment for the rule.
    * 
    * @example
-   * test
+   * Test
    */
   comment?: string;
   /**
    * @remarks
-   * Edge port. Supports:
+   * The edge port. Supported formats:
+   * 
+   * - A single port, for example, `80`.
    * 
-   * - A single port, such as 80.
-   * - Port range, such as 81-85, representing ports 81, 82, 83, 84, and 85.
-   * - Combination of ports and port ranges, separated by commas, such as 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, and 90.
+   * - A port range, for example, `81-85`, which includes ports 81, 82, 83, 84, and 85.
    * 
-   * Edge ports within a single rule and between multiple rules must not overlap.
+   * - 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.
+   * 
+   * Edge ports cannot overlap within a single rule or across multiple rules.
    * 
    * This parameter is required.
    * 
@@ -43,10 +49,11 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   edgePort?: string;
   /**
    * @remarks
-   * Forwarding rule protocol, with values:
+   * The forwarding protocol. Valid values:
+   * 
+   * - `TCP`: The TCP protocol.
    * 
-   * - TCP: TCP protocol.
-   * - UDP: UDP protocol.
+   * - `UDP`: The UDP protocol.
    * 
    * This parameter is required.
    * 
@@ -56,7 +63,7 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * Specific value of the origin, which needs to match the origin type.
+   * The origin address. The value must match the specified `SourceType`.
    * 
    * This parameter is required.
    * 
@@ -66,10 +73,11 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   source?: string;
   /**
    * @remarks
-   * Origin port. Supports:
+   * The origin port. Supported formats:
    * 
-   * - A single port, when the origin 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 origin port can be set to a port range, and the size of the range must match 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 is 5 and the edge port range is 3, which do not match.
+   * - A single port, which supports any valid combination of edge ports.
+   * 
+   * - A port range. You can specify a port range only if the edge port is also a port range. The origin and edge port ranges must be the same size. For example, if the edge port range is `90-93` (4 ports), the origin port range cannot be `81-85` (5 ports).
    * 
    * This parameter is required.
    * 
@@ -79,11 +87,15 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
   sourcePort?: string;
   /**
    * @remarks
-   * Origin type, supporting:
-   * - **ip**: IP address.
-   * - **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.
    * 
    * This parameter is required.
    * 
@@ -127,9 +139,11 @@ export class CreateTransportLayerApplicationRequestRules extends $dara.Model {
 export class CreateTransportLayerApplicationRequest extends $dara.Model {
   /**
    * @remarks
-   * Whether to enable China mainland network access optimization, default is disabled. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Enables or disables network optimization for access from the Chinese mainland. This feature is disabled by default. Valid values:
+   * 
+   * - `on`: Enables the optimization.
+   * 
+   * - `off`: Disables the optimization.
    * 
    * @example
    * on
@@ -137,10 +151,11 @@ export class CreateTransportLayerApplicationRequest extends $dara.Model {
   crossBorderOptimization?: string;
   /**
    * @remarks
-   * IP access rule switch. When enabled, the WAF\\"s IP access rules apply to the transport layer application.
+   * Applies IP access rules from Web Application Firewall (WAF) to this Transport Layer Application. Valid values:
    * 
-   * - on: Enabled.
-   * - off: Disabled.
+   * - `on`: Enables the feature.
+   * 
+   * - `off`: Disables the feature.
    * 
    * @example
    * on
@@ -148,16 +163,20 @@ export class CreateTransportLayerApplicationRequest extends $dara.Model {
   ipAccessRule?: string;
   /**
    * @remarks
-   * IPv6 switch.
+   * Enables or disables IPv6 support.
    * 
    * @example
    * off
    */
   ipv6?: string;
+  /**
+   * @remarks
+   * Enables or disables keep-alive protection.
+   */
   keepAliveProtection?: string;
   /**
    * @remarks
-   * Domain name of the transport layer application.
+   * The domain name of the Transport Layer Application.
    * 
    * This parameter is required.
    * 
@@ -167,14 +186,14 @@ export class CreateTransportLayerApplicationRequest extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * List of forwarding rules.
+   * The list of forwarding rules.
    * 
    * This parameter is required.
    */
   rules?: CreateTransportLayerApplicationRequestRules[];
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateTransportLayerApplicationResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateTransportLayerApplicationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Layer 4 application ID
+   * The Layer 4 application ID.
    * 
    * @example
    * 165503967****
@@ -13,7 +13,7 @@ export class CreateTransportLayerApplicationResponseBody extends $dara.Model {
   applicationId?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 9e5448c7-edaf-49aa-9887-0fcd0832306c

package/src/models/CreateTransportLayerApplicationShrinkRequest.ts

@@ -5,9 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Whether to enable China mainland network access optimization, default is disabled. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Enables or disables network optimization for access from the Chinese mainland. This feature is disabled by default. Valid values:
+   * 
+   * - `on`: Enables the optimization.
+   * 
+   * - `off`: Disables the optimization.
    * 
    * @example
    * on
@@ -15,10 +17,11 @@ export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
   crossBorderOptimization?: string;
   /**
    * @remarks
-   * IP access rule switch. When enabled, the WAF\\"s IP access rules apply to the transport layer application.
+   * Applies IP access rules from Web Application Firewall (WAF) to this Transport Layer Application. Valid values:
+   * 
+   * - `on`: Enables the feature.
    * 
-   * - on: Enabled.
-   * - off: Disabled.
+   * - `off`: Disables the feature.
    * 
    * @example
    * on
@@ -26,16 +29,20 @@ export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
   ipAccessRule?: string;
   /**
    * @remarks
-   * IPv6 switch.
+   * Enables or disables IPv6 support.
    * 
    * @example
    * off
    */
   ipv6?: string;
+  /**
+   * @remarks
+   * Enables or disables keep-alive protection.
+   */
   keepAliveProtection?: string;
   /**
    * @remarks
-   * Domain name of the transport layer application.
+   * The domain name of the Transport Layer Application.
    * 
    * This parameter is required.
    * 
@@ -45,14 +52,14 @@ export class CreateTransportLayerApplicationShrinkRequest extends $dara.Model {
   recordName?: string;
   /**
    * @remarks
-   * List of forwarding rules.
+   * The list of forwarding rules.
    * 
    * This parameter is required.
    */
   rulesShrink?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateUserDeliveryTaskRequest.ts

@@ -7,7 +7,7 @@ import { HttpDeliveryQueryParamValue } from "./HttpDeliveryQueryParamValue";
 export class CreateUserDeliveryTaskRequestHttpDeliveryStandardAuthParam extends $dara.Model {
   /**
    * @remarks
-   * The validity period of the signature.
+   * The expiration time, in seconds.
    * 
    * @example
    * 300
@@ -65,7 +65,7 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   compress?: string;
   /**
    * @remarks
-   * The address of the HTTP server.
+   * The URL of the destination endpoint.
    * 
    * @example
    * http://xxx.aliyun.com/v1/log/upload
@@ -73,12 +73,12 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   destUrl?: string;
   /**
    * @remarks
-   * The custom headers.
+   * Custom HTTP headers.
    */
   headerParam?: { [key: string]: HttpDeliveryHeaderParamValue };
   /**
    * @remarks
-   * The ending separator.
+   * The trailing delimiter.
    * 
    * @example
    * \\n
@@ -86,7 +86,7 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   lastLogSplit?: boolean;
   /**
    * @remarks
-   * The prefix of the log delivery package.
+   * The prefix to add to the log delivery payload.
    * 
    * @example
    * cdnVersion:1.0
@@ -94,7 +94,7 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   logBodyPrefix?: string;
   /**
    * @remarks
-   * The suffix of the log delivery package.
+   * The suffix to add to the log delivery payload.
    * 
    * @example
    * cdnVersion:1.0
@@ -102,7 +102,7 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   logBodySuffix?: string;
   /**
    * @remarks
-   * Specifies whether to enable log splitting. Default value: true.
+   * Specifies whether to split log entries. Defaults to true.
    * 
    * @example
    * true
@@ -110,7 +110,7 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   logSplit?: boolean;
   /**
    * @remarks
-   * The log separator.
+   * The delimiter for log entries.
    * 
    * @example
    * \\n
@@ -118,7 +118,7 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   logSplitWords?: string;
   /**
    * @remarks
-   * The maximum size of data for each delivery. Unit: MB.
+   * The maximum size of a delivery batch, in MB.
    * 
    * @example
    * 5
@@ -126,7 +126,7 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   maxBatchMB?: number;
   /**
    * @remarks
-   * The maximum number of entries for each delivery.
+   * The maximum number of log entries per delivery request.
    * 
    * @example
    * 1000
@@ -134,7 +134,7 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   maxBatchSize?: number;
   /**
    * @remarks
-   * The maximum number of retries.
+   * The maximum number of retries if a delivery fails.
    * 
    * @example
    * 3
@@ -142,12 +142,12 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   maxRetry?: number;
   /**
    * @remarks
-   * The custom query parameters.
+   * Custom query parameters.
    */
   queryParam?: { [key: string]: HttpDeliveryQueryParamValue };
   /**
    * @remarks
-   * Specifies whether to use server authentication.
+   * Specifies whether to enable standard authentication.
    * 
    * @example
    * true
@@ -155,12 +155,12 @@ export class CreateUserDeliveryTaskRequestHttpDelivery extends $dara.Model {
   standardAuthOn?: boolean;
   /**
    * @remarks
-   * The authentication configurations.
+   * Configuration for standard authentication.
    */
   standardAuthParam?: CreateUserDeliveryTaskRequestHttpDeliveryStandardAuthParam;
   /**
    * @remarks
-   * The timeout period. Unit: seconds.
+   * The delivery timeout, in seconds.
    * 
    * @example
    * 10
@@ -235,20 +235,20 @@ export class CreateUserDeliveryTaskRequestKafkaDelivery extends $dara.Model {
   balancer?: string;
   /**
    * @remarks
-   * The brokers.
+   * A list of Kafka brokers.
    */
   brokers?: string[];
   /**
    * @remarks
-   * The compression method. By default, data is not compressed.
+   * The compression method. Disabled by default.
    * 
    * @example
-   * gzip
+   * lz4
    */
   compress?: string;
   /**
    * @remarks
-   * The encryption method.
+   * The authentication mechanism.
    * 
    * @example
    * plain
@@ -256,7 +256,7 @@ export class CreateUserDeliveryTaskRequestKafkaDelivery extends $dara.Model {
   machanismType?: string;
   /**
    * @remarks
-   * The password.
+   * The password for authentication.
    * 
    * @example
    * xxx
@@ -264,7 +264,7 @@ export class CreateUserDeliveryTaskRequestKafkaDelivery extends $dara.Model {
   password?: string;
   /**
    * @remarks
-   * The topic.
+   * The Kafka topic.
    * 
    * @example
    * dqc_test2
@@ -272,7 +272,7 @@ export class CreateUserDeliveryTaskRequestKafkaDelivery extends $dara.Model {
   topic?: string;
   /**
    * @remarks
-   * Specifies whether to enable authentication.
+   * Specifies whether to enable user authentication.
    * 
    * @example
    * true
@@ -280,7 +280,7 @@ export class CreateUserDeliveryTaskRequestKafkaDelivery extends $dara.Model {
   userAuth?: boolean;
   /**
    * @remarks
-   * The username.
+   * The username for authentication.
    * 
    * @example
    * xxx
@@ -327,7 +327,7 @@ export class CreateUserDeliveryTaskRequestKafkaDelivery extends $dara.Model {
 export class CreateUserDeliveryTaskRequestOssDelivery extends $dara.Model {
   /**
    * @remarks
-   * The ID of your Alibaba Cloud account.
+   * The Alibaba Cloud account ID.
    * 
    * @example
    * 1234***
@@ -335,7 +335,7 @@ export class CreateUserDeliveryTaskRequestOssDelivery extends $dara.Model {
   aliuid?: string;
   /**
    * @remarks
-   * The name of the OSS bucket.
+   * The bucket name.
    * 
    * @example
    * test_rlog
@@ -343,18 +343,18 @@ export class CreateUserDeliveryTaskRequestOssDelivery extends $dara.Model {
   bucketName?: string;
   /**
    * @remarks
-   * The prefix of the path in which you want to store logs.
+   * The object key prefix.
    * 
    * @example
-   * logriver-test/log
+   * test/
    */
   prefixPath?: string;
   /**
    * @remarks
-   * The region in which the bucket is located.
+   * The region of the destination OSS bucket.
    * 
    * @example
-   * cn-shanghai
+   * cn-hangzhou
    */
   region?: string;
   static names(): { [key: string]: string } {
@@ -387,7 +387,7 @@ export class CreateUserDeliveryTaskRequestOssDelivery extends $dara.Model {
 export class CreateUserDeliveryTaskRequestS3Delivery extends $dara.Model {
   /**
    * @remarks
-   * The access key ID of your Amazon S3 account.
+   * The access key ID for the S3 account.
    * 
    * @example
    * g0f46623ll0g0
@@ -395,7 +395,7 @@ export class CreateUserDeliveryTaskRequestS3Delivery extends $dara.Model {
   accessKey?: string;
   /**
    * @remarks
-   * The directory in the bucket.
+   * The bucket path.
    * 
    * @example
    * logriver-test/log
@@ -403,7 +403,7 @@ export class CreateUserDeliveryTaskRequestS3Delivery extends $dara.Model {
   bucketPath?: string;
   /**
    * @remarks
-   * The endpoint.
+   * The S3 endpoint.
    * 
    * @example
    * https://s3.oss-cn-hangzhou.aliyuncs.com
@@ -411,7 +411,7 @@ export class CreateUserDeliveryTaskRequestS3Delivery extends $dara.Model {
   endpoint?: string;
   /**
    * @remarks
-   * The prefix of the path in which you want to store logs.
+   * The object key prefix.
    * 
    * @example
    * logriver-test/log
@@ -419,7 +419,7 @@ export class CreateUserDeliveryTaskRequestS3Delivery extends $dara.Model {
   prefixPath?: string;
   /**
    * @remarks
-   * The region ID of the service.
+   * The destination region.
    * 
    * @example
    * cn-shanghai
@@ -427,7 +427,7 @@ export class CreateUserDeliveryTaskRequestS3Delivery extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * Specifies whether the service is compatible with Amazon S3.
+   * Specifies whether the destination is an S3-compatible service.
    * 
    * @example
    * true
@@ -435,7 +435,7 @@ export class CreateUserDeliveryTaskRequestS3Delivery extends $dara.Model {
   s3Cmpt?: boolean;
   /**
    * @remarks
-   * The secret access key of your Amazon S3 account.
+   * The secret access key for the S3 account.
    * 
    * @example
    * ***
@@ -483,7 +483,7 @@ export class CreateUserDeliveryTaskRequestS3Delivery extends $dara.Model {
 export class CreateUserDeliveryTaskRequestSlsDelivery extends $dara.Model {
   /**
    * @remarks
-   * The name of the SLS Logstore.
+   * The name of the destination logstore.
    * 
    * @example
    * accesslog-test
@@ -491,7 +491,7 @@ export class CreateUserDeliveryTaskRequestSlsDelivery extends $dara.Model {
   SLSLogStore?: string;
   /**
    * @remarks
-   * The name of the SLS project.
+   * The name of the destination project.
    * 
    * @example
    * dcdn-test20240417
@@ -499,7 +499,7 @@ export class CreateUserDeliveryTaskRequestSlsDelivery extends $dara.Model {
   SLSProject?: string;
   /**
    * @remarks
-   * The region in which the SLS project resides.
+   * The region of the destination project.
    * 
    * @example
    * cn-hangzhou
@@ -533,12 +533,15 @@ export class CreateUserDeliveryTaskRequestSlsDelivery extends $dara.Model {
 export class CreateUserDeliveryTaskRequest extends $dara.Model {
   /**
    * @remarks
-   * The log category. Valid values:
+   * The real-time log type. Valid values:
+   * 
+   * - **dcdn_log_access_l1** (default): access log.
+   * 
+   * - **dcdn_log_er**: edge function log.
+   * 
+   * - **dcdn_log_waf**: WAF log.
    * 
-   * *   dcdn_log_access_l1 (default): access logs.
-   * *   dcdn_log_er: Edge Routine logs.
-   * *   dcdn_log_waf: firewall logs.
-   * *   dcdn_log_ipa: TCP/UDP proxy logs.
+   * - **dcdn_log_ipa**: Layer-4 acceleration log.
    * 
    * This parameter is required.
    * 
@@ -550,8 +553,9 @@ export class CreateUserDeliveryTaskRequest extends $dara.Model {
    * @remarks
    * The data center. Valid values:
    * 
-   * *   cn: the Chinese mainland.
-   * *   sg: outside the Chinese mainland.
+   * - **cn**: Chinese mainland.
+   * 
+   * - **sg**: global (excluding the Chinese mainland).
    * 
    * @example
    * cn
@@ -559,14 +563,19 @@ export class CreateUserDeliveryTaskRequest extends $dara.Model {
   dataCenter?: string;
   /**
    * @remarks
-   * The destination of the delivery. Valid values:
+   * The log delivery destination. Valid values:
+   * 
+   * - **sls**: Log Service (SLS).
+   * 
+   * - **http**: an HTTP service.
+   * 
+   * - **aws3**: Amazon S3.
+   * 
+   * - **oss**: Object Storage Service (OSS).
+   * 
+   * - **kafka**: Kafka.
    * 
-   * 1.  sls: Alibaba Cloud SLS.
-   * 2.  http: HTTP server.
-   * 3.  aws3: Amazon S3.
-   * 4.  oss: Alibaba Cloud OSS.
-   * 5.  kafka: Kafka.
-   * 6.  aws3cmpt: S3-compatible storage service.
+   * - **aws3cmpt**: an S3-compatible service.
    * 
    * This parameter is required.
    * 
@@ -577,7 +586,7 @@ export class CreateUserDeliveryTaskRequest extends $dara.Model {
   details?: string;
   /**
    * @remarks
-   * The discard rate. Default value: 0.
+   * The log discard rate. Defaults to 0.
    * 
    * @example
    * 0
@@ -585,7 +594,7 @@ export class CreateUserDeliveryTaskRequest extends $dara.Model {
   discardRate?: number;
   /**
    * @remarks
-   * The log field. If you specify multiple fields, separate them with commas (,).
+   * The fields to be delivered. Separate multiple fields with a comma.
    * 
    * This parameter is required.
    * 
@@ -596,27 +605,27 @@ export class CreateUserDeliveryTaskRequest extends $dara.Model {
   filterVer?: string;
   /**
    * @remarks
-   * The configurations for delivery to an HTTP server.
+   * Configuration for delivering logs to an HTTP or HTTPS endpoint.
    */
   httpDelivery?: CreateUserDeliveryTaskRequestHttpDelivery;
   /**
    * @remarks
-   * The configurations for delivery to Kafka.
+   * Configuration for delivering logs to Kafka.
    */
   kafkaDelivery?: CreateUserDeliveryTaskRequestKafkaDelivery;
   /**
    * @remarks
-   * The configurations for delivery to OSS.
+   * Configuration for delivering logs to Object Storage Service (OSS).
    */
   ossDelivery?: CreateUserDeliveryTaskRequestOssDelivery;
   /**
    * @remarks
-   * The configurations for delivery to Amazon S3 or an S3-compatible service.
+   * Configuration for delivering logs to Amazon S3 or an S3-compatible service.
    */
   s3Delivery?: CreateUserDeliveryTaskRequestS3Delivery;
   /**
    * @remarks
-   * The configurations for delivery to SLS.
+   * Configuration for delivering logs to Log Service (SLS).
    */
   slsDelivery?: CreateUserDeliveryTaskRequestSlsDelivery;
   /**