npm - @alicloud/esa20240910 - Versions diffs - 3.4.0 → 3.5.0 - Mend

@alicloud/esa20240910 3.4.0 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (355) hide show

package/src/models/CreatePageRequest.ts CHANGED Viewed

@@ -5,7 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePageRequest extends $dara.Model {
   /**
    * @remarks
-   * The page content, which must be provided in BASE64 encoding. For example, the value PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4= decodes to \\<html>hello page\\</html>.
+   * The BASE64-encoded page content. The actual content format must match the value of `ContentType`.
+   *
+   * **Encoding method**:
+   * 1. Encode the original page content into a byte string by using UTF-8 encoding.
+   * 2. Apply standard BASE64 encoding to the byte string.
+   *
+   * **Example**:
+   * - Original content: `<html>hello page</html>`
+   * - BASE64: `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=`
+   *
+   * > The maximum size, supported character sets, and security filtering rules are subject to the server-side custom page specifications.
    *
    * @example
    * PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
@@ -13,11 +23,14 @@ export class CreatePageRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The `Content-Type` HTTP header. Examples:
+   * The MIME type of the page content. This value is returned to the client as the HTTP `Content-Type` response header after a match.
    *
-   * - text/html
+   * **Common values**:
+   * - `text/html`: HTML page. The `Content` parameter must be set to the BASE64-encoded value of UTF-8 HTML text.
+   * - `application/json`: JSON response. The `Content` parameter must be set to the BASE64-encoded value of a valid JSON string.
+   * - `text/plain`: plain text. The `Content` parameter must be set to the BASE64-encoded value of plain text content.
    *
-   * - application/json
+   * > Note: The complete list of supported ContentType values is subject to the server-side specifications. If the specified `ContentType` does not match the actual format of `Content`, the client may fail to render the page properly.
    *
    * This parameter is required.
    *
@@ -27,7 +40,11 @@ export class CreatePageRequest extends $dara.Model {
   contentType?: string;
   /**
    * @remarks
-   * The description of the page.
+   * The description of the page, used to identify the purpose of the page in the console list.
+   *
+   * **Suggested content**: Use the scenarios and identity information of the page, such as "CC protection block page - Chinese version". This is an optional field. If not specified, the value is empty by default.
+   *
+   * > The maximum field length is subject to the server-side specifications.
    *
    * @example
    * a custom deny page
@@ -35,7 +52,9 @@ export class CreatePageRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The name of the custom error page.
+   * The name of the custom page.
+   *
+   * **Naming suggestions**: Use a short name that consists of letters, digits, and underscores, such as `blocked_page_v1`, for easy reference in rules. The specific character set, maximum length, uniqueness, and other constraints are **subject to the server-side custom page naming specifications**.
    *
    * This parameter is required.
    *
@@ -43,6 +62,14 @@ export class CreatePageRequest extends $dara.Model {
    * example
    */
   name?: string;
+  /**
+   * @remarks
+   * The list of website IDs to associate with this custom page.
+   *
+   * - You can obtain website IDs by calling the `ListSites` operation.
+   * - If you pass an empty list (no websites are associated), the page is still created but does not take effect. You can call the `UpdatePage` operation later to associate websites.
+   * - If the list contains a website ID that does not belong to the current account, an `InvalidParameter` error is returned.
+   */
   siteIds?: number[];
   static names(): { [key: string]: string } {
     return {

package/src/models/CreatePageResponseBody.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePageResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the custom error page. Obtain this ID by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) API.
+   * The ID of the custom response page. You can obtain the ID by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) operation.
    *
    * @example
    * 50000001

package/src/models/CreatePageShrinkRequest.ts CHANGED Viewed

@@ -5,7 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePageShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The page content, which must be provided in BASE64 encoding. For example, the value PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4= decodes to \\<html>hello page\\</html>.
+   * The BASE64-encoded page content. The actual content format must match the value of `ContentType`.
+   *
+   * **Encoding method**:
+   * 1. Encode the original page content into a byte string by using UTF-8 encoding.
+   * 2. Apply standard BASE64 encoding to the byte string.
+   *
+   * **Example**:
+   * - Original content: `<html>hello page</html>`
+   * - BASE64: `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=`
+   *
+   * > The maximum size, supported character sets, and security filtering rules are subject to the server-side custom page specifications.
    *
    * @example
    * PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=
@@ -13,11 +23,14 @@ export class CreatePageShrinkRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The `Content-Type` HTTP header. Examples:
+   * The MIME type of the page content. This value is returned to the client as the HTTP `Content-Type` response header after a match.
    *
-   * - text/html
+   * **Common values**:
+   * - `text/html`: HTML page. The `Content` parameter must be set to the BASE64-encoded value of UTF-8 HTML text.
+   * - `application/json`: JSON response. The `Content` parameter must be set to the BASE64-encoded value of a valid JSON string.
+   * - `text/plain`: plain text. The `Content` parameter must be set to the BASE64-encoded value of plain text content.
    *
-   * - application/json
+   * > Note: The complete list of supported ContentType values is subject to the server-side specifications. If the specified `ContentType` does not match the actual format of `Content`, the client may fail to render the page properly.
    *
    * This parameter is required.
    *
@@ -27,7 +40,11 @@ export class CreatePageShrinkRequest extends $dara.Model {
   contentType?: string;
   /**
    * @remarks
-   * The description of the page.
+   * The description of the page, used to identify the purpose of the page in the console list.
+   *
+   * **Suggested content**: Use the scenarios and identity information of the page, such as "CC protection block page - Chinese version". This is an optional field. If not specified, the value is empty by default.
+   *
+   * > The maximum field length is subject to the server-side specifications.
    *
    * @example
    * a custom deny page
@@ -35,7 +52,9 @@ export class CreatePageShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The name of the custom error page.
+   * The name of the custom page.
+   *
+   * **Naming suggestions**: Use a short name that consists of letters, digits, and underscores, such as `blocked_page_v1`, for easy reference in rules. The specific character set, maximum length, uniqueness, and other constraints are **subject to the server-side custom page naming specifications**.
    *
    * This parameter is required.
    *
@@ -43,6 +62,14 @@ export class CreatePageShrinkRequest extends $dara.Model {
    * example
    */
   name?: string;
+  /**
+   * @remarks
+   * The list of website IDs to associate with this custom page.
+   *
+   * - You can obtain website IDs by calling the `ListSites` operation.
+   * - If you pass an empty list (no websites are associated), the page is still created but does not take effect. You can call the `UpdatePage` operation later to associate websites.
+   * - If the list contains a website ID that does not belong to the current account, an `InvalidParameter` error is returned.
+   */
   siteIdsShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateRoutineRouteRequest.ts CHANGED Viewed

@@ -7,7 +7,7 @@ export class CreateRoutineRouteRequest extends $dara.Model {
    * @remarks
    * The bypass mode. Valid values:
    * - on: enabled
-   * - off: disabled.
+   * - off: disabled
    *
    * @example
    * on
@@ -15,7 +15,7 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   bypass?: string;
   /**
    * @remarks
-   * The fallback-to-origin switch. When enabled, if the function encounters an exception such as CPU usage exceeding the limit, the request is forwarded to the origin server. Valid values:
+   * The back-to-origin on exception switch. When enabled, if the function encounters an exception such as CPU usage exceeding the limit, the request falls back to the origin server. Valid values:
    * - on: Enabled.
    * - off: Disabled.
    *
@@ -27,7 +27,7 @@ export class CreateRoutineRouteRequest extends $dara.Model {
    * @remarks
    * The route switch. Valid values:
    * - on: enabled
-   * - off: disabled.
+   * - off: disabled
    *
    * This parameter is required.
    *
@@ -85,7 +85,7 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The Edge Routine timeout period. Valid values: 5 to 60.
+   * The Edge Routine timeout period. Valid values: 5 to 60. Unit: seconds.
    *
    * @example
    * 5

package/src/models/CreateUserWafRulesetRequest.ts CHANGED Viewed

@@ -15,7 +15,13 @@ export class CreateUserWafRulesetRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The expression for the WAF ruleset.
+   * The match expression of the WAF ruleset. Rules in this ruleset are evaluated only when a request matches this expression.
+   *
+   * Examples:
+   * - `http.host eq "example.com"` — Only requests with the host example.com enter this ruleset.
+   * - `starts_with(http.uri.path, "/api/")` — Only requests with the /api/ prefix enter this ruleset.
+   *
+   * > The complete expression syntax and available field set are subject to the server-side wirefilter dialect.
    *
    * This parameter is required.
    *
@@ -37,6 +43,8 @@ export class CreateUserWafRulesetRequest extends $dara.Model {
    * @remarks
    * The name of the WAF ruleset.
    *
+   * **Naming suggestion**: Use a combination of letters, digits, and underscores for easy reference. The specific character set, maximum length, and uniqueness constraints are subject to the WAF ruleset service naming conventions.
+   *
    * This parameter is required.
    *
    * @example
@@ -45,23 +53,15 @@ export class CreateUserWafRulesetRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The execution phase of the WAF ruleset.
-   *
-   * - `http_whitelist`: whitelist rule
-   *
-   * - `http_custom`: custom rule
-   *
-   * - `http_managed`: managed rule
-   *
-   * - `http_anti_scan`: scan protection rule
+   * The phase to which the WAF ruleset belongs. Valid values:
    *
-   * - `http_ratelimit`: rate limiting rule
+   * - http_whitelist: whitelist rules
+   * - http_custom: custom rules
+   * - http_managed: managed rules
+   * - http_anti_scan: scan protection rules
+   * - http_ratelimit: rate limiting rules
    *
-   * - `ip_access_rule`: IP access rule
-   *
-   * - `http_bot`: advanced bot
-   *
-   * - `http_security_level_rule`: security rule
+   * > Note: The supported fields (Expression match fields, Action values, and others) vary by phase. For more information, refer to the rule configuration documentation for the corresponding phase.
    *
    * This parameter is required.
    *
@@ -71,17 +71,26 @@ export class CreateUserWafRulesetRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * A list of rule configurations within the WAF ruleset.
+   * The list of rule configurations in the WAF ruleset. Each element corresponds to a rule.
+   *
+   * - The field structure of each rule is subject to the `WafRuleConfig` data structure, which includes Expression, Action, Name, and other fields.
    */
   rules?: WafRuleConfig[];
   /**
    * @remarks
-   * The shared configuration for WAF batch rules.
+   * The shared fields across multiple rules in this ruleset, such as a unified Action or Name prefix.
+   *
+   * > The field structure is subject to the `WafBatchRuleShared` data structure. If you do not need to share properties, you can leave this parameter empty.
    */
   shared?: WafBatchRuleShared;
   /**
    * @remarks
-   * The status of the WAF ruleset.
+   * The status of the WAF ruleset. Valid values:
+   *
+   * - on: Enabled. The rules in the ruleset participate in matching and blocking.
+   * - off: Disabled. The ruleset is retained but does not participate in matching.
+   *
+   * > The complete set of valid values is subject to the server-side enum.
    *
    * This parameter is required.
    *

package/src/models/CreateUserWafRulesetResponseBody.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateUserWafRulesetResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The WAF ruleset ID.
+   * The ID of the WAF ruleset.
    *
    * @example
    * 665d3af3621bccf3fe29e1a4
@@ -21,7 +21,7 @@ export class CreateUserWafRulesetResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * A list of rule IDs within the WAF ruleset.
+   * The list of rule IDs in the WAF ruleset.
    */
   ruleIds?: number[];
   static names(): { [key: string]: string } {

package/src/models/CreateUserWafRulesetShrinkRequest.ts CHANGED Viewed

@@ -13,7 +13,13 @@ export class CreateUserWafRulesetShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The expression for the WAF ruleset.
+   * The match expression of the WAF ruleset. Rules in this ruleset are evaluated only when a request matches this expression.
+   *
+   * Examples:
+   * - `http.host eq "example.com"` — Only requests with the host example.com enter this ruleset.
+   * - `starts_with(http.uri.path, "/api/")` — Only requests with the /api/ prefix enter this ruleset.
+   *
+   * > The complete expression syntax and available field set are subject to the server-side wirefilter dialect.
    *
    * This parameter is required.
    *
@@ -35,6 +41,8 @@ export class CreateUserWafRulesetShrinkRequest extends $dara.Model {
    * @remarks
    * The name of the WAF ruleset.
    *
+   * **Naming suggestion**: Use a combination of letters, digits, and underscores for easy reference. The specific character set, maximum length, and uniqueness constraints are subject to the WAF ruleset service naming conventions.
+   *
    * This parameter is required.
    *
    * @example
@@ -43,23 +51,15 @@ export class CreateUserWafRulesetShrinkRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The execution phase of the WAF ruleset.
-   *
-   * - `http_whitelist`: whitelist rule
-   *
-   * - `http_custom`: custom rule
-   *
-   * - `http_managed`: managed rule
-   *
-   * - `http_anti_scan`: scan protection rule
+   * The phase to which the WAF ruleset belongs. Valid values:
    *
-   * - `http_ratelimit`: rate limiting rule
+   * - http_whitelist: whitelist rules
+   * - http_custom: custom rules
+   * - http_managed: managed rules
+   * - http_anti_scan: scan protection rules
+   * - http_ratelimit: rate limiting rules
    *
-   * - `ip_access_rule`: IP access rule
-   *
-   * - `http_bot`: advanced bot
-   *
-   * - `http_security_level_rule`: security rule
+   * > Note: The supported fields (Expression match fields, Action values, and others) vary by phase. For more information, refer to the rule configuration documentation for the corresponding phase.
    *
    * This parameter is required.
    *
@@ -69,17 +69,26 @@ export class CreateUserWafRulesetShrinkRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * A list of rule configurations within the WAF ruleset.
+   * The list of rule configurations in the WAF ruleset. Each element corresponds to a rule.
+   *
+   * - The field structure of each rule is subject to the `WafRuleConfig` data structure, which includes Expression, Action, Name, and other fields.
    */
   rulesShrink?: string;
   /**
    * @remarks
-   * The shared configuration for WAF batch rules.
+   * The shared fields across multiple rules in this ruleset, such as a unified Action or Name prefix.
+   *
+   * > The field structure is subject to the `WafBatchRuleShared` data structure. If you do not need to share properties, you can leave this parameter empty.
    */
   sharedShrink?: string;
   /**
    * @remarks
-   * The status of the WAF ruleset.
+   * The status of the WAF ruleset. Valid values:
+   *
+   * - on: Enabled. The rules in the ruleset participate in matching and blocking.
+   * - off: Disabled. The ruleset is retained but does not participate in matching.
+   *
+   * > The complete set of valid values is subject to the server-side enum.
    *
    * This parameter is required.
    *

package/src/models/CreateWafRuleRequest.ts CHANGED Viewed

@@ -6,28 +6,27 @@ import { WafRuleConfig } from "./WafRuleConfig";
 export class CreateWafRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The detailed configuration of the WAF rule.
+   * The specific configuration of the WAF rule (`WafRuleConfig` data structure). The required fields vary depending on the Phase value:
+   *
+   * - `http_custom`: `Expression` (match expression) and `Action` (action upon match) are required. Setting `Name` is recommended for easier identification.
+   * - `http_whitelist`: `Expression` is required. Matched requests are allowed directly (no Action).
+   * - `http_ratelimit`: `Expression` and `RateLimit` (rate limiting parameters) are required.
+   * - `ip_access_rule`: `Expression` (containing IP match) and `Action` are required.
+   *
+   * > The complete field definitions are based on the `WafRuleConfig` data structure. If required fields are missing, the service returns `InvalidParameter(400)` / `Rule.Config.Malformed`.
    */
   config?: WafRuleConfig;
   /**
    * @remarks
-   * The phase in which the WAF rule runs.
-   *
+   * The WAF rule execution phase. This **single-creation operation** supports the following phases (it does not support `http_anti_scan` or `http_bot`. For these two phases, use the batch operation `BatchCreateWafRules`):
    * - `http_whitelist`: whitelist rule
-   *
    * - `http_custom`: custom rule
-   *
    * - `http_managed`: managed rule
-   *
-   * - `http_anti_scan`: anti-scan rule
-   *
-   * - `http_ratelimit`: rate limit rule
-   *
+   * - `http_ratelimit`: rate limiting rule
    * - `ip_access_rule`: IP access rule
+   * - `http_security_level_rule`: security rule
    *
-   * - `http_bot`: Advanced Mode Bots
-   *
-   * - `http_security_level_rule`: Security Rule
+   * > Note: `http_anti_scan` and `http_bot` can only be created through the batch operation. Passing these two values to this operation returns an error.
    *
    * This parameter is required.
    *
@@ -37,7 +36,7 @@ export class CreateWafRuleRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * The ID of the WAF ruleset. You can obtain this ID by calling the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ruleset ID.
    *
    * @example
    * 10000001
@@ -45,7 +44,7 @@ export class CreateWafRuleRequest extends $dara.Model {
   rulesetId?: number;
   /**
    * @remarks
-   * The ID of the site. You can obtain this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    *
    * This parameter is required.
    *
@@ -55,7 +54,7 @@ export class CreateWafRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * If version management is enabled for the site, use this parameter to specify 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 on which the configuration takes effect. The default value is 0.
    *
    * @example
    * 0

package/src/models/CreateWafRuleResponseBody.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWafRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the newly created WAF rule.
+   * The ID of the WAF rule. You can call the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) operation to obtain the rule ID.
    *
    * @example
    * 20000001
@@ -21,7 +21,7 @@ export class CreateWafRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ID of the ruleset to which the new rule belongs.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ruleset ID.
    *
    * @example
    * 10000001

package/src/models/CreateWafRuleShrinkRequest.ts CHANGED Viewed

@@ -5,28 +5,27 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWafRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The detailed configuration of the WAF rule.
+   * The specific configuration of the WAF rule (`WafRuleConfig` data structure). The required fields vary depending on the Phase value:
+   *
+   * - `http_custom`: `Expression` (match expression) and `Action` (action upon match) are required. Setting `Name` is recommended for easier identification.
+   * - `http_whitelist`: `Expression` is required. Matched requests are allowed directly (no Action).
+   * - `http_ratelimit`: `Expression` and `RateLimit` (rate limiting parameters) are required.
+   * - `ip_access_rule`: `Expression` (containing IP match) and `Action` are required.
+   *
+   * > The complete field definitions are based on the `WafRuleConfig` data structure. If required fields are missing, the service returns `InvalidParameter(400)` / `Rule.Config.Malformed`.
    */
   configShrink?: string;
   /**
    * @remarks
-   * The phase in which the WAF rule runs.
-   *
+   * The WAF rule execution phase. This **single-creation operation** supports the following phases (it does not support `http_anti_scan` or `http_bot`. For these two phases, use the batch operation `BatchCreateWafRules`):
    * - `http_whitelist`: whitelist rule
-   *
    * - `http_custom`: custom rule
-   *
    * - `http_managed`: managed rule
-   *
-   * - `http_anti_scan`: anti-scan rule
-   *
-   * - `http_ratelimit`: rate limit rule
-   *
+   * - `http_ratelimit`: rate limiting rule
    * - `ip_access_rule`: IP access rule
+   * - `http_security_level_rule`: security rule
    *
-   * - `http_bot`: Advanced Mode Bots
-   *
-   * - `http_security_level_rule`: Security Rule
+   * > Note: `http_anti_scan` and `http_bot` can only be created through the batch operation. Passing these two values to this operation returns an error.
    *
    * This parameter is required.
    *
@@ -36,7 +35,7 @@ export class CreateWafRuleShrinkRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * The ID of the WAF ruleset. You can obtain this ID by calling the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ruleset ID.
    *
    * @example
    * 10000001
@@ -44,7 +43,7 @@ export class CreateWafRuleShrinkRequest extends $dara.Model {
   rulesetId?: number;
   /**
    * @remarks
-   * The ID of the site. You can obtain this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    *
    * This parameter is required.
    *
@@ -54,7 +53,7 @@ export class CreateWafRuleShrinkRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * If version management is enabled for the site, use this parameter to specify 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 on which the configuration takes effect. The default value is 0.
    *
    * @example
    * 0

package/src/models/DescribePurgeTasksRequest.ts CHANGED Viewed

@@ -13,7 +13,7 @@ export class DescribePurgeTasksRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
    *
    *
    * > The end time must be later than the start time.
@@ -41,6 +41,7 @@ export class DescribePurgeTasksRequest extends $dara.Model {
   /**
    * @remarks
    * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * >Notice: You must always specify SiteId. An error is reported if SiteId is not specified.</notice>
    *
    * @example
    * 123456789****
@@ -48,7 +49,7 @@ export class DescribePurgeTasksRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
    *
    * @example
    * 2022-11-16T05:33:00Z
@@ -58,9 +59,9 @@ export class DescribePurgeTasksRequest extends $dara.Model {
    * @remarks
    * The task execution status. Valid values:
    *
-   * - **Complete**: The task is complete.
-   * - **Refreshing**: The task is in progress.
-   * - **Failed**: The task failed.
+   * - **Complete**: Completed.
+   * - **Refreshing**: Refreshing.
+   * - **Failed**: Refresh failed.
    *
    * @example
    * Complete
@@ -72,9 +73,9 @@ export class DescribePurgeTasksRequest extends $dara.Model {
    * - **file** (default): file refresh.
    * - **cachetag**: cache tag refresh.
    * - **directory**: directory refresh.
-   * - **ignoreParams**: parameter-stripped refresh.
+   * - **ignoreParams**: ignore parameters refresh.
    * - **hostname**: hostname refresh.
-   * - **purgeall**: refresh all cached content of the site.
+   * - **purgeall**: purge all cache under the site.
    *
    * @example
    * file

package/src/models/DescribePurgeTasksResponseBody.ts CHANGED Viewed

@@ -13,7 +13,7 @@ export class DescribePurgeTasksResponseBodyTasks extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The creation time, in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).
+   * The creation time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).
    *
    * @example
    * 2023-07-26T01:56:15Z
@@ -37,13 +37,13 @@ export class DescribePurgeTasksResponseBodyTasks extends $dara.Model {
   process?: string;
   /**
    * @remarks
-   * The task status. Valid values:
+   * The status. Valid values:
    *
-   * - **Complete**: The task is complete.
+   * - **Complete**: Completed.
    *
-   * - **Refreshing**: The task is in progress.
+   * - **Refreshing**: Refreshing.
    *
-   * - **Failed**: The task failed.
+   * - **Failed**: Refresh failed.
    *
    * @example
    * Complete
@@ -63,9 +63,9 @@ export class DescribePurgeTasksResponseBodyTasks extends $dara.Model {
    * - **file** (default): file refresh.
    * - **cachetag**: cache tag refresh.
    * - **directory**: directory refresh.
-   * - **ignoreParams**: parameter-stripped refresh.
+   * - **ignoreParams**: ignore parameters refresh.
    * - **hostname**: hostname refresh.
-   * - **purgeall**: refresh all cached content of the site.
+   * - **purgeall**: purge all cache under the site.
    *
    * @example
    * file

package/src/models/DescribeRatePlanPriceGapRequest.ts CHANGED Viewed

@@ -23,12 +23,10 @@ export class DescribeRatePlanPriceGapRequest extends $dara.Model {
   orderType?: string;
   /**
    * @remarks
-   * The specification change type. Valid values:
-   * - DOWNGRADE: downgrade.
-   * - UPGRADE: upgrade.
+   * The code of the target plan for the specification change.
    *
    * @example
-   * UPGRADE
+   * standardplan
    */
   targetPlanCode?: string;
   /**

package/src/models/DescribeRatePlanPriceGapResponseBody.ts CHANGED Viewed

@@ -68,7 +68,7 @@ export class DescribeRatePlanPriceGapResponseBodyPriceModel extends $dara.Model
   currency?: string;
   /**
    * @remarks
-   * The order discount amount.
+   * The discount amount of the order.
    *
    * @example
    * 1