@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/SubmitUploadTaskResponseBody.ts

@@ -0,0 +1,44 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class SubmitUploadTaskResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The ID of the file upload task.
+   * 
+   * @example
+   * 1593805857882113
+   */
+  uploadId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      requestId: 'RequestId',
+      uploadId: 'UploadId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      requestId: 'string',
+      uploadId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/UpdateCacheRuleRequest.ts

@@ -5,18 +5,25 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCacheRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Enable caching on specified ports. Value range: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096.
+   * - Enables caching on the specified ports.
+   * 
+   * - Valid values: `8880`, `2052`, `2082`, `2086`, `2095`, `2053`, `2083`, `2087`, `2096`
+   * 
+   * - Separate multiple ports with commas.
    * 
    * @example
-   * 8880
+   * 8880,2052,2086
    */
   additionalCacheablePorts?: string;
   /**
    * @remarks
-   * Browser cache mode. Value range:
-   * - no_cache: Do not cache.
-   * - follow_origin: Follow origin cache policy.
-   * - override_origin: Override origin cache policy.
+   * The browser cache mode. Valid values:
+   * 
+   * - `no_cache`: Does not cache content in the browser.
+   * 
+   * - `follow_origin`: Follows the caching policy of the origin server.
+   * 
+   * - `override_origin`: Overrides the caching policy of the origin server.
    * 
    * @example
    * no_cache
@@ -24,7 +31,7 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   browserCacheMode?: string;
   /**
    * @remarks
-   * Browser cache expiration time, in seconds.
+   * The browser cache TTL (Time to Live), in seconds.
    * 
    * @example
    * 300
@@ -32,9 +39,11 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   browserCacheTtl?: string;
   /**
    * @remarks
-   * Set bypass cache mode. Value range:
-   * - cache_all: Cache all requests.
-   * - bypass_all: Bypass cache for all requests.
+   * The cache bypass mode. Valid values:
+   * 
+   * - `cache_all`: Caches all requests.
+   * 
+   * - `bypass_all`: Bypasses the cache for all requests.
    * 
    * @example
    * cache_all
@@ -42,9 +51,11 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   bypassCache?: string;
   /**
    * @remarks
-   * Cache deception defense. Used to defend against web cache deception attacks; only the cache content that passes the validation will be cached. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Defends against Web Cache Deception attacks by caching only validated content. Valid values:
+   * 
+   * - `on`: Enables the feature.
+   * 
+   * - `off`: Disables the feature.
    * 
    * @example
    * on
@@ -52,9 +63,11 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   cacheDeceptionArmor?: string;
   /**
    * @remarks
-   * Cache retention eligibility. Used to control whether user requests bypass the cache retention node when returning to the origin. Value range:
-   * - bypass_cache_reserve: Requests bypass cache retention.
-   * - eligible_for_cache_reserve: Eligible for cache retention.
+   * Controls whether requests bypass the cache reserve node during an origin-pull. Valid values:
+   * 
+   * - `bypass_cache_reserve`: The request bypasses the cache reserve.
+   * 
+   * - `eligible_for_cache_reserve`: The request is eligible for cache reserve.
    * 
    * @example
    * bypass_cache_reserve
@@ -62,23 +75,35 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   cacheReserveEligibility?: string;
   /**
    * @remarks
-   * Check if the cookie exists when generating cache keys, and if it does, add the cookie name (case-insensitive) to the cache key. Supports multiple cookie names, separated by spaces.
+   * The cookies to check for. If a specified cookie is present in the request, its name (case-insensitive) is added to the cache key. Separate multiple cookies with spaces. Cookie names can contain the following characters:
+   * 
+   * - Symbols: ! # $ % & \\" \\* + - . ^ _ | \\~
+   * 
+   * - Digits: 0-9
+   * 
+   * - Lowercase letters: a-z
    * 
    * @example
-   * cookiename
+   * cookiename1 cookiename2
    */
   checkPresenceCookie?: string;
   /**
    * @remarks
-   * Check if the header exists when generating cache keys, and if it does, add the header name (case-insensitive) to the cache key. Supports multiple header names, separated by spaces.
+   * The headers to check for. If a specified header is present in the request, its name (case-insensitive) is added to the cache key. Separate multiple headers with spaces. Header names can contain the following characters:
+   * 
+   * - Symbols: ! # $ % & \\" \\* + - . ^ _ | \\~
+   * 
+   * - Digits: 0-9
+   * 
+   * - Lowercase letters: a-z
    * 
    * @example
-   * headername
+   * headername1 headername2
    */
   checkPresenceHeader?: string;
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * This parameter is required.
    * 
@@ -88,11 +113,17 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Edge cache mode. Value range:
-   * - follow_origin: Follow origin cache policy (if exists), otherwise use the default cache policy.
-   * - no_cache: Do not cache.
-   * - override_origin: Override origin cache policy.
-   * - follow_origin_bypass: Follow origin cache policy (if exists), otherwise do not cache.
+   * The cache mode for the edge node. Valid values:
+   * 
+   * - `follow_origin`: Follows the origin server\\"s caching policy. If the origin server has no policy, the default policy is used.
+   * 
+   * - `no_cache`: Does not cache content.
+   * 
+   * - `override_origin`: Overrides the caching policy of the origin server.
+   * 
+   * - `follow_origin_bypass`: Follows the caching policy of the origin server, if one exists. Otherwise, content is not cached.
+   * 
+   * - `follow_origin_override`: Follows the caching policy of the origin server, if one exists. Otherwise, a custom cache TTL is used.
    * 
    * @example
    * follow_origin
@@ -100,7 +131,7 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   edgeCacheMode?: string;
   /**
    * @remarks
-   * Edge cache expiration time, in seconds.
+   * The edge node cache TTL (Time to Live), in seconds.
    * 
    * @example
    * 300
@@ -108,54 +139,93 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   edgeCacheTtl?: string;
   /**
    * @remarks
-   * Status code cache expiration time, in seconds.
+   * The cache TTL for specific status codes, in seconds.
+   * 
+   * - You can set the cache TTL for a specific status code. For example, `404=10` caches responses with a 404 status code for 10 seconds.
+   * 
+   * - You can set the cache TTL for `4xx` and `5xx` status code ranges. For example, `4xx=10` caches all responses with a `4xx` status code for 10 seconds.
+   * 
+   * - Separate multiple status code settings with commas.
    * 
    * @example
-   * 300
+   * 5xx=0,404=10
    */
   edgeStatusCodeCacheTtl?: string;
   /**
    * @remarks
-   * Include the specified cookie names and their values when generating cache keys, supporting multiple values separated by spaces.
+   * The cookies to include in the cache key. Both the cookie names (case-insensitive) and their values are used. Separate multiple cookies with spaces. Cookie names can contain the following characters:
+   * 
+   * - Symbols: ! # $ % & \\" \\* + - . ^ _ | \\~
+   * 
+   * - Digits: 0-9
+   * 
+   * - Lowercase letters: a-z
    * 
    * @example
-   * cookiename
+   * cookiename1 cookiename2
    */
   includeCookie?: string;
   /**
    * @remarks
-   * Include the specified header names and their values when generating cache keys, supporting multiple values separated by spaces.
+   * The headers to include in the cache key. Both the header names (case-insensitive) and their values are used. Separate multiple headers with spaces. Header names can contain the following characters:
+   * 
+   * - Symbols: ! # $ % & \\" \\* + - . ^ _ | \\~
+   * 
+   * - Digits: 0-9
+   * 
+   * - Lowercase letters: a-z
    * 
    * @example
-   * headername
+   * headername1 headername2
    */
   includeHeader?: string;
   /**
+   * @remarks
+   * Controls how the request body is used to generate the cache key for POST requests. Valid values:
+   * 
+   * - `md5`: Calculates the MD5 hash of the request body and includes the hash in the cache key.
+   * 
+   * - `ignore`: Ignores the request body when generating the cache key.
+   * 
    * @example
    * ignore
    */
   postBodyCacheKey?: string;
+  /**
+   * @remarks
+   * The maximum size of a request body for POST caching, in KB. The value must be an integer from 1 to 8. If you leave this parameter empty, the default value of 8 KB is used.
+   * 
+   * @example
+   * 1
+   */
   postBodySizeLimit?: string;
   /**
+   * @remarks
+   * Controls whether to cache responses to POST requests.
+   * 
    * @example
    * on
    */
   postCache?: string;
   /**
    * @remarks
-   * Query strings to be retained or excluded, supporting multiple values separated by spaces.
+   * The query string parameters to include in or exclude from the cache key. Separate multiple parameters with spaces.
    * 
    * @example
-   * example
+   * example1 example2
    */
   queryString?: string;
   /**
    * @remarks
-   * The processing mode of query strings when generating cache keys. Values:
-   * - ignore_all: Ignore all.
-   * - exclude_query_string: Exclude specified query strings.
-   * - reserve_all: Default, reserve all.
-   * - include_query_string: Include specified query strings.
+   * Controls how query strings are used to generate a cache key. Valid values:
+   * 
+   * - `ignore_all`: Ignores all query strings.
+   * 
+   * - `exclude_query_string`: Removes specified query strings.
+   * 
+   * - `reserve_all`: Retains all query strings. This is the default value.
+   * 
+   * - `include_query_string`: Retains only specified query strings.
    * 
    * @example
    * ignore_all
@@ -163,9 +233,11 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   queryStringMode?: string;
   /**
    * @remarks
-   * Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:
-   * - Match all incoming requests: Set the value to true
-   * - Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")
+   * A conditional expression that matches user requests. This parameter is optional for a global configuration. Two scenarios are supported:
+   * 
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, set the value to a custom expression, for example, `(http.host eq "video.example.com")`.
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -173,9 +245,11 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Controls whether the rule is enabled. This parameter is optional for a global configuration. Valid values:
+   * 
+   * - `on`: Enables the rule.
+   * 
+   * - `off`: Disables the rule.
    * 
    * @example
    * on
@@ -183,18 +257,27 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * The name of the rule. This parameter is optional for a global configuration.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The execution priority of the rule. A smaller value indicates a higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Serve stale cache. When enabled, the node can still use the expired cached files to respond to user requests even if the origin server is unavailable. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Controls whether to serve stale content. If enabled, an edge node can serve expired content from its cache if the origin server is unavailable. Valid values:
+   * 
+   * - `on`: Enables this feature.
+   * 
+   * - `off`: Disables this feature.
    * 
    * @example
    * on
@@ -202,7 +285,7 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   serveStale?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The ID of the site. To get this ID, call the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 
@@ -212,9 +295,11 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Query string sorting. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Controls whether to sort query string parameters when generating a cache key. Valid values:
+   * 
+   * - `on`: Enables sorting.
+   * 
+   * - `off`: Disables sorting.
    * 
    * @example
    * on
@@ -222,9 +307,11 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   sortQueryStringForCache?: string;
   /**
    * @remarks
-   * When generating cache keys, include the client device type. Value range: 
-   * - on: enabled. 
-   * - off: disabled.
+   * Controls whether to include the client device type in the cache key. Valid values:
+   * 
+   * - `on`: Enables this feature.
+   * 
+   * - `off`: Disables this feature.
    * 
    * @example
    * on
@@ -232,9 +319,11 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   userDeviceType?: string;
   /**
    * @remarks
-   * Include the client\\"s geographical location when generating the cache key. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Controls whether to include the client\\"s geographic location in the cache key. Valid values:
+   * 
+   * - `on`: Enables this feature.
+   * 
+   * - `off`: Disables this feature.
    * 
    * @example
    * on
@@ -242,9 +331,11 @@ export class UpdateCacheRuleRequest extends $dara.Model {
   userGeo?: string;
   /**
    * @remarks
-   * Include the client\\"s language type when generating the cache key. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Controls whether to include the client\\"s language in the cache key. Valid values:
+   * 
+   * - `on`: Enables this feature.
+   * 
+   * - `off`: Disables this feature.
    * 
    * @example
    * on

package/src/models/UpdateCacheRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCacheRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225

package/src/models/UpdateCacheTagRequest.ts

@@ -7,8 +7,9 @@ export class UpdateCacheTagRequest extends $dara.Model {
    * @remarks
    * Specifies whether to ignore case sensitivity. Valid values:
    * 
-   * *   on
-   * *   off
+   * - on
+   * 
+   * - off
    * 
    * @example
    * on

package/src/models/UpdateCompressionRuleRequest.ts

@@ -5,8 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCompressionRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Brotli compression. Value range:
+   * Brotli compression. Valid values:
+   * 
    * - on: Enable.
+   * 
    * - off: Disable.
    * 
    * @example
@@ -15,7 +17,7 @@ export class UpdateCompressionRuleRequest extends $dara.Model {
   brotli?: string;
   /**
    * @remarks
-   * Configuration ID. It can be obtained by calling the [ListCompressionRules](~~ListCompressionRules~~) interface.
+   * Configuration ID. Get this value by calling the [ListCompressionRules](~~ListCompressionRules~~) API.
    * 
    * This parameter is required.
    * 
@@ -25,8 +27,10 @@ export class UpdateCompressionRuleRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Gzip compression. Value range:
+   * Gzip compression. Valid values:
+   * 
    * - on: Enable.
+   * 
    * - off: Disable.
    * 
    * @example
@@ -35,9 +39,11 @@ export class UpdateCompressionRuleRequest extends $dara.Model {
   gzip?: string;
   /**
    * @remarks
-   * Rule content, using conditional expressions to match user requests. This parameter is not required when adding a global configuration. There are two usage scenarios:
-   * - To match all incoming requests: Set the value to true
-   * - To match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")
+   * Rule content, using a conditional expression to match user requests. Do not set this parameter when adding a global configuration. Two scenarios apply:
+   * 
+   * - Match all incoming requests: Set the value to true.
+   * 
+   * - Match specific requests: Set the value to a custom expression, such as: (http.host eq "video.example.com")
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -45,8 +51,10 @@ export class UpdateCompressionRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Value range:
+   * Rule switch. Do not set this parameter when adding a global configuration. Valid values:
+   * 
    * - on: Enable.
+   * 
    * - off: Disable.
    * 
    * @example
@@ -55,16 +63,23 @@ export class UpdateCompressionRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * Rule name. Do not set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * Rule execution order. Rules with smaller values take precedence.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * Site ID. Get this value by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
    * 
    * This parameter is required.
    * 
@@ -74,8 +89,10 @@ export class UpdateCompressionRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Zstd compression. Value range:
+   * Zstd compression. Valid values:
+   * 
    * - on: Enable.
+   * 
    * - off: Disable.
    * 
    * @example

package/src/models/UpdateCustomHostnameRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCustomHostnameRequest extends $dara.Model {
   /**
    * @remarks
-   * 云盾证书ID，使用云盾证书时必填
+   * The ID of the Alibaba Cloud Security certificate. This parameter is required when CertType is set to cas.
    * 
    * @example
    * 30000478
@@ -13,7 +13,11 @@ export class UpdateCustomHostnameRequest extends $dara.Model {
   casId?: number;
   /**
    * @remarks
-   * 云盾证书所在地域，使用云盾证书时必填
+   * The region of the Alibaba Cloud Security certificate. This parameter is required when CertType is set to cas.
+   * 
+   * - cn-hangzhou: The value for accounts on the Alibaba Cloud China Website (www\\.aliyun.com).
+   * 
+   * - ap-southeast-1: The value for accounts on the Alibaba Cloud International Website (www\\.alibabacloud.com).
    * 
    * @example
    * cn-hangzhou
@@ -21,7 +25,13 @@ export class UpdateCustomHostnameRequest extends $dara.Model {
   casRegion?: string;
   /**
    * @remarks
-   * 证书类型，SSL 开启时必填
+   * The certificate type. This parameter is required when SslFlag is set to on.
+   * 
+   * - **free**: Free certificate.
+   * 
+   * - **upload**: Uploaded certificate.
+   * 
+   * - **cas**: Alibaba Cloud Security certificate.
    * 
    * @example
    * cas
@@ -29,7 +39,7 @@ export class UpdateCustomHostnameRequest extends $dara.Model {
   certType?: string;
   /**
    * @remarks
-   * 证书公钥，使用上传证书时必填
+   * The content of the certificate. This parameter is required when CertType is set to upload.
    * 
    * @example
    * -----BEGIN CERTIFICATE-----
@@ -37,6 +47,8 @@ export class UpdateCustomHostnameRequest extends $dara.Model {
   certificate?: string;
   /**
    * @remarks
+   * The ID of the SaaS domain name. You can obtain the ID by calling the [ListCustomHostnames](https://help.aliyun.com/document_detail/3018667.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -45,7 +57,7 @@ export class UpdateCustomHostnameRequest extends $dara.Model {
   hostnameId?: number;
   /**
    * @remarks
-   * 证书私钥，使用上传证书时必填
+   * The private key of the certificate. This parameter is required when CertType is set to upload.
    * 
    * @example
    * -----BEGIN PRIVATE KEY-----
@@ -53,7 +65,7 @@ export class UpdateCustomHostnameRequest extends $dara.Model {
   privateKey?: string;
   /**
    * @remarks
-   * 绑定的源站记录ID
+   * The ID of the record to attach. You can obtain the ID by calling the [ListRecords](https://help.aliyun.com/document_detail/2850265.html) operation.
    * 
    * @example
    * 1234567890123
@@ -61,7 +73,11 @@ export class UpdateCustomHostnameRequest extends $dara.Model {
   recordId?: number;
   /**
    * @remarks
-   * SSL开关
+   * The SSL switch.
+   * 
+   * - **on**: Enables SSL.
+   * 
+   * - **off**: Disables SSL.
    * 
    * @example
    * on

package/src/models/UpdateCustomHostnameResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateCustomHostnameResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9
    */