@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/GetAutomaticFrequencyControlConfigResponseBody.ts

@@ -4,41 +4,81 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAutomaticFrequencyControlConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The action to perform. Valid values:
+   * 
+   * - **observe**: Monitors requests.
+   * 
+   * - **deny**: Denies requests.
+   * 
+   * - **js**: Issues a JavaScript challenge.
+   * 
    * @example
    * js
    */
   actionType?: string;
   /**
+   * @remarks
+   * Indicates whether automatic frequency control is enabled. Valid values:
+   * 
+   * - **on**: Enabled.
+   * 
+   * - **off**: Disabled.
+   * 
    * @example
    * on
    */
   enable?: string;
   /**
+   * @remarks
+   * The statistics collection interval.
+   * 
    * @example
    * 10
    */
   interval?: number;
   /**
+   * @remarks
+   * The protection level. Valid values:
+   * 
+   * - **loose**: Loose.
+   * 
+   * - **normal**: Normal.
+   * 
+   * - **strict**: Strict.
+   * 
    * @example
    * normal
    */
   level?: string;
   /**
+   * @remarks
+   * The duration of the penalty, in seconds.
+   * 
    * @example
    * 20000000
    */
   punishTime?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
   /**
+   * @remarks
+   * The rule ID.
+   * 
    * @example
    * 11957665
    */
   ruleId?: number;
   /**
+   * @remarks
+   * The threshold that triggers the action.
+   * 
    * @example
    * 100
    */

package/src/models/GetCacheRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetCacheRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * ConfigId of the configuration, which can be obtained by calling the [ListCacheRules](https://help.aliyun.com/document_detail/2866985.html) interface.
+   * The configuration ID. Call the [ListCacheRules](https://help.aliyun.com/document_detail/2866985.html) operation to obtain this ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetCacheRuleRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The site ID. Call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain this ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetCacheRuleResponseBody.ts

@@ -5,18 +5,25 @@ import * as $dara from '@darabonba/typescript';
 export class GetCacheRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Enable caching on the specified ports. Value range: 8880, 2052, 2082, 2086, 2095, 2053, 2083, 2087, 2096.
+   * - Additional ports on which caching is enabled.
+   * 
+   * - Valid values: `8880`, `2052`, `2082`, `2086`, `2095`, `2053`, `2083`, `2087`, `2096`.
+   * 
+   * - Separate multiple ports with commas.
    * 
    * @example
-   * 2095
+   * 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.
+   * 
+   * - `follow_origin`: Follows the origin cache policy.
+   * 
+   * - `override_origin`: Overrides the origin cache policy.
    * 
    * @example
    * follow_origin
@@ -24,7 +31,7 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   browserCacheMode?: string;
   /**
    * @remarks
-   * Browser cache expiration time, in seconds.
+   * The browser cache TTL, in seconds.
    * 
    * @example
    * 300
@@ -32,10 +39,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   browserCacheTtl?: string;
   /**
    * @remarks
-   * Set bypass cache mode. Value range:
+   * Specifies whether to cache requests or bypass the cache. Valid values:
+   * 
+   * - `cache_all`: Caches all requests.
    * 
-   * - cache_all: Cache all requests.
-   * - bypass_all: Bypass cache for all requests.
+   * - `bypass_all`: Bypasses the cache for all requests.
    * 
    * @example
    * cache_all
@@ -43,10 +51,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   bypassCache?: string;
   /**
    * @remarks
-   * Cache deception defense. Used to defend against web cache deception attacks. Only the verified cache content will be cached. Value range:
+   * Specifies whether to enable Cache Deception Armor. This feature helps mitigate web cache deception attacks by ensuring that only validated content is cached. Valid values:
    * 
-   * - on: Enabled.
-   * - off: Disabled.
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -54,10 +63,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   cacheDeceptionArmor?: string;
   /**
    * @remarks
-   * Cache reserve eligibility. Used to control whether user requests bypass the cache reserve node when returning to the origin. Value range:
+   * The eligibility for cache reserve. This controls whether a request bypasses the cache reserve node during an origin fetch. Valid values:
+   * 
+   * - `bypass_cache_reserve`: The request bypasses the cache reserve.
    * 
-   * - bypass_cache_reserve: Requests bypass the cache reserve.
-   * - eligible_for_cache_reserve: Eligible for cache reserve.
+   * - `eligible_for_cache_reserve`: The request is eligible for cache reserve.
    * 
    * @example
    * bypass_cache_reserve
@@ -65,23 +75,35 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   cacheReserveEligibility?: string;
   /**
    * @remarks
-   * When generating the cache key, check if the cookie exists. If it does, add the cookie name (cookie names are case-insensitive) to the cache key. Supports multiple cookie names, separated by spaces.
+   * Specifies cookies whose presence is checked when generating a cache key. If a specified cookie exists in the request, its name (case-insensitive) is added to the cache key. Separate multiple cookie names with spaces. Cookie names can contain the following characters:
+   * 
+   * - Symbols: ! # $ % & \\" \\* + - . ^ _ | \\~
+   * 
+   * - Digits: 0-9
+   * 
+   * - Letters: lowercase English letters a-z
    * 
    * @example
-   * cookiename
+   * cookiename1 cookiename2
    */
   checkPresenceCookie?: string;
   /**
    * @remarks
-   * When generating the cache key, check if the header exists. If it does, add the header name (header names are case-insensitive) to the cache key. Supports multiple header names, separated by spaces.
+   * Specifies headers whose presence is checked when generating a cache key. If a specified header exists in the request, its name (case-insensitive) is added to the cache key. Separate multiple header names with spaces. Header names can contain the following characters:
+   * 
+   * - Symbols: ! # $ % & \\" \\* + - . ^ _ | \\~
+   * 
+   * - Digits: 0-9
+   * 
+   * - Letters: lowercase English letters a-z
    * 
    * @example
-   * headername
+   * headername1 headername2
    */
   checkPresenceHeader?: string;
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 352816096987136
@@ -89,9 +111,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type, which can be used to query global or rule configurations. Value range:
-   * - global: Query global configuration;
-   * - rule: Query rule configuration;
+   * Indicates whether the response contains a global or a rule configuration. Valid values:
+   * 
+   * - `global`: A global configuration.
+   * 
+   * - `rule`: A rule configuration.
    * 
    * @example
    * global
@@ -99,11 +123,17 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   configType?: string;
   /**
    * @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 edge cache mode. Valid values:
+   * 
+   * - `follow_origin`: Uses the origin server\\"s cache policy. If none is provided, the default policy applies.
+   * 
+   * - `no_cache`: Does not cache content.
+   * 
+   * - `override_origin`: Overrides the origin cache policy.
+   * 
+   * - `follow_origin_bypass`: Uses the origin server\\"s cache policy. If none is provided, content is not cached.
+   * 
+   * - `follow_origin_override`: Uses the origin server\\"s cache policy. If none is provided, a custom cache TTL applies.
    * 
    * @example
    * follow_origin
@@ -111,7 +141,7 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   edgeCacheMode?: string;
   /**
    * @remarks
-   * Edge cache expiration time, in seconds.
+   * The edge cache TTL, in seconds.
    * 
    * @example
    * 300
@@ -119,42 +149,77 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   edgeCacheTtl?: string;
   /**
    * @remarks
-   * Status code cache expiration time, in seconds.
+   * The status code cache TTL, in seconds.
+   * 
+   * - Set the cache TTL for a specific status code. For example, `404=10` specifies that responses with a 404 status code are cached for 10 seconds.
+   * 
+   * - Set the cache TTL for status code classes, such as 4xx and 5xx. For example, `4xx=10` specifies that all responses with a 4xx status code are cached for 10 seconds.
+   * 
+   * - Separate multiple entries with commas.
    * 
    * @example
-   * 300
+   * 5xx=0,404=10
    */
   edgeStatusCodeCacheTtl?: string;
   /**
    * @remarks
-   * When generating the cache key, include the specified cookie names and their values. Supports multiple values, separated by spaces.
+   * Specifies the cookies to include in the cache key. Both the cookie names (case-insensitive) and their values are added to the key. Separate multiple cookie names with spaces. Cookie names can contain the following characters:
+   * 
+   * - Symbols: ! # $ % & \\" \\* + - . ^ _ | \\~
+   * 
+   * - Digits: 0-9
+   * 
+   * - Letters: lowercase English letters a-z
    * 
    * @example
-   * cookie_exapmle
+   * cookiename1 cookiename2
    */
   includeCookie?: string;
   /**
    * @remarks
-   * When generating the cache key, include the specified header names and their values. Supports multiple values, separated by spaces.
+   * Specifies the headers to include in the cache key. Both the header names (case-insensitive) and their values are added to the key. Separate multiple header names with spaces. Header names can contain the following characters:
+   * 
+   * - Symbols: ! # $ % & \\" \\* + - . ^ _ | \\~
+   * 
+   * - Digits: 0-9
+   * 
+   * - Letters: lowercase English letters a-z
    * 
    * @example
-   * example
+   * headername1 headername2
    */
   includeHeader?: string;
   /**
+   * @remarks
+   * The mode for handling the body content when generating a cache key for POST requests. Valid values:
+   * 
+   * - `md5`: Calculates the MD5 hash of the body content and adds the hash to the cache key.
+   * 
+   * - `ignore`: Ignores the body content in the cache key.
+   * 
    * @example
    * ignore
    */
   postBodyCacheKey?: string;
+  /**
+   * @remarks
+   * The size limit (in KB) of the body content for POST caching. The value is an integer from 1 to 8. A null or empty value defaults to 8 KB.
+   * 
+   * @example
+   * 1
+   */
   postBodySizeLimit?: string;
   /**
+   * @remarks
+   * Specifies whether to enable the POST cache feature.
+   * 
    * @example
    * on
    */
   postCache?: string;
   /**
    * @remarks
-   * The query strings to be retained or deleted, supporting multiple values separated by spaces.
+   * Specifies the query strings to include in or exclude from the cache key. Separate multiple query strings with spaces.
    * 
    * @example
    * example
@@ -162,12 +227,15 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   queryString?: string;
   /**
    * @remarks
-   * The processing mode for query strings when generating cache keys. Value range:
+   * The mode for handling query strings when generating a cache key. Valid values:
+   * 
+   * - `ignore_all`: Ignores all query strings.
+   * 
+   * - `exclude_query_string`: Excludes specified query strings.
+   * 
+   * - `reserve_all`: Retains all query strings. This is the default value.
    * 
-   * - ignore_all: Ignore all.
-   * - exclude_query_string: Exclude specified query strings.
-   * - reserve_all: Default, reserve all.
-   * - include_query_string: Include specified query strings.
+   * - `include_query_string`: Includes specified query strings.
    * 
    * @example
    * reserve_all
@@ -175,7 +243,7 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   queryStringMode?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225
@@ -183,9 +251,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Rule content, using conditional expressions to match user requests. This parameter does not need to be set 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\\")
+   * The rule content, which is a conditional expression used to match user requests. This parameter applies only to rule configurations.
+   * 
+   * - To match all incoming requests, use `true`.
+   * 
+   * - To match specific requests, use a custom expression, such as `(http.host eq "video.example.com")`.
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -193,9 +263,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter does not need to be set when adding a global configuration. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether the rule is enabled. This parameter applies only to rule configurations. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -203,7 +275,7 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter does not need to be set when adding a global configuration.
+   * The name of the rule. This parameter applies only to rule configurations.
    * 
    * @example
    * rule_example
@@ -211,7 +283,7 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Rule execution order. The smaller the value, the higher the priority.
+   * The rule execution order. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -219,10 +291,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * Serve stale cache. When enabled, the node can still use the cached expired files to respond to user requests even if the origin server is unavailable. Value range:
+   * Specifies whether to serve stale content. If enabled, edge nodes serve stale (expired) content from the cache when the origin server is unavailable. Valid values:
+   * 
+   * - `on`: Enabled.
    * 
-   * - on: Enabled.
-   * - off: Disabled.
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -230,7 +303,7 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   serveStale?: string;
   /**
    * @remarks
-   * Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the configuration, defaulting to version 0.
+   * The version number of the site configuration. For sites with version management enabled, this indicates the configuration version. The default is 0.
    * 
    * @example
    * 1
@@ -238,9 +311,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * Query string sorting. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to sort query strings before generating the cache key. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -248,10 +323,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   sortQueryStringForCache?: string;
   /**
    * @remarks
-   * When generating the cache key, include the client device type. Value range:
+   * Specifies whether to include the client\\"s device type in the cache key. Valid values:
    * 
-   * - on: Enabled.
-   * - off: Disabled.
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -259,10 +335,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   userDeviceType?: string;
   /**
    * @remarks
-   * When generating the cache key, include the client\\"s geographic location. Value range:
+   * Specifies whether to include the client\\"s geographic location in the cache key. Valid values:
+   * 
+   * - `on`: Enabled.
    * 
-   * - on: Enabled.
-   * - off: Disabled.
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -270,10 +347,11 @@ export class GetCacheRuleResponseBody extends $dara.Model {
   userGeo?: string;
   /**
    * @remarks
-   * When generating the cache key, include the client\\"s language type. Value range:
+   * Specifies whether to include the client\\"s language in the cache key. Valid values:
+   * 
+   * - `on`: Enabled.
    * 
-   * - on: Enabled.
-   * - off: Disabled.
+   * - `off`: Disabled.
    * 
    * @example
    * on

package/src/models/GetCertificateQuotaRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetCertificateQuotaRequest extends $dara.Model {
   /**
    * @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 this ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetCertificateQuotaRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Certificate Quota type.
+   * The certificate quota type.
    * 
    * This parameter is required.
    * 

package/src/models/GetCertificateQuotaResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetCertificateQuotaResponseBodySiteUsage extends $dara.Model {
   /**
    * @remarks
-   * Site ID.
+   * The site ID.
    * 
    * @example
    * 165929521496928
@@ -13,7 +13,7 @@ export class GetCertificateQuotaResponseBodySiteUsage extends $dara.Model {
   siteId?: string;
   /**
    * @remarks
-   * Site name.
+   * The site name.
    * 
    * @example
    * example.com
@@ -21,7 +21,7 @@ export class GetCertificateQuotaResponseBodySiteUsage extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * Site usage.
+   * The number of certificates used by the site.
    * 
    * @example
    * 5
@@ -55,7 +55,7 @@ export class GetCertificateQuotaResponseBodySiteUsage extends $dara.Model {
 export class GetCertificateQuotaResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Free certificate quota.
+   * The free certificate quota.
    * 
    * @example
    * 10
@@ -63,7 +63,7 @@ export class GetCertificateQuotaResponseBody extends $dara.Model {
   quota?: number;
   /**
    * @remarks
-   * Usage of free certificate quota.
+   * The number of used free certificates.
    * 
    * @example
    * 5
@@ -71,7 +71,7 @@ export class GetCertificateQuotaResponseBody extends $dara.Model {
   quotaUsage?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9
@@ -79,7 +79,7 @@ export class GetCertificateQuotaResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Number of sites.
+   * The site count.
    * 
    * @example
    * 2
@@ -87,12 +87,12 @@ export class GetCertificateQuotaResponseBody extends $dara.Model {
   siteCount?: number;
   /**
    * @remarks
-   * List of site usage details.
+   * Details about the certificate usage for each site.
    */
   siteUsage?: GetCertificateQuotaResponseBodySiteUsage[];
   /**
    * @remarks
-   * Certificate Quota type.
+   * The certificate quota type.
    * 
    * @example
    * free

package/src/models/GetCertificateRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetCertificateRequest extends $dara.Model {
   /**
    * @remarks
-   * Certificate ID.
+   * The certificate ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetCertificateRequest extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID. You can get this ID by calling the [ListSites](~~ListSites~~) interface.
    * 
    * This parameter is required.
    *