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/UpdateListShrinkRequest.ts CHANGED Viewed

@@ -15,7 +15,7 @@ export class UpdateListShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the custom list, which can be obtained by calling the [ListLists](https://help.aliyun.com/document_detail/2850217.html) operation.
+   * The ID of the custom list. You can obtain the ID by calling the [ListLists](https://help.aliyun.com/document_detail/2850217.html) operation.
    *
    * This parameter is required.
    *
@@ -25,7 +25,15 @@ export class UpdateListShrinkRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The items in the updated list. The value is a JSON array.
+   * The new list content. The value is a JSON array string, for example, `["1.1.1.1","2.2.2.2"]`.
+   *
+   * **Full overwrite semantics**: The specified `Items` value completely overwrites the existing list content instead of appending to it.
+   *
+   * > ⚠️ **If this parameter is not specified or is set to an empty value, the existing list content is cleared**. To retain existing items and append new ones, call `GetList` to retrieve the current `Items`, merge them, and then submit the combined list.
+   *
+   * **Element format**: The format depends on the `Kind` value specified when the list was created. UpdateList does not support modifying Kind.
+   * - Kind = `ip`: Each element must be a valid IP address or CIDR block. If an element is invalid, `WrongValueMatched` is returned.
+   * - Other Kind values: The element format is subject to the relevant specifications. The number of elements is limited by the tenant quota `NumberItemsPerList`. This limit does not apply to the `ip` Kind.
    *
    * This parameter is required.
    *
@@ -35,7 +43,9 @@ export class UpdateListShrinkRequest extends $dara.Model {
   itemsShrink?: string;
   /**
    * @remarks
-   * The new name of the list.
+   * The new name of the custom list. If this parameter is not specified, the original name is retained.
+   *
+   * **Naming rules**: Only letters, digits, and underscores are supported (`^\\w{1,64}$`). The name must be 1 to 64 characters in length.
    *
    * This parameter is required.
    *

package/src/models/UpdatePageRequest.ts CHANGED Viewed

@@ -5,7 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePageRequest extends $dara.Model {
   /**
    * @remarks
-   * The Base64-encoded content for the response page, corresponding to the specified `ContentType`.
+   * The BASE64-encoded page content, which must be consistent with `ContentType`.
+   *
+   * **Encoding method**:
+   * 1. Convert the original page content to a UTF-8 byte string.
+   * 2. Encode the byte string using standard BASE64 encoding.
+   *
+   * **Example**: `<html>hello page</html>` → `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=`
+   *
+   * > The maximum size limit is subject to the server-side custom page specification. If this parameter is not specified, the original page content is retained.
    *
    * This parameter is required.
    *
@@ -15,11 +23,13 @@ export class UpdatePageRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The value for the Content-Type HTTP header. Examples:
+   * The MIME type of the page content, which is returned to the client as the HTTP `Content-Type` response header when a rule is matched.
    *
-   * - text/html
+   * **Common values**:
+   * - `text/html`: HTML page
+   * - `application/json`: JSON response
    *
-   * - application/json
+   * > The complete set of supported values is subject to the server-side specification. The actual format of `Content` must match this field. A mismatch may cause browser rendering issues.
    *
    * This parameter is required.
    *
@@ -29,7 +39,7 @@ export class UpdatePageRequest extends $dara.Model {
   contentType?: string;
   /**
    * @remarks
-   * The description of the custom response page.
+   * The description of the page after the update. This is used to identify the purpose of the page in the console list. This is an optional field. If this parameter is not specified, the original description is retained. The maximum field length is subject to the server-side limit.
    *
    * This parameter is required.
    *
@@ -39,7 +49,7 @@ export class UpdatePageRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the custom response page. Retrieve 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 this value by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) operation.
    *
    * This parameter is required.
    *
@@ -49,7 +59,9 @@ export class UpdatePageRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the custom response page.
+   * The name of the custom response page after the update.
+   *
+   * **Naming suggestion**: Use a combination of letters, digits, and underscores (such as `blocked_page_v2`) for easy reference in rules. The character set, maximum length, and uniqueness constraints are subject to the server-side naming conventions for custom pages. If this parameter is not specified, the original name is retained.
    *
    * This parameter is required.
    *
@@ -57,6 +69,14 @@ export class UpdatePageRequest extends $dara.Model {
    * example
    */
   name?: string;
+  /**
+   * @remarks
+   * The list of site IDs associated with this page after the update. This parameter uses full overwrite semantics.
+   *
+   * - You can obtain site IDs by calling the `ListSites` operation.
+   * - Passing an empty list dissociates all sites from the page.
+   * - Including a site ID that does not belong to your account returns an `InvalidParameter` error.
+   */
   siteIds?: number[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdatePageResponseBody.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePageResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    *
    * @example
    * 36af3fcc-43d0-441c-86b1-428951dc8225

package/src/models/UpdatePageShrinkRequest.ts CHANGED Viewed

@@ -5,7 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class UpdatePageShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The Base64-encoded content for the response page, corresponding to the specified `ContentType`.
+   * The BASE64-encoded page content, which must be consistent with `ContentType`.
+   *
+   * **Encoding method**:
+   * 1. Convert the original page content to a UTF-8 byte string.
+   * 2. Encode the byte string using standard BASE64 encoding.
+   *
+   * **Example**: `<html>hello page</html>` → `PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=`
+   *
+   * > The maximum size limit is subject to the server-side custom page specification. If this parameter is not specified, the original page content is retained.
    *
    * This parameter is required.
    *
@@ -15,11 +23,13 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The value for the Content-Type HTTP header. Examples:
+   * The MIME type of the page content, which is returned to the client as the HTTP `Content-Type` response header when a rule is matched.
    *
-   * - text/html
+   * **Common values**:
+   * - `text/html`: HTML page
+   * - `application/json`: JSON response
    *
-   * - application/json
+   * > The complete set of supported values is subject to the server-side specification. The actual format of `Content` must match this field. A mismatch may cause browser rendering issues.
    *
    * This parameter is required.
    *
@@ -29,7 +39,7 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   contentType?: string;
   /**
    * @remarks
-   * The description of the custom response page.
+   * The description of the page after the update. This is used to identify the purpose of the page in the console list. This is an optional field. If this parameter is not specified, the original description is retained. The maximum field length is subject to the server-side limit.
    *
    * This parameter is required.
    *
@@ -39,7 +49,7 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the custom response page. Retrieve 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 this value by calling the [ListPages](https://help.aliyun.com/document_detail/2850223.html) operation.
    *
    * This parameter is required.
    *
@@ -49,7 +59,9 @@ export class UpdatePageShrinkRequest extends $dara.Model {
   id?: number;
   /**
    * @remarks
-   * The name of the custom response page.
+   * The name of the custom response page after the update.
+   *
+   * **Naming suggestion**: Use a combination of letters, digits, and underscores (such as `blocked_page_v2`) for easy reference in rules. The character set, maximum length, and uniqueness constraints are subject to the server-side naming conventions for custom pages. If this parameter is not specified, the original name is retained.
    *
    * This parameter is required.
    *
@@ -57,6 +69,14 @@ export class UpdatePageShrinkRequest extends $dara.Model {
    * example
    */
   name?: string;
+  /**
+   * @remarks
+   * The list of site IDs associated with this page after the update. This parameter uses full overwrite semantics.
+   *
+   * - You can obtain site IDs by calling the `ListSites` operation.
+   * - Passing an empty list dissociates all sites from the page.
+   * - Including a site ID that does not belong to your account returns an `InvalidParameter` error.
+   */
   siteIdsShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateRedirectRuleRequest.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateRedirectRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the configuration. To get this ID, call the [ListRedirectRules](https://help.aliyun.com/document_detail/2867474.html) operation.
+   * The configuration ID. You can call the [ListRedirectRules](https://help.aliyun.com/document_detail/2867474.html) operation to obtain the configuration ID.
    *
    * This parameter is required.
    *
@@ -15,11 +15,9 @@ export class UpdateRedirectRuleRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Specifies whether to preserve the query string of the original request. Valid values:
-   *
-   * - `on`: Preserves the query string.
-   *
-   * - `off`: Does not preserve the query string.
+   * Specifies whether to preserve the query string. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    *
    * @example
    * on
@@ -27,11 +25,9 @@ export class UpdateRedirectRuleRequest extends $dara.Model {
   reserveQueryString?: string;
   /**
    * @remarks
-   * The conditional expression that matches user requests. This parameter is not required for a global configuration. Two scenarios are supported:
-   *
-   * - To match all requests, set the value to `true`.
-   *
-   * - To match specific requests, use a custom expression, such as `(http.host eq "video.example.com")`.
+   * The rule content. A conditional expression is used to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:
+   * - Match all incoming requests: Set the value to true.
+   * - Match specified requests: Set the value to a custom expression, such as (http.host eq \\"video.example.com\\").
    *
    * @example
    * (http.host eq "video.example.com")
@@ -39,11 +35,9 @@ export class UpdateRedirectRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * 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.
+   * Specifies whether to enable the rule. This parameter is not required when you add a global configuration. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    *
    * @example
    * on
@@ -51,7 +45,7 @@ export class UpdateRedirectRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The name of the rule. This parameter is not required for a global configuration.
+   * The rule name. This parameter is not required when you add a global configuration.
    *
    * @example
    * rule_example
@@ -59,7 +53,7 @@ export class UpdateRedirectRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The execution order of the rule. A lower value indicates a higher priority.
+   * The execution order of the rule. A smaller value indicates a higher priority.
    *
    * @example
    * 1
@@ -67,7 +61,7 @@ export class UpdateRedirectRuleRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The ID of the site. To get this ID, call 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.
    *
@@ -77,16 +71,12 @@ export class UpdateRedirectRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The response status code that the edge node returns to the client for the redirect. Valid values:
+   * The HTTP status code used when the node responds to the client with the redirect address. Valid values:
    *
    * - 301
-   *
    * - 302
-   *
    * - 303
-   *
    * - 307
-   *
    * - 308
    *
    * @example
@@ -95,7 +85,7 @@ export class UpdateRedirectRuleRequest extends $dara.Model {
   statusCode?: string;
   /**
    * @remarks
-   * The URL to which requests are redirected.
+   * The target URL after the redirect.
    *
    * @example
    * http://www.exapmle.com/index.html
@@ -103,11 +93,10 @@ export class UpdateRedirectRuleRequest extends $dara.Model {
   targetUrl?: string;
   /**
    * @remarks
-   * The redirection type. Valid values:
-   *
-   * - `static`: Static mode.
+   * The redirect type. Valid values:
    *
-   * - `dynamic`: Dynamic mode.
+   * - static: static pattern.
+   * - dynamic: dynamic pattern.
    *
    * @example
    * static

package/src/models/UpdateRedirectRuleResponseBody.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateRedirectRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    *
    * @example
    * CB1A380B-09F0-41BB-A198-72F8FD6DA2FE

package/src/models/UpdateRewriteUrlRuleRequest.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration ID. You can get this ID by calling the [ListRewriteUrlRules](https://help.aliyun.com/document_detail/2867480.html) API.
+   * The configuration ID. You can call the [ListRewriteUrlRules](https://help.aliyun.com/document_detail/2867480.html) operation to obtain the configuration ID.
    *
    * This parameter is required.
    *
@@ -15,7 +15,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The query string after the rewrite.
+   * The query string after rewriting.
    *
    * @example
    * example=123
@@ -23,11 +23,9 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   queryString?: string;
   /**
    * @remarks
-   * The query string rewrite type. Valid values:
-   *
-   * - static: Static Mode.
-   *
-   * - dynamic: Dynamic Mode.
+   * The query character string rewrite type. Valid values:
+   * - static: static pattern.
+   * - dynamic: dynamic pattern.
    *
    * @example
    * static
@@ -35,11 +33,9 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   rewriteQueryStringType?: string;
   /**
    * @remarks
-   * The URI rewrite type. Valid values:
-   *
-   * - static: Static Mode.
-   *
-   * - dynamic: Dynamic Mode.
+   * The path rewrite type. Valid values:
+   * - static: static pattern.
+   * - dynamic: dynamic pattern.
    *
    * @example
    * static
@@ -50,11 +46,9 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   rewriteUriType?: string;
   /**
    * @remarks
-   * The content of the rule, a conditional expression that matches user requests. This parameter is not required for a Global Configuration. Two use cases are supported:
-   *
-   * - To match all incoming requests, set the value to true.
-   *
-   * - To match specific requests, set the value to a custom expression, for example, (http.host eq "video.example.com").
+   * The rule content. A conditional expression is used to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:
+   * - Match all incoming requests: Set the value to true.
+   * - Match specified requests: Set the value to a custom expression, for example, (http.host eq \\"video.example.com\\").
    *
    * @example
    * (http.host eq "video.example.com")
@@ -62,11 +56,9 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Specifies whether the rule is enabled. This parameter is not required for a Global Configuration. Valid values:
-   *
-   * - on: The rule is enabled.
-   *
-   * - off: The rule is disabled.
+   * The rule switch. This parameter is not required when you add a global configuration. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    *
    * @example
    * on
@@ -74,7 +66,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. This parameter is not required for a Global Configuration.
+   * The rule name. This parameter is not required when you add a global configuration.
    *
    * @example
    * example=123
@@ -82,7 +74,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The execution priority of the rule. A smaller value indicates a higher priority.
+   * The rule execution order. A smaller value indicates a higher priority.
    *
    * @example
    * 1
@@ -90,7 +82,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site ID. You can get this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) API.
+   * 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.
    *
@@ -100,7 +92,7 @@ export class UpdateRewriteUrlRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The destination URI after the rewrite.
+   * The target URI after rewriting.
    *
    * @example
    * /image/example.jpg

package/src/models/UpdateRoutineRouteRequest.ts CHANGED Viewed

@@ -7,7 +7,7 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
    * @remarks
    * The bypass mode. Valid values:
    * - on: enabled
-   * - off: disabled.
+   * - off: disabled
    *
    * @example
    * on
@@ -25,7 +25,7 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The fallback-to-origin 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:
+   * The back-to-origin on exception 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:
    * - on: Enabled.
    * - off: Disabled.
    *
@@ -37,7 +37,7 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
    * @remarks
    * The route switch. Valid values:
    * - on: enabled
-   * - off: disabled.
+   * - off: disabled
    *
    * @example
    * on
@@ -53,7 +53,7 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
   routeName?: string;
   /**
    * @remarks
-   * The name of the Edge Routine.
+   * The Edge Routine name.
    *
    * @example
    * test-routine1
@@ -69,7 +69,7 @@ export class UpdateRoutineRouteRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * The execution order of the rule.
+   * The rule execution order.
    *
    * @example
    * 1
@@ -87,7 +87,7 @@ export class UpdateRoutineRouteRequest 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/UpdateUrlObservationRequest.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateUrlObservationRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the configuration. You can call the [ListUrlObservations](~~ListUrlObservations~~) operation to obtain the ID.
+   * The configuration ID. You can call the [ListUrlObservations](~~ListUrlObservations~~) operation to obtain the configuration ID.
    *
    * This parameter is required.
    *
@@ -15,10 +15,10 @@ export class UpdateUrlObservationRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * SDK integration. Valid values:
+   * The SDK integration method. Valid values:
    *
-   * *   **automatic** (Recommended)
-   * *   **manual**
+   * - **automatic**: automatic integration.
+   * - **manual**: manual integration.
    *
    * This parameter is required.
    *
@@ -28,7 +28,7 @@ export class UpdateUrlObservationRequest extends $dara.Model {
   sdkType?: string;
   /**
    * @remarks
-   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
    *
    * This parameter is required.
    *

package/src/models/UploadClientCaCertificateRequest.ts CHANGED Viewed

@@ -23,7 +23,7 @@ export class UploadClientCaCertificateRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The website ID.
+   * The site ID.
    *
    * This parameter is required.
    *

package/src/models/UploadClientCaCertificateResponseBody.ts CHANGED Viewed

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UploadClientCaCertificateResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The Common Name of the certificate.
+   * The common name of the certificate.
    *
    * @example
    * www.example.com
@@ -29,7 +29,7 @@ export class UploadClientCaCertificateResponseBody extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The CA that issued the certificate.
+   * The certification authority.
    *
    * @example
    * GlobalSign nv-sa
@@ -37,7 +37,7 @@ export class UploadClientCaCertificateResponseBody extends $dara.Model {
   issuer?: string;
   /**
    * @remarks
-   * The time when the certificate expires.
+   * The end time of the certificate validity period.
    *
    * @example
    * 2024-12-01T02:13:07Z
@@ -45,7 +45,7 @@ export class UploadClientCaCertificateResponseBody extends $dara.Model {
   notAfter?: string;
   /**
    * @remarks
-   * The time when the certificate takes effect.
+   * The start time of the certificate validity period.
    *
    * @example
    * 2023-12-01T02:13:07Z
@@ -61,7 +61,7 @@ export class UploadClientCaCertificateResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The serial number of the certificate.
+   * The certificate serial number.
    *
    * @example
    * babab9db65ee5efcca9f3d41d4b50d66
@@ -77,7 +77,7 @@ export class UploadClientCaCertificateResponseBody extends $dara.Model {
   signatureAlgorithm?: string;
   /**
    * @remarks
-   * The status of the certificate.
+   * The certificate status.
    *
    * @example
    * OK
@@ -85,7 +85,7 @@ export class UploadClientCaCertificateResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The validity period of the certificate. Unit: day.
+   * The number of days the certificate is valid.
    *
    * @example
    * 300