@alicloud/esa20240910 3.2.0 → 3.4.0

package/src/models/ListHttpResponseHeaderModificationRulesResponseBody.ts

@@ -13,13 +13,10 @@ export class ListHttpResponseHeaderModificationRulesResponseBodyConfigsResponseH
   name?: string;
   /**
    * @remarks
-   * The modification operation. Valid values:
-   * 
-   * - `add`: Adds a header.
-   * 
-   * - `del`: Removes a header.
-   * 
-   * - `modify`: Modifies a header.
+   * The operation type. Valid values:
+   * - add: adds a response header.
+   * - del: deletes a response header.
+   * - modify: modifies a response header.
    * 
    * @example
    * add
@@ -28,10 +25,8 @@ export class ListHttpResponseHeaderModificationRulesResponseBodyConfigsResponseH
   /**
    * @remarks
    * The value type. Valid values:
-   * 
-   * - `static`: Static mode.
-   * 
-   * - `dynamic`: Dynamic mode.
+   * - static: static pattern.
+   * - dynamic: dynamic schema.
    * 
    * @example
    * static
@@ -83,11 +78,9 @@ export class ListHttpResponseHeaderModificationRulesResponseBodyConfigs extends
   configId?: number;
   /**
    * @remarks
-   * The type of configuration. Valid values:
-   * 
-   * - `global`: A global configuration.
-   * 
-   * - `rule`: A rule configuration.
+   * The configuration type. Valid values:
+   * - global: global configuration.
+   * - rule: rule configuration.
    * 
    * @example
    * rule
@@ -95,16 +88,14 @@ export class ListHttpResponseHeaderModificationRulesResponseBodyConfigs extends
   configType?: string;
   /**
    * @remarks
-   * The response header modifications. You can add, remove, or modify headers.
+   * The response header modifications. Three operations are supported: add, delete, and modify.
    */
   responseHeaderModification?: ListHttpResponseHeaderModificationRulesResponseBodyConfigsResponseHeaderModification[];
   /**
    * @remarks
-   * The conditional expression that matches user requests. This parameter is not required for a global configuration.
-   * 
-   * - To match all incoming requests, set the value to `true`.
-   * 
-   * - To match specific requests, set a custom expression. Example: `(http.host eq "video.example.com")`
+   * The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when you add a global configuration. Two scenarios are supported:
+   * - 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\\").
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -112,11 +103,9 @@ export class ListHttpResponseHeaderModificationRulesResponseBodyConfigs extends
   rule?: string;
   /**
    * @remarks
-   * Whether the rule is enabled. This parameter is not required for a global configuration. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * The rule switch. You do not need to set this parameter when you add a global configuration. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -124,7 +113,7 @@ export class ListHttpResponseHeaderModificationRulesResponseBodyConfigs extends
   ruleEnable?: string;
   /**
    * @remarks
-   * The name of the rule. This parameter is not required for a global configuration.
+   * The rule name. You do not need to set this parameter when you add a global configuration.
    * 
    * @example
    * rule_example
@@ -132,7 +121,7 @@ export class ListHttpResponseHeaderModificationRulesResponseBodyConfigs extends
   ruleName?: string;
   /**
    * @remarks
-   * The execution priority of the rule. Rules with smaller values have higher priority.
+   * The execution order of the rule. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -140,7 +129,7 @@ export class ListHttpResponseHeaderModificationRulesResponseBodyConfigs extends
   sequence?: number;
   /**
    * @remarks
-   * The version number of the site configuration. For sites with version management enabled, this specifies the version to which the configuration applies. The default is 0.
+   * The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 0
@@ -187,12 +176,12 @@ export class ListHttpResponseHeaderModificationRulesResponseBodyConfigs extends
 export class ListHttpResponseHeaderModificationRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of HTTP response header modification rules.
+   * The list of HTTP response header modifications.
    */
   configs?: ListHttpResponseHeaderModificationRulesResponseBodyConfigs[];
   /**
    * @remarks
-   * The page number.
+   * The current page number, which is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -200,7 +189,7 @@ export class ListHttpResponseHeaderModificationRulesResponseBody extends $dara.M
   pageNumber?: number;
   /**
    * @remarks
-   * The page size.
+   * The number of entries per page.
    * 
    * @example
    * 20

package/src/models/ListHttpsApplicationConfigurationsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListHttpsApplicationConfigurationsRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID.
+   * Configuration ID.
    * 
    * @example
    * 3528160969****
@@ -13,13 +13,11 @@ export class ListHttpsApplicationConfigurationsRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The configuration type. Use this parameter to query the global configuration or rule configurations. Valid values:
+   * Configuration type. You can use this parameter to query global configurations or rule configurations. Valid values:
+   * - global: Query global configurations.
+   * - rule: Query rule configurations.
    * 
-   * - global: Queries the global configuration.
-   * 
-   * - rule: Queries rule configurations.
-   * 
-   * If this parameter is omitted, the query returns both global and rule configurations.
+   * This parameter is optional. If not specified, no distinction is made between global and rule configurations.
    * 
    * @example
    * global
@@ -27,7 +25,7 @@ export class ListHttpsApplicationConfigurationsRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * The page number to return. If this parameter is omitted, the default value is 1.
+   * The page number for paginated queries. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -35,7 +33,7 @@ export class ListHttpsApplicationConfigurationsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return per page. The maximum value is 500. If this parameter is omitted, the default value is 500.
+   * The number of entries per page for paginated queries. Valid values: 1-500.
    * 
    * @example
    * 20
@@ -43,7 +41,7 @@ export class ListHttpsApplicationConfigurationsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The rule name. This parameter filters the results to include only the rule with the specified name.
+   * Rule name. You can query the rule whose name matches the specified value.
    * 
    * @example
    * rule_example
@@ -51,7 +49,7 @@ export class ListHttpsApplicationConfigurationsRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The site ID. You can obtain this ID by calling the [ListSites](~~ListSites~~) operation.
+   * Site ID. You can obtain it by calling the [ListSites](~~ListSites~~) API.
    * 
    * This parameter is required.
    * 
@@ -61,7 +59,7 @@ export class ListHttpsApplicationConfigurationsRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The site version. For sites with version management enabled, use this parameter to retrieve the configuration for a specific site version. The default value is 0.
+   * The version number of the site. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: version 0.
    * 
    * @example
    * 1

package/src/models/ListHttpsApplicationConfigurationsResponseBody.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
-   * Whether to enable the Alt-Svc feature. Default: `off`. Valid values:
-   * 
-   * - `on`: The Alt-Svc feature is enabled.
-   * 
-   * - `off`: The Alt-Svc feature is disabled.
+   * Alt-Svc feature switch. Disabled by default. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -17,11 +15,9 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   altSvc?: string;
   /**
    * @remarks
-   * Whether the Alt-Svc header includes the `clear` parameter. Default: `off`. Valid values:
-   * 
-   * - `on`: The `clear` parameter is included.
-   * 
-   * - `off`: The `clear` parameter is not included.
+   * Whether the Alt-Svc header includes the clear parameter. Disabled by default. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -29,7 +25,7 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   altSvcClear?: string;
   /**
    * @remarks
-   * The Alt-Svc max-age in seconds. Default: `86400`.
+   * Alt-Svc validity period in seconds. Default value: 86400 seconds.
    * 
    * @example
    * 86400
@@ -37,11 +33,9 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   altSvcMa?: string;
   /**
    * @remarks
-   * Whether the Alt-Svc header includes the `persist` parameter. Default: `off`. Valid values:
-   * 
-   * - `on`: The `persist` parameter is included.
-   * 
-   * - `off`: The `persist` parameter is not included.
+   * Whether the Alt-Svc header includes the persist parameter. Disabled by default. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -49,7 +43,7 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   altSvcPersist?: string;
   /**
    * @remarks
-   * The configuration ID.
+   * Configuration ID.
    * 
    * @example
    * 395386449776640
@@ -57,11 +51,10 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   configId?: number;
   /**
    * @remarks
-   * The type of the configuration. Valid values:
+   * Configuration type. You can use this parameter to query global configurations or rule configurations. Valid values:
    * 
-   * - `global`: A global configuration.
-   * 
-   * - `rule`: A rule-based configuration.
+   * - global: Query global configurations.
+   * - rule: Query rule configurations.
    * 
    * @example
    * global
@@ -69,11 +62,10 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   configType?: string;
   /**
    * @remarks
-   * Whether to enable HSTS. Default: `off`. Valid values:
-   * 
-   * - `on`: HSTS is enabled.
+   * Whether to enable HSTS. Disabled by default. Valid values:
    * 
-   * - `off`: HSTS is disabled.
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -81,11 +73,10 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   hsts?: string;
   /**
    * @remarks
-   * Whether the HSTS header includes the `includeSubDomains` directive. Default: `off`. Valid values:
-   * 
-   * - `on`: The `includeSubDomains` directive is included.
+   * Whether to include subdomains in HSTS. Disabled by default. Valid values:
    * 
-   * - `off`: The `includeSubDomains` directive is not included.
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -93,7 +84,7 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   hstsIncludeSubdomains?: string;
   /**
    * @remarks
-   * The HSTS `max-age`, in seconds.
+   * HSTS expiration time in seconds.
    * 
    * @example
    * 3600
@@ -101,11 +92,10 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   hstsMaxAge?: string;
   /**
    * @remarks
-   * Whether the HSTS header includes the `preload` directive. Default: `off`. Valid values:
+   * Whether to enable HSTS preload. Disabled by default. Valid values:
    * 
-   * - `on`: The `preload` directive is included.
-   * 
-   * - `off`: The `preload` directive is not included.
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -113,11 +103,11 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   hstsPreload?: string;
   /**
    * @remarks
-   * Whether to enable HTTPS redirection. Default: `off`. Valid values:
+   * Whether to enable forced HTTPS. Disabled by default. Valid values:
    * 
-   * - `on`: HTTPS redirection is enabled.
+   * - on: Enabled.
    * 
-   * - `off`: HTTPS redirection is disabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -125,15 +115,11 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   httpsForce?: string;
   /**
    * @remarks
-   * The status code for HTTPS redirection. Valid values:
-   * 
-   * - `301`
-   * 
-   * - `302`
-   * 
-   * - `307`
-   * 
-   * - `308`
+   * Forced HTTPS redirect status code. Valid values:
+   * - 301
+   * - 302
+   * - 307
+   * - 308
    * 
    * @example
    * 301
@@ -141,11 +127,9 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   httpsForceCode?: string;
   /**
    * @remarks
-   * Whether to reject TLS handshake requests that lack an SNI. Default: `off`. Valid values:
-   * 
-   * - `on`: Requests that lack an SNI are rejected.
-   * 
-   * - `off`: Requests that lack an SNI are not rejected.
+   * Whether to enable denial of TLS handshake requests without SNI. Disabled by default. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -153,11 +137,10 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   httpsNoSniDeny?: string;
   /**
    * @remarks
-   * Whether to enable SNI verification. Default: `off`. Valid values:
+   * Whether to enable SNI verification. Disabled by default. Valid values:
    * 
-   * - `on`: SNI verification is enabled.
-   * 
-   * - `off`: SNI verification is disabled.
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -165,7 +148,7 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   httpsSniVerify?: string;
   /**
    * @remarks
-   * The SNI allowlist. Separate multiple values with a space.
+   * Specifies the list of allowed SNI whitelist entries, separated by spaces.
    * 
    * @example
    * abc edf
@@ -173,11 +156,9 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   httpsSniWhitelist?: string;
   /**
    * @remarks
-   * The content of the rule, a conditional expression that matches user requests. This parameter is not required for a global configuration. The following use cases are supported:
-   * 
-   * - To match all incoming requests, set the value to `true`.
-   * 
-   * - To match specific requests, set the value to a custom expression, such as `(http.host eq "video.example.com")`.
+   * 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 specified requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -185,11 +166,9 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   rule?: string;
   /**
    * @remarks
-   * Whether the rule is enabled. This parameter is not required for a global configuration. Valid values:
-   * 
-   * - `on`: The rule is enabled.
-   * 
-   * - `off`: The rule is disabled.
+   * Rule switch. This parameter does not need to be set when adding a global configuration. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -197,7 +176,7 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   ruleEnable?: string;
   /**
    * @remarks
-   * The name of the rule. This parameter is not required for a global configuration.
+   * Rule name. This parameter does not need to be set when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -205,7 +184,7 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   ruleName?: string;
   /**
    * @remarks
-   * The execution priority of the rule. A smaller value indicates a higher priority.
+   * Rule execution order. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -213,7 +192,7 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
   sequence?: number;
   /**
    * @remarks
-   * The site configuration version. For sites with version management, this specifies the version to which the configuration applies. Default: `0`.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: version 0.
    * 
    * @example
    * 1
@@ -281,12 +260,12 @@ export class ListHttpsApplicationConfigurationsResponseBodyConfigs extends $dara
 export class ListHttpsApplicationConfigurationsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of HTTPS application configurations.
+   * Response body configurations.
    */
   configs?: ListHttpsApplicationConfigurationsResponseBodyConfigs[];
   /**
    * @remarks
-   * The current page number.
+   * Current page number, same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -294,7 +273,7 @@ export class ListHttpsApplicationConfigurationsResponseBody extends $dara.Model
   pageNumber?: number;
   /**
    * @remarks
-   * The page size.
+   * Page size.
    * 
    * @example
    * 10
@@ -302,7 +281,7 @@ export class ListHttpsApplicationConfigurationsResponseBody extends $dara.Model
   pageSize?: number;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9
@@ -310,7 +289,7 @@ export class ListHttpsApplicationConfigurationsResponseBody extends $dara.Model
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries.
+   * Total number of records.
    * 
    * @example
    * 16
@@ -318,7 +297,7 @@ export class ListHttpsApplicationConfigurationsResponseBody extends $dara.Model
   totalCount?: number;
   /**
    * @remarks
-   * The total number of pages.
+   * Total number of pages.
    * 
    * @example
    * 2

package/src/models/ListHttpsBasicConfigurationsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListHttpsBasicConfigurationsRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 35281609698****
@@ -13,13 +13,11 @@ export class ListHttpsBasicConfigurationsRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type, which can be used to query global or rule configurations. Value range:
+   * The configuration type. You can use this parameter to query global or rule configurations. Valid values:
+   * - global: queries global configurations.
+   * - rule: queries rule configurations.
    * 
-   * - global: Query global configuration.
-   * 
-   * - rule: Query rule configuration.
-   * 
-   * This parameter is optional. If not provided, it does not distinguish between global and rule configurations.
+   * This parameter is optional. If you do not specify this parameter, both global and rule configurations are returned.
    * 
    * @example
    * global
@@ -27,7 +25,7 @@ export class ListHttpsBasicConfigurationsRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Page number, default is 1 if not provided.
+   * The page number for a paged query. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -35,7 +33,7 @@ export class ListHttpsBasicConfigurationsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Number of items per page, maximum is 500, default is 500 if not provided.
+   * The number of entries per page for a paged query. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -43,7 +41,7 @@ export class ListHttpsBasicConfigurationsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Rule name, which can be used to find the rule with the specified name.
+   * The rule name. You can use this parameter to query the rule that matches the specified name.
    * 
    * @example
    * test
@@ -51,7 +49,7 @@ export class ListHttpsBasicConfigurationsRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    *