@alicloud/esa20240910 3.1.2 → 3.2.0

package/src/models/UpdateCustomResponseCodeRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCustomResponseCodeRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the configuration.
+   * The configuration ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class UpdateCustomResponseCodeRuleRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Response page.
+   * The response page.
    * 
    * @example
    * 0
@@ -31,10 +31,11 @@ export class UpdateCustomResponseCodeRuleRequest extends $dara.Model {
   returnCode?: 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 configurations. Use cases:
+   * The rule content. Use a conditional expression to match user requests. Do not set this parameter when adding a global configuration. There are two scenarios:
    * 
-   * *   true: Match all incoming requests.
-   * *   Set the value to a custom expression, for example, (http.host eq "video.example.com"): Match the specified request.
+   * - Match all incoming requests: Set the value to \\`true\\`.
+   * 
+   * - Match specific requests: Set the value to a custom expression, such as: \\`(http.host eq "video.example.com")\\`.
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -42,10 +43,11 @@ export class UpdateCustomResponseCodeRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configurations. Valid values:
+   * The rule switch. Do not set this parameter when adding a global configuration. Valid values:
+   * 
+   * - on: Enable the rule.
    * 
-   * *   on
-   * *   off
+   * - off: Disable the rule.
    * 
    * @example
    * on
@@ -53,7 +55,7 @@ export class UpdateCustomResponseCodeRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. You do not need to set this parameter when you add global configurations.
+   * The rule name. Do not set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -61,7 +63,7 @@ export class UpdateCustomResponseCodeRuleRequest extends $dara.Model {
   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 higher priority.
    * 
    * @example
    * 1
@@ -69,7 +71,7 @@ export class UpdateCustomResponseCodeRuleRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. Get it by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateCustomScenePolicyRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCustomScenePolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The time when the policy expires.
+   * The end time of the policy.
    * 
-   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * The time must be in UTC and in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class UpdateCustomScenePolicyRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The policy name.
+   * The name of the policy.
    * 
    * This parameter is required.
    * 
@@ -27,15 +27,17 @@ export class UpdateCustomScenePolicyRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The IDs of the websites that you want to associate with the policy. Separate multiple IDs with commas (,).
+   * The site IDs to associate with the policy. Use a comma (,) to separate multiple IDs.
+   * 
+   * > This parameter is deprecated. We recommend using the `SiteIds` parameter instead. If the `SiteIds` parameter is specified, the `Objects` parameter is ignored. You must specify a value for either the `Objects` or `SiteIds` parameter.
    * 
    * @example
-   * 123456****
+   * 123456****,123457****
    */
   objects?: string;
   /**
    * @remarks
-   * The policy ID, which can be obtained by calling the [DescribeCustomScenePolicies](https://help.aliyun.com/document_detail/2850508.html) operation.
+   * To obtain the policy ID, call the [DescribeCustomScenePolicies](https://help.aliyun.com/document_detail/2850508.html) operation.
    * 
    * This parameter is required.
    * 
@@ -43,12 +45,19 @@ export class UpdateCustomScenePolicyRequest extends $dara.Model {
    * 1
    */
   policyId?: number;
+  /**
+   * @remarks
+   * The site IDs to associate with the policy. Use a comma (,) to separate multiple IDs.
+   * 
+   * @example
+   * 123456****,123457****
+   */
   siteIds?: string;
   /**
    * @remarks
-   * The time when the policy takes effect.
+   * The start time of the policy.
    * 
-   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * The time must be in UTC and in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * This parameter is required.
    * 
@@ -58,9 +67,9 @@ export class UpdateCustomScenePolicyRequest extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The name of the policy template. Valid value:
+   * The name of the template. Valid value:
    * 
-   * *   **promotion**: major events.
+   * - **promotion**: major promotion
    * 
    * This parameter is required.
    * 

package/src/models/UpdateCustomScenePolicyResponseBody.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCustomScenePolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The time when the policy expires.
+   * The end time of the policy.
    * 
-   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The time is in UTC and in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2023-04-03T19:00:00Z
@@ -15,7 +15,7 @@ export class UpdateCustomScenePolicyResponseBody extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The policy name.
+   * The name of the policy.
    * 
    * @example
    * test
@@ -23,12 +23,14 @@ export class UpdateCustomScenePolicyResponseBody extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The IDs of websites associated.
+   * A list of associated site IDs.
+   * 
+   * > This parameter is deprecated. We recommend that you use the `SiteIds` parameter instead.
    */
   objects?: string[];
   /**
    * @remarks
-   * The policy ID.
+   * The ID of the policy.
    * 
    * @example
    * 1
@@ -42,12 +44,19 @@ export class UpdateCustomScenePolicyResponseBody extends $dara.Model {
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The associated site IDs. Multiple IDs are separated by a comma (,).
+   * 
+   * @example
+   * 123456****,123457****
+   */
   siteIds?: string;
   /**
    * @remarks
-   * The time when the policy takes effect.
+   * The start time of the policy.
    * 
-   * The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
+   * The time is in UTC and in the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.
    * 
    * @example
    * 2023-04-03T16:00:00Z
@@ -55,9 +64,9 @@ export class UpdateCustomScenePolicyResponseBody extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The name of the policy template. Valid value:
+   * The name of the template. Valid value:
    * 
-   * *   **promotion**: major events.
+   * - **promotion**: major promotion
    * 
    * @example
    * promotion

package/src/models/UpdateHttpIncomingRequestHeaderModificationRuleRequest.ts

@@ -15,11 +15,13 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
   name?: string;
   /**
    * @remarks
-   * The action. Valid values:
+   * The operation to perform on the request header. Valid values:
    * 
-   * *   add: adds a response header.
-   * *   del: deletes a response header.
-   * *   modify: modifies a response header.
+   * - `add`: Adds a request header.
+   * 
+   * - `del`: Deletes a request header.
+   * 
+   * - `modify`: Modifies an existing request header.
    * 
    * This parameter is required.
    * 
@@ -29,10 +31,11 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
   operation?: string;
   /**
    * @remarks
-   * The value type. Valid values:
+   * The type of value. Valid values:
+   * 
+   * - `static`: The value is a fixed, literal string.
    * 
-   * *   static
-   * *   dynamic
+   * - `dynamic`: The value is generated dynamically at runtime.
    * 
    * @example
    * static
@@ -76,7 +79,7 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
 export class UpdateHttpIncomingRequestHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.
+   * The ID of the configuration. To obtain this ID, call the ListHttpIncomingRequestHeaderModificationRules API.
    * 
    * This parameter is required.
    * 
@@ -86,15 +89,16 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   configId?: number;
   /**
    * @remarks
-   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   * An array of objects that defines the request header modifications. Supported operations include `add`, `del`, and `modify`.
    */
   requestHeaderModification?: UpdateHttpIncomingRequestHeaderModificationRuleRequestRequestHeaderModification[];
   /**
    * @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 configurations. Use cases:
+   * The rule expression, a conditional expression that matches user requests. This parameter is not required for a global configuration. You can use this parameter in two ways:
    * 
-   * *   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 this 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")
@@ -102,10 +106,11 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configurations. Valid values:
+   * The status of the rule. 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
@@ -113,7 +118,7 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. You do not need to set this parameter when you add global configurations.
+   * The name of the rule. This parameter is not required for a global configuration.
    * 
    * @example
    * rule_example
@@ -121,7 +126,7 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * Specifies the rule\\"s priority. Rules with a lower value are executed first.
    * 
    * @example
    * 1
@@ -129,7 +134,7 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
   sequence?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * The ID of the site. To obtain this ID, call the [ListSites](~~ListSites~~) API.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateHttpIncomingRequestHeaderModificationRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpIncomingRequestHeaderModificationRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * BFEF3861-8BB7-5B63-954C-6575EA7FB2CA

package/src/models/UpdateHttpIncomingRequestHeaderModificationRuleShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpIncomingRequestHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.
+   * The ID of the configuration. To obtain this ID, call the ListHttpIncomingRequestHeaderModificationRules API.
    * 
    * This parameter is required.
    * 
@@ -15,15 +15,16 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   configId?: number;
   /**
    * @remarks
-   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   * An array of objects that defines the request header modifications. Supported operations include `add`, `del`, and `modify`.
    */
   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 configurations. Use cases:
+   * The rule expression, a conditional expression that matches user requests. This parameter is not required for a global configuration. You can use this parameter in two ways:
    * 
-   * *   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 this 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")
@@ -31,10 +32,11 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configurations. Valid values:
+   * The status of the rule. 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
@@ -42,7 +44,7 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. You do not need to set this parameter when you add global configurations.
+   * The name of the rule. This parameter is not required for a global configuration.
    * 
    * @example
    * rule_example
@@ -50,7 +52,7 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * Specifies the rule\\"s priority. Rules with a lower value are executed first.
    * 
    * @example
    * 1
@@ -58,7 +60,7 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
   sequence?: number;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * The ID of the site. To obtain this ID, call the [ListSites](~~ListSites~~) API.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateHttpIncomingResponseHeaderModificationRuleRequest.ts

@@ -15,11 +15,13 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
   name?: string;
   /**
    * @remarks
-   * The action. Valid values:
+   * The operation to perform. Valid values:
    * 
-   * *   add: adds a response header.
-   * *   del: deletes a response header.
-   * *   modify: modifies a response header.
+   * - `add`: Adds a response header.
+   * 
+   * - `del`: Deletes a response header.
+   * 
+   * - `modify`: Modifies an existing response header.
    * 
    * This parameter is required.
    * 
@@ -29,10 +31,11 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
   operation?: string;
   /**
    * @remarks
-   * The value type of the column. Valid values:
+   * The type of the header value. This parameter is required when `Operation` is `add` or `modify`. Valid values:
+   * 
+   * - `static`: The value is a fixed string.
    * 
-   * *   static
-   * *   dynamic
+   * - `dynamic`: The value is a variable.
    * 
    * @example
    * static
@@ -40,7 +43,7 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
   type?: string;
   /**
    * @remarks
-   * The value of the response header.
+   * The value of the response header. This parameter is required when `Operation` is `add` or `modify`.
    * 
    * @example
    * headerValue
@@ -76,7 +79,7 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
 export class UpdateHttpIncomingResponseHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the configuration. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.
+   * The configuration ID. You can obtain this ID by calling the `ListHttpIncomingResponseHeaderModificationRules` operation.
    * 
    * This parameter is required.
    * 
@@ -86,15 +89,16 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequest extends $da
   configId?: number;
   /**
    * @remarks
-   * Modifies a response header. You can add, delete, or modify a request header.
+   * A list of objects specifying modifications to response headers. Supported operations include `add`, `del`, and `modify`.
    */
   responseHeaderModification?: UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHeaderModification[];
   /**
    * @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 condition expression used to match incoming requests. This parameter is not required for a global configuration. You can use this parameter in two ways:
    * 
-   * *   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, set the value to a custom expression, such as `(http.host eq "video.example.com")`.
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -102,10 +106,11 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequest 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:
+   * The status of the rule. This parameter is not required for a global configuration. Valid values:
+   * 
+   * - `on`: Enables the rule.
    * 
-   * *   on
-   * *   off
+   * - `off`: Disables the rule.
    * 
    * @example
    * on
@@ -113,7 +118,7 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequest extends $da
   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
@@ -121,7 +126,7 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequest extends $da
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * The priority of the rule. Rules with a lower value are executed first.
    * 
    * @example
    * 1
@@ -129,7 +134,7 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequest 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 site ID. You can obtain this ID by calling the `ListSites` operation.
    * 
    * This parameter is required.
    * 

package/src/models/UpdateHttpIncomingResponseHeaderModificationRuleShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpIncomingResponseHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the configuration. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.
+   * The configuration ID. You can obtain this ID by calling the `ListHttpIncomingResponseHeaderModificationRules` operation.
    * 
    * This parameter is required.
    * 
@@ -15,15 +15,16 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleShrinkRequest exten
   configId?: number;
   /**
    * @remarks
-   * Modifies a response header. You can add, delete, or modify a request header.
+   * A list of objects specifying modifications to response headers. Supported operations include `add`, `del`, and `modify`.
    */
   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 condition expression used to match incoming requests. This parameter is not required for a global configuration. You can use this parameter in two ways:
    * 
-   * *   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, set the value to a custom expression, such as `(http.host eq "video.example.com")`.
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -31,10 +32,11 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleShrinkRequest 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:
+   * The status of the rule. This parameter is not required for a global configuration. Valid values:
+   * 
+   * - `on`: Enables the rule.
    * 
-   * *   on
-   * *   off
+   * - `off`: Disables the rule.
    * 
    * @example
    * on
@@ -42,7 +44,7 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleShrinkRequest exten
   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
@@ -50,7 +52,7 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleShrinkRequest exten
   ruleName?: string;
   /**
    * @remarks
-   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * The priority of the rule. Rules with a lower value are executed first.
    * 
    * @example
    * 1
@@ -58,7 +60,7 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleShrinkRequest 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 site ID. You can obtain this ID by calling the `ListSites` operation.
    * 
    * This parameter is required.
    *