@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest.ts

@@ -5,17 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   * An array of objects, where each object defines a modification to a request header.
    * 
    * This parameter is required.
    */
   requestHeaderModificationShrink?: string;
   /**
    * @remarks
-   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * The conditional expression that the Rule uses to match incoming requests. This parameter is not required for a Global configuration. There are two use cases:
    * 
-   * *   true: Match all incoming requests.
-   * *   Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, use a custom expression. For example: `(http.host eq "video.example.com")`
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -23,10 +24,11 @@ export class CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * Specifies whether the Rule is enabled. This parameter is not required for a Global configuration. Valid values:
+   * 
+   * - `on`: The Rule is enabled.
    * 
-   * *   on
-   * *   off
+   * - `off`: The Rule is disabled.
    * 
    * @example
    * on
@@ -34,7 +36,7 @@ export class CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. You do not need to set this parameter when you add global configuration.
+   * The name of the Rule. This parameter is not required for a Global configuration.
    * 
    * @example
    * rule_example
@@ -42,7 +44,7 @@ export class CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * The execution order of the Rule. A lower value indicates a higher priority.
    * 
    * @example
    * 1
@@ -50,7 +52,7 @@ export class CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   sequence?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The ID of the Site. You can obtain this value by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -60,7 +62,7 @@ export class CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   siteId?: number;
   /**
    * @remarks
-   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * The Version of the Site configuration. For Sites with configuration versioning enabled, this parameter specifies the Version to which the Rule applies. The default value is 0.
    * 
    * @example
    * 0

package/src/models/CreateHttpIncomingResponseHeaderModificationRuleRequest.ts

@@ -15,11 +15,13 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
   name?: string;
   /**
    * @remarks
-   * The action. Valid values:
+   * The operation to perform on the header. Valid values:
    * 
-   * *   add: adds a response header.
-   * *   del: deletes a response header.
-   * *   modify: modifies a response header.
+   * - `add`: Adds the header.
+   * 
+   * - `del`: Deletes the header.
+   * 
+   * - `modify`: Modifies the header.
    * 
    * This parameter is required.
    * 
@@ -29,10 +31,11 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
   operation?: string;
   /**
    * @remarks
-   * The type of the value. Valid values:
+   * The type of the header value. Valid values:
+   * 
+   * - `static`: The `Value` is a fixed string.
    * 
-   * *   static
-   * *   dynamic
+   * - `dynamic`: The `Value` can contain variables.
    * 
    * @example
    * static
@@ -76,17 +79,18 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
 export class CreateHttpIncomingResponseHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The configurations of modifying response headers. You can add, delete, or modify a response header.
+   * Specifies the modifications for a response header. The supported operations are `add`, `del`, and `modify`.
    * 
    * This parameter is required.
    */
   responseHeaderModification?: CreateHttpIncomingResponseHeaderModificationRuleRequestResponseHeaderModification[];
   /**
    * @remarks
-   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * The conditional expression used to match an incoming request. This parameter is not required when adding a Global configuration. Two scenarios are supported:
    * 
-   * *   true: Match all incoming requests.
-   * *   Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, use a custom expression. For example: `(http.host eq "video.example.com")`
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -94,10 +98,11 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequest extends $da
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * Indicates if the Rule is enabled. This parameter is not required when adding a Global configuration. Valid values:
+   * 
+   * - `on`: Enables the Rule.
    * 
-   * *   on
-   * *   off
+   * - `off`: Disables the Rule.
    * 
    * @example
    * on
@@ -105,7 +110,7 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequest extends $da
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. You do not need to set this parameter when you add global configuration.
+   * The Rule name. This parameter is not required when adding a Global configuration.
    * 
    * @example
    * rule_example
@@ -113,7 +118,7 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequest extends $da
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * The Rule execution order. A smaller value indicates a higher priority, and the Rule is executed sooner.
    * 
    * @example
    * 1
@@ -121,7 +126,7 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequest extends $da
   sequence?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The unique identifier for the Site. To get this ID, call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -131,7 +136,7 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequest extends $da
   siteId?: number;
   /**
    * @remarks
-   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * The configuration Version for the Site. If version management is enabled, this parameter specifies the target Version. Defaults to 0.
    * 
    * @example
    * 0

package/src/models/CreateHttpIncomingResponseHeaderModificationRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpIncomingResponseHeaderModificationRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID.
+   * The ID of the created rule.
    * 
    * @example
    * 434497172875264

package/src/models/CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest.ts

@@ -5,17 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The configurations of modifying response headers. You can add, delete, or modify a response header.
+   * Specifies the modifications for a response header. The supported operations are `add`, `del`, and `modify`.
    * 
    * This parameter is required.
    */
   responseHeaderModificationShrink?: string;
   /**
    * @remarks
-   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * The conditional expression used to match an incoming request. This parameter is not required when adding a Global configuration. Two scenarios are supported:
    * 
-   * *   true: Match all incoming requests.
-   * *   Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request
+   * - To match all incoming requests, set the value to `true`.
+   * 
+   * - To match specific requests, use a custom expression. For example: `(http.host eq "video.example.com")`
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -23,10 +24,11 @@ export class CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest exten
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * Indicates if the Rule is enabled. This parameter is not required when adding a Global configuration. Valid values:
+   * 
+   * - `on`: Enables the Rule.
    * 
-   * *   on
-   * *   off
+   * - `off`: Disables the Rule.
    * 
    * @example
    * on
@@ -34,7 +36,7 @@ export class CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest exten
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. You do not need to set this parameter when you add global configuration.
+   * The Rule name. This parameter is not required when adding a Global configuration.
    * 
    * @example
    * rule_example
@@ -42,7 +44,7 @@ export class CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest exten
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * The Rule execution order. A smaller value indicates a higher priority, and the Rule is executed sooner.
    * 
    * @example
    * 1
@@ -50,7 +52,7 @@ export class CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest exten
   sequence?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The unique identifier for the Site. To get this ID, call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -60,7 +62,7 @@ export class CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest exten
   siteId?: number;
   /**
    * @remarks
-   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * The configuration Version for the Site. If version management is enabled, this parameter specifies the target Version. Defaults to 0.
    * 
    * @example
    * 0

package/src/models/CreateHttpRequestHeaderModificationRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpRequestHeaderModificationRuleRequestRequestHeaderModification extends $dara.Model {
   /**
    * @remarks
-   * Request header name.
+   * The Request Header name.
    * 
    * This parameter is required.
    * 
@@ -15,11 +15,13 @@ export class CreateHttpRequestHeaderModificationRuleRequestRequestHeaderModifica
   name?: string;
   /**
    * @remarks
-   * Operation type. Possible values:
+   * The operation to perform. Valid values are:
    * 
-   * - add: Add.
-   * - del: Delete
-   * - modify: Modify.
+   * - add: Adds a header.
+   * 
+   * - del: Deletes a header.
+   * 
+   * - modify: Modifies a header.
    * 
    * This parameter is required.
    * 
@@ -27,10 +29,21 @@ export class CreateHttpRequestHeaderModificationRuleRequestRequestHeaderModifica
    * add
    */
   operation?: string;
+  /**
+   * @remarks
+   * The type of the header value. Valid values are:
+   * 
+   * - static: Static value.
+   * 
+   * - dynamic: Dynamic value.
+   * 
+   * @example
+   * static
+   */
   type?: string;
   /**
    * @remarks
-   * Request header value.
+   * The Request Header value.
    * 
    * @example
    * headervalue
@@ -66,16 +79,18 @@ export class CreateHttpRequestHeaderModificationRuleRequestRequestHeaderModifica
 export class CreateHttpRequestHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Modify request headers, supporting add, delete, and modify operations.
+   * An array of objects that define Request Header modifications. Supported operations include add, del, and modify.
    * 
    * This parameter is required.
    */
   requestHeaderModification?: CreateHttpRequestHeaderModificationRuleRequestRequestHeaderModification[];
   /**
    * @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\\")
+   * The content of the Rule, which uses a Conditional Expression to match user requests. This parameter is not required when you add a global configuration. Supports two 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")
@@ -83,9 +98,11 @@ export class CreateHttpRequestHeaderModificationRuleRequest extends $dara.Model
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Possible values:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to enable the Rule. This parameter is not required when you add a global configuration. Valid values are:
+   * 
+   * - on: Enables the Rule.
+   * 
+   * - off: Disables the Rule.
    * 
    * @example
    * on
@@ -93,16 +110,23 @@ export class CreateHttpRequestHeaderModificationRuleRequest 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 not required when you add a global configuration.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The execution order of the Rule. 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 ID of the Site. You can get this ID by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 
@@ -112,7 +136,7 @@ export class CreateHttpRequestHeaderModificationRuleRequest extends $dara.Model
   siteId?: number;
   /**
    * @remarks
-   * Version number of the site configuration. For sites with version management enabled, this parameter can specify the version to which the configuration applies, defaulting to version 0.
+   * The Version of the Site configuration. For a Site with configuration versioning enabled, this parameter specifies the configuration\\"s target Version. The default value is 0.
    * 
    * @example
    * 0

package/src/models/CreateHttpRequestHeaderModificationRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpRequestHeaderModificationRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 35281609698****
@@ -13,7 +13,7 @@ export class CreateHttpRequestHeaderModificationRuleResponseBody extends $dara.M
   configId?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-280B-72F8FD6DA2FE

package/src/models/CreateHttpRequestHeaderModificationRuleShrinkRequest.ts

@@ -5,16 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpRequestHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * Modify request headers, supporting add, delete, and modify operations.
+   * An array of objects that define Request Header modifications. Supported operations include add, del, and modify.
    * 
    * This parameter is required.
    */
   requestHeaderModificationShrink?: 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\\")
+   * The content of the Rule, which uses a Conditional Expression to match user requests. This parameter is not required when you add a global configuration. Supports two 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")
@@ -22,9 +24,11 @@ export class CreateHttpRequestHeaderModificationRuleShrinkRequest extends $dara.
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Possible values:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to enable the Rule. This parameter is not required when you add a global configuration. Valid values are:
+   * 
+   * - on: Enables the Rule.
+   * 
+   * - off: Disables the Rule.
    * 
    * @example
    * on
@@ -32,16 +36,23 @@ export class CreateHttpRequestHeaderModificationRuleShrinkRequest 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 not required when you add a global configuration.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The execution order of the Rule. 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 ID of the Site. You can get this ID by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 
@@ -51,7 +62,7 @@ export class CreateHttpRequestHeaderModificationRuleShrinkRequest extends $dara.
   siteId?: number;
   /**
    * @remarks
-   * Version number of the site configuration. For sites with version management enabled, this parameter can specify the version to which the configuration applies, defaulting to version 0.
+   * The Version of the Site configuration. For a Site with configuration versioning enabled, this parameter specifies the configuration\\"s target Version. The default value is 0.
    * 
    * @example
    * 0

package/src/models/CreateHttpResponseHeaderModificationRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpResponseHeaderModificationRuleRequestResponseHeaderModification extends $dara.Model {
   /**
    * @remarks
-   * Response header name.
+   * The name of the response header.
    * 
    * This parameter is required.
    * 
@@ -15,11 +15,13 @@ export class CreateHttpResponseHeaderModificationRuleRequestResponseHeaderModifi
   name?: string;
   /**
    * @remarks
-   * Operation type. Possible values:
+   * The modification to perform on the header. Valid values:
    * 
-   * - add: Add.
-   * - del: Delete
-   * - modify: Modify.
+   * - `add`: Adds a header.
+   * 
+   * - `del`: Deletes a header.
+   * 
+   * - `modify`: Modifies a header.
    * 
    * This parameter is required.
    * 
@@ -27,10 +29,21 @@ export class CreateHttpResponseHeaderModificationRuleRequestResponseHeaderModifi
    * add
    */
   operation?: string;
+  /**
+   * @remarks
+   * The value type. Valid values:
+   * 
+   * - `static`: Static value.
+   * 
+   * - `dynamic`: Dynamic value.
+   * 
+   * @example
+   * static
+   */
   type?: string;
   /**
    * @remarks
-   * Response header value.
+   * The value to assign to the header. This parameter is not required when the `Operation` is `del`.
    * 
    * @example
    * headervalue
@@ -66,16 +79,18 @@ export class CreateHttpResponseHeaderModificationRuleRequestResponseHeaderModifi
 export class CreateHttpResponseHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Modify response headers, supporting add, delete, and modify operations.
+   * An array of objects that specify modifications to the response header. The supported operations are `add`, `del`, and `modify`.
    * 
    * This parameter is required.
    */
   responseHeaderModification?: CreateHttpResponseHeaderModificationRuleRequestResponseHeaderModification[];
   /**
    * @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\\")
+   * Specifies the conditional expression that an incoming request must match for the rule to apply. This parameter is not required when adding a Global Configuration. You can set the value in one of the following ways:
+   * 
+   * - 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")
@@ -83,9 +98,11 @@ export class CreateHttpResponseHeaderModificationRuleRequest extends $dara.Model
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter is not required when adding a global configuration. Possible values:
-   * - on: Enable.
-   * - off: Disable.
+   * Specifies whether to enable the rule. This parameter is not required when adding a Global Configuration. Valid values:
+   * 
+   * - `on`: Enables the rule.
+   * 
+   * - `off`: Disables the rule.
    * 
    * @example
    * on
@@ -93,16 +110,23 @@ export class CreateHttpResponseHeaderModificationRuleRequest 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 not required when adding a Global Configuration.
    * 
    * @example
    * rule_example
    */
   ruleName?: string;
+  /**
+   * @remarks
+   * The rule\\"s execution order. A lower value indicates a higher priority.
+   * 
+   * @example
+   * 1
+   */
   sequence?: number;
   /**
    * @remarks
-   * Site ID. You can obtain this by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
+   * The Site ID. You can get this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -112,7 +136,7 @@ export class CreateHttpResponseHeaderModificationRuleRequest extends $dara.Model
   siteId?: number;
   /**
    * @remarks
-   * Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the version of the site where the configuration will take effect. The default is version 0.
+   * The version number of the Site configuration. For sites with Configuration Version Management enabled, this parameter specifies the configuration version that the Rule applies to. If omitted, this parameter defaults to version 0.
    * 
    * @example
    * 0

package/src/models/CreateHttpResponseHeaderModificationRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpResponseHeaderModificationRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * A unique identifier for the configuration.
    * 
    * @example
    * 35281609698****
@@ -13,7 +13,7 @@ export class CreateHttpResponseHeaderModificationRuleResponseBody extends $dara.
   configId?: number;
   /**
    * @remarks
-   * Request ID.
+   * A unique identifier for the request.
    * 
    * @example
    * 15C66C7B-671A-4297-9187-2C4477247A74