@alicloud/esa20240910 3.1.2 → 3.3.0

package/src/models/UpdateHttpResponseHeaderModificationRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpResponseHeaderModificationRuleRequestResponseHeaderModification extends $dara.Model {
   /**
    * @remarks
-   * Response header name.
+   * The name of the Response Header to modify.
    * 
    * This parameter is required.
    * 
@@ -15,10 +15,13 @@ export class UpdateHttpResponseHeaderModificationRuleRequestResponseHeaderModifi
   name?: string;
   /**
    * @remarks
-   * Operation method. Value range:
-   * - add: Add.
-   * - del: Delete
-   * - modify: Modify.
+   * The operation to perform on the Response Header. Valid values:
+   * 
+   * - `add`: Adds the specified Response Header.
+   * 
+   * - `del`: Deletes the specified Response Header.
+   * 
+   * - `modify`: Modifies the specified Response Header.
    * 
    * This parameter is required.
    * 
@@ -26,10 +29,21 @@ export class UpdateHttpResponseHeaderModificationRuleRequestResponseHeaderModifi
    * add
    */
   operation?: string;
+  /**
+   * @remarks
+   * The mode for assigning the header `Value`. Valid values:
+   * 
+   * - `static`: Static mode. The `Value` is a fixed string.
+   * 
+   * - `dynamic`: Dynamic mode. The `Value` is generated dynamically.
+   * 
+   * @example
+   * static
+   */
   type?: string;
   /**
    * @remarks
-   * Response header value.
+   * The new or modified Value for the Response Header. This parameter is required when the `Operation` is `add` or `modify`.
    * 
    * @example
    * headerValue
@@ -65,7 +79,7 @@ export class UpdateHttpResponseHeaderModificationRuleRequestResponseHeaderModifi
 export class UpdateHttpResponseHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID. It can be obtained by calling the [ListHttpResponseHeaderModificationRules](https://help.aliyun.com/document_detail/2867483.html) interface.
+   * The ID of the Configuration. You can get this value by calling the [ListHttpResponseHeaderModificationRules](https://help.aliyun.com/document_detail/2867483.html) API.
    * 
    * This parameter is required.
    * 
@@ -75,14 +89,16 @@ export class UpdateHttpResponseHeaderModificationRuleRequest extends $dara.Model
   configId?: number;
   /**
    * @remarks
-   * Modify response headers, supporting three operation methods: add, delete, and modify.
+   * A list of objects, each defining a modification to a Response Header. Supported operations are `add`, `del`, and `modify`.
    */
   responseHeaderModification?: UpdateHttpResponseHeaderModificationRuleRequestResponseHeaderModification[];
   /**
    * @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\\")
+   * The matching condition for the Rule, written as a Conditional Expression. This parameter is optional for global Configurations. Use cases:
+   * 
+   * - 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")`.
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -90,9 +106,11 @@ export class UpdateHttpResponseHeaderModificationRuleRequest extends $dara.Model
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies 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
@@ -100,16 +118,23 @@ export class UpdateHttpResponseHeaderModificationRuleRequest 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 order for the Rule. A lower value indicates a higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The ID of the Site. You can get this value by calling the [ListSites](~~ListSites~~) API.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateHttpResponseHeaderModificationRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpResponseHeaderModificationRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * A unique identifier for the request.
    * 
    * @example
    * CB1A380B-09F0-41BB-280B-72F8FD6DA2FE

package/src/models/UpdateHttpResponseHeaderModificationRuleShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpResponseHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID. It can be obtained by calling the [ListHttpResponseHeaderModificationRules](https://help.aliyun.com/document_detail/2867483.html) interface.
+   * The ID of the Configuration. You can get this value by calling the [ListHttpResponseHeaderModificationRules](https://help.aliyun.com/document_detail/2867483.html) API.
    * 
    * This parameter is required.
    * 
@@ -15,14 +15,16 @@ export class UpdateHttpResponseHeaderModificationRuleShrinkRequest extends $dara
   configId?: number;
   /**
    * @remarks
-   * Modify response headers, supporting three operation methods: add, delete, and modify.
+   * A list of objects, each defining a modification to a Response Header. Supported operations are `add`, `del`, and `modify`.
    */
   responseHeaderModificationShrink?: 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\\")
+   * The matching condition for the Rule, written as a Conditional Expression. This parameter is optional for global Configurations. Use cases:
+   * 
+   * - 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")`.
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -30,9 +32,11 @@ export class UpdateHttpResponseHeaderModificationRuleShrinkRequest extends $dara
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies 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
@@ -40,16 +44,23 @@ export class UpdateHttpResponseHeaderModificationRuleShrinkRequest extends $dara
   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 order for the Rule. A lower value indicates a higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The ID of the Site. You can get this value by calling the [ListSites](~~ListSites~~) API.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateHttpsApplicationConfigurationRequest.ts

@@ -5,9 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   /**
    * @remarks
-   * Feature switch, default is disabled. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Specifies whether to enable the `Alt-Svc` header. This feature is disabled by default. Valid values:
+   * 
+   * - `on`: Enables the Alt-Svc header.
+   * 
+   * - `off`: Disables the Alt-Svc header.
    * 
    * @example
    * on
@@ -15,9 +17,11 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   altSvc?: string;
   /**
    * @remarks
-   * Whether the Alt-Svc header includes the clear parameter, default is disabled. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Specifies whether to include the `clear` directive in the `Alt-Svc` header. The directive is not included by default. Valid values:
+   * 
+   * - `on`: Includes the directive.
+   * 
+   * - `off`: Does not include the directive.
    * 
    * @example
    * on
@@ -25,7 +29,7 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   altSvcClear?: string;
   /**
    * @remarks
-   * Alt-Svc validity period, in seconds, default is 86400 seconds.
+   * The max-age for the Alt-Svc header, in seconds. The default is 86400.
    * 
    * @example
    * 86400
@@ -33,9 +37,11 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   altSvcMa?: string;
   /**
    * @remarks
-   * Whether the Alt-Svc header includes the persist parameter, default is disabled. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Specifies whether to include the `persist` directive in the `Alt-Svc` header. The directive is not included by default. Valid values:
+   * 
+   * - `on`: Includes the directive.
+   * 
+   * - `off`: Does not include the directive.
    * 
    * @example
    * on
@@ -43,7 +49,7 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   altSvcPersist?: string;
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * This parameter is required.
    * 
@@ -53,9 +59,11 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Whether to enable HSTS, default is disabled. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Specifies whether to enable HTTP Strict Transport Security (HSTS). This feature is disabled by default. Valid values:
+   * 
+   * - `on`: Enables HSTS.
+   * 
+   * - `off`: Disables HSTS.
    * 
    * @example
    * on
@@ -63,9 +71,11 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   hsts?: string;
   /**
    * @remarks
-   * Whether to include subdomains in HSTS, default is disabled. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Specifies whether to include subdomains in the HSTS policy. Subdomains are not included by default. Valid values:
+   * 
+   * - `on`: Includes subdomains.
+   * 
+   * - `off`: Does not include subdomains.
    * 
    * @example
    * on
@@ -73,7 +83,7 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   hstsIncludeSubdomains?: string;
   /**
    * @remarks
-   * HSTS expiration time, in seconds.
+   * The HSTS max-age in seconds.
    * 
    * @example
    * 3600
@@ -81,9 +91,11 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   hstsMaxAge?: string;
   /**
    * @remarks
-   * Whether to enable HSTS preload, default is disabled. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Specifies whether to enable HSTS Preload. HSTS Preload is disabled by default. Valid values:
+   * 
+   * - `on`: Enables Preload.
+   * 
+   * - `off`: Disables Preload.
    * 
    * @example
    * on
@@ -91,9 +103,11 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   hstsPreload?: string;
   /**
    * @remarks
-   * Whether to enable forced HTTPS, default is disabled. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Specifies whether to enable Force HTTPS. This feature is disabled by default. Valid values:
+   * 
+   * - `on`: Enables Force HTTPS.
+   * 
+   * - `off`: Disables Force HTTPS.
    * 
    * @example
    * on
@@ -101,24 +115,59 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   httpsForce?: string;
   /**
    * @remarks
-   * Forced HTTPS redirect status code, value range:
-   * - 301
-   * - 302
-   * - 307
-   * - 308
+   * The redirect status code for Force HTTPS. Valid values:
+   * 
+   * - `301`
+   * 
+   * - `302`
+   * 
+   * - `307`
+   * 
+   * - `308`
    * 
    * @example
    * 301
    */
   httpsForceCode?: string;
+  /**
+   * @remarks
+   * Specifies whether to deny TLS handshake requests that do not include an SNI. This feature is disabled by default. Valid values:
+   * 
+   * - `on`: Denies requests without an SNI.
+   * 
+   * - `off`: Allows requests without an SNI.
+   * 
+   * @example
+   * on
+   */
   httpsNoSniDeny?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable Server Name Indication (SNI) verification. This feature is disabled by default. Valid values:
+   * 
+   * - `on`: Enables SNI verification.
+   * 
+   * - `off`: Disables SNI verification.
+   * 
+   * @example
+   * on
+   */
   httpsSniVerify?: string;
+  /**
+   * @remarks
+   * The SNI allowlist. Separate multiple hostnames with spaces.
+   * 
+   * @example
+   * abc edf
+   */
   httpsSniWhitelist?: 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\\")
+   * The conditional expression that the rule uses to match requests. This parameter is not required for a global configuration.
+   * 
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, provide a custom expression, such as `(http.host eq "video.example.com")`
    * 
    * @example
    * (http.host eq \\"video.example.com\\")
@@ -126,9 +175,11 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
+   * Specifies whether to enable the rule. This parameter is not required for a global configuration. Valid values:
+   * 
+   * - `on`: Enables the rule.
+   * 
+   * - `off`: Disables the rule.
    * 
    * @example
    * on
@@ -136,16 +187,23 @@ export class UpdateHttpsApplicationConfigurationRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * The rule name. This parameter is not required for a global configuration.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The execution order of the rule. A lower value indicates a higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * The site ID. To obtain this ID, call the [ListSites](~~ListSites~~) API.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateHttpsApplicationConfigurationResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpsApplicationConfigurationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 35C66C7B-671H-4297-9187-2C4477247A78

package/src/models/UpdateHttpsBasicConfigurationRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   /**
    * @remarks
-   * Custom cipher suite, indicating the specific encryption algorithm selected when CiphersuiteGroup is set to custom.
+   * The custom cipher suite to use when `CiphersuiteGroup` is set to `custom`.
    * 
    * @example
    * TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
@@ -13,10 +13,13 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   ciphersuite?: string;
   /**
    * @remarks
-   * Cipher suite group. Default is all cipher suites. Value range:
-   * - all: All cipher suites.
-   * - strict: Strong cipher suites.
-   * - custom: Custom cipher suites.
+   * The cipher suite group. Default value: `all`. Valid values:
+   * 
+   * - `all`: All cipher suites.
+   * 
+   * - `strict`: strong cipher suites.
+   * 
+   * - `custom`: custom cipher suites.
    * 
    * @example
    * all
@@ -24,7 +27,7 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   ciphersuiteGroup?: string;
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * This parameter is required.
    * 
@@ -34,9 +37,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Whether to enable HTTP2. Default is enabled. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether HTTP/2 is enabled. Default value: `on`. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -44,9 +49,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   http2?: string;
   /**
    * @remarks
-   * Whether to enable HTTP3. Default is enabled. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether HTTP/3 is enabled. Default value: `on`. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -54,9 +61,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   http3?: string;
   /**
    * @remarks
-   * Whether to enable HTTPS. Default is enabled. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether HTTPS is enabled. Default value: `on`. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -64,9 +73,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   https?: string;
   /**
    * @remarks
-   * Whether to enable OCSP. Default is disabled. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether OCSP stapling is enabled. Default value: `off`. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -74,9 +85,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   ocspStapling?: 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\\")
+   * The conditional expression used to match incoming requests. This parameter is not required when you add a global configuration. Use cases:
+   * 
+   * - 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\\")
@@ -84,9 +97,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether the rule is enabled. This parameter is not required when you add a global configuration. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -94,16 +109,23 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter is not required when adding a global configuration.
+   * The rule name. This parameter is not required when you add a global configuration.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The rule execution order. A smaller value indicates a higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @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.
    * 
@@ -113,9 +135,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * Whether to enable TLS1.0. Default is disabled. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether TLS 1.0 is enabled. Default value: `off`. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -123,9 +147,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   tls10?: string;
   /**
    * @remarks
-   * Whether to enable TLS1.1. Default is disabled. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether TLS 1.1 is enabled. Default value: `off`. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -133,9 +159,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   tls11?: string;
   /**
    * @remarks
-   * Whether to enable TLS1.2. Default is disabled. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether TLS 1.2 is enabled. Default value: `off`. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on
@@ -143,9 +171,11 @@ export class UpdateHttpsBasicConfigurationRequest extends $dara.Model {
   tls12?: string;
   /**
    * @remarks
-   * Whether to enable TLS1.3. Default is disabled. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * Indicates whether TLS 1.3 is enabled. Default value: `off`. Valid values:
+   * 
+   * - `on`: Enabled.
+   * 
+   * - `off`: Disabled.
    * 
    * @example
    * on

package/src/models/UpdateHttpsBasicConfigurationResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpsBasicConfigurationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 0AEDAF20-4DDF-4165-8750-47FF9C1929C9