@alicloud/esa20240910 3.3.0 → 3.4.0

package/src/models/ListRedirectRulesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListRedirectRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 35281609698****
@@ -13,9 +13,9 @@ export class ListRedirectRulesRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type. Possible values:
-   * - global: Global configuration.
-   * - rule: Rule configuration.
+   * The configuration type. Valid values:
+   * - global: global configuration.
+   * - rule: rule configuration.
    * 
    * @example
    * rule
@@ -23,7 +23,7 @@ export class ListRedirectRulesRequest extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Page number.
+   * The page number for a paged query. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -31,7 +31,7 @@ export class ListRedirectRulesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Page size, default is **500**, and the value range is **1~500**.
+   * The number of entries per page for a paged query. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -39,7 +39,7 @@ export class ListRedirectRulesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Rule name, which can be used to find the rule with the specified name.
+   * The rule name. You can use this parameter to query the rule whose name matches the specified value.
    * 
    * @example
    * rule_example
@@ -47,7 +47,7 @@ export class ListRedirectRulesRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) interface.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -57,7 +57,7 @@ export class ListRedirectRulesRequest 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 effective version of the site configuration, with the default being version 0.
+   * The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 0

package/src/models/ListRedirectRulesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 35281609698****
@@ -13,9 +13,9 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type. Possible values:
-   * - global: Global configuration.
-   * - rule: Rule configuration.
+   * The configuration type. Valid values:
+   * - global: global configuration.
+   * - rule: rule configuration.
    * 
    * @example
    * rule
@@ -23,7 +23,7 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Preserve query string. Value range:
+   * Specifies whether to preserve the query string. Valid values:
    * - on: enabled.
    * - off: disabled.
    * 
@@ -33,9 +33,9 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   reserveQueryString?: string;
   /**
    * @remarks
-   * Rule content, using conditional expressions to match user requests. This parameter does not need to be set when adding a global configuration. There are two usage scenarios:
-   * - Match all incoming requests: Set the value to true
-   * - Match specific requests: Set the value to a custom expression, for example: (http.host eq \\"video.example.com\\")
+   * The rule content, which uses a conditional expression to match user requests. You do not need to set this parameter when adding 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")
@@ -43,9 +43,9 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter does not need to be set when adding a global configuration. Possible values:
-   * - on: Enabled.
-   * - off: Disabled.
+   * The rule switch. You do not need to set this parameter when adding a global configuration. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -53,7 +53,7 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * Rule name. This parameter does not need to be set when adding a global configuration.
+   * The rule name. You do not need to set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -61,7 +61,7 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Rule execution order. The smaller the value, the higher the priority.
+   * The rule execution order. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -69,7 +69,7 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * Version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the effective version of the site configuration, with the default being version 0.
+   * The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 1
@@ -77,12 +77,12 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * Response status code used by the node to respond to the client with the redirect address. Possible values:
+   * The HTTP status code used when the node responds to the client with the redirect address. Valid values:
    * - 301
    * - 302
    * - 303
    * - 307
-   * - 308
+   * - 308.
    * 
    * @example
    * 301
@@ -90,7 +90,7 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   statusCode?: string;
   /**
    * @remarks
-   * Target URL after redirection.
+   * The target URL after the redirect.
    * 
    * @example
    * http://www.exapmle.com/index.html
@@ -98,9 +98,10 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
   targetUrl?: string;
   /**
    * @remarks
-   * Redirect type. Possible values:
-   * - static: Static mode.
-   * - dynamic: Dynamic mode.
+   * The redirect type. Valid values:
+   * 
+   * - static: static pattern.
+   * - dynamic: dynamic schema.
    * 
    * @example
    * static
@@ -150,12 +151,12 @@ export class ListRedirectRulesResponseBodyConfigs extends $dara.Model {
 export class ListRedirectRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * List of redirect configurations.
+   * The redirect configuration list.
    */
   configs?: ListRedirectRulesResponseBodyConfigs[];
   /**
    * @remarks
-   * Current page number.
+   * The current page number, which is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -163,7 +164,7 @@ export class ListRedirectRulesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * Page size.
+   * The number of entries per page.
    * 
    * @example
    * 20
@@ -171,7 +172,7 @@ export class ListRedirectRulesResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395
@@ -179,7 +180,7 @@ export class ListRedirectRulesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Total number of items.
+   * The total number of entries.
    * 
    * @example
    * 10
@@ -187,7 +188,7 @@ export class ListRedirectRulesResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * Total number of pages.
+   * The total number of pages.
    * 
    * @example
    * 1

package/src/models/ListRoutineRoutesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListRoutineRoutesRequest extends $dara.Model {
   /**
    * @remarks
-   * The page number. The default value is 1.
+   * The page number for a paging query. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -13,7 +13,7 @@ export class ListRoutineRoutesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. The maximum value is 500. The default value is 500.
+   * The number of entries per page for a paging query. Valid values: 1 to 500.
    * 
    * @example
    * 10
@@ -21,7 +21,7 @@ export class ListRoutineRoutesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The name of the Edge Function routine.
+   * The name of the Edge Routine.
    * 
    * This parameter is required.
    * 

package/src/models/ListRoutineRoutesResponseBody.ts

@@ -6,10 +6,8 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
    * The bypass mode. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -25,11 +23,10 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The type of configuration. You can query global configurations or rule-based configurations based on this parameter. Valid values:
-   * 
-   * - `global`: A global configuration.
+   * The configuration type. You can use this parameter to query global or rule configurations. Valid values:
    * 
-   * - `rule`: A rule-based configuration.
+   * - global: global configuration.
+   * - rule: rule configuration.
    * 
    * @example
    * global
@@ -37,11 +34,9 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Indicates whether to enable fallback to origin. If this feature is enabled, the request is routed to the origin server when an exception occurs in the edge function, such as exceeding the CPU usage limit. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * 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:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -50,10 +45,8 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   /**
    * @remarks
    * The configuration mode. Valid values:
-   * 
-   * - `simple`: Simple mode.
-   * 
-   * - `custom`: Custom mode.
+   * - simple: simple mode.
+   * - custom: custom mode.
    * 
    * @example
    * simple
@@ -61,11 +54,9 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   mode?: string;
   /**
    * @remarks
-   * Indicates whether the route is enabled. Valid values:
-   * 
-   * - `on`: Enabled.
-   * 
-   * - `off`: Disabled.
+   * The route switch status. Valid values:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * on
@@ -81,7 +72,7 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   routeName?: string;
   /**
    * @remarks
-   * The edge function routine name.
+   * The name of the Edge Routine.
    * 
    * @example
    * test-routine1
@@ -97,7 +88,7 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * The rule execution order.
+   * The execution order of the rule.
    * 
    * @example
    * 1
@@ -121,7 +112,7 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The site configuration version.
+   * The version number of the site configuration.
    * 
    * @example
    * 1
@@ -129,7 +120,7 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * The timeout period. Unit: seconds.
+   * The Edge Routine timeout period. Valid values: 5 to 60.
    * 
    * @example
    * 5
@@ -185,12 +176,12 @@ export class ListRoutineRoutesResponseBodyConfigs extends $dara.Model {
 export class ListRoutineRoutesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of configurations.
+   * The configuration list in the response body.
    */
   configs?: ListRoutineRoutesResponseBodyConfigs[];
   /**
    * @remarks
-   * The page number of the returned page.
+   * The current page number, which is the same as the PageNumber request parameter.
    * 
    * @example
    * 1
@@ -198,7 +189,7 @@ export class ListRoutineRoutesResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page.
    * 
    * @example
    * 20
@@ -214,7 +205,7 @@ export class ListRoutineRoutesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries that match the query criteria.
+   * The total number of records.
    * 
    * @example
    * 83
@@ -222,7 +213,7 @@ export class ListRoutineRoutesResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The total number of pages returned.
+   * The total number of pages.
    * 
    * @example
    * 2

package/src/models/ListSitesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListSitesRequestTagFilter extends $dara.Model {
   /**
    * @remarks
-   * The tag key, used to filter query results.
+   * The tag key. Used as a filter condition for the query.
    * 
    * @example
    * tag1
@@ -13,7 +13,7 @@ export class ListSitesRequestTagFilter extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The tag value, used to filter query results.
+   * The tag value. Used as a filter condition for the query.
    * 
    * @example
    * aaa
@@ -47,9 +47,9 @@ export class ListSitesRequest extends $dara.Model {
    * @remarks
    * The access type. Valid values:
    * 
-   * - **NS**: NS access.
+   * - **NS**: NS-based access.
    * 
-   * - **CNAME**: CNAME access.
+   * - **CNAME**: CNAME-based access.
    * 
    * @example
    * NS
@@ -58,12 +58,9 @@ export class ListSitesRequest extends $dara.Model {
   /**
    * @remarks
    * The acceleration region. Valid values:
-   * 
-   * - **domestic**: Chinese mainland only.
-   * 
-   * - **global**: Global.
-   * 
-   * - **overseas**: Global (excluding the Chinese mainland).
+   * - **domestic**: the Chinese mainland only.
+   * - **global**: global.
+   * - **overseas**: global (excluding the Chinese mainland).
    * 
    * @example
    * global
@@ -71,7 +68,7 @@ export class ListSitesRequest extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * Specifies whether to return only sites that use the Enterprise Edition.
+   * Specifies whether to query only Enterprise Edition sites. Set this parameter to **true** to query only Enterprise Edition sites.
    * 
    * @example
    * false
@@ -79,11 +76,9 @@ export class ListSitesRequest extends $dara.Model {
   onlyEnterprise?: boolean;
   /**
    * @remarks
-   * The field to sort the results by. By default, results are sorted by creation time (gmtCreate). Supported values:
-   * 
-   * - `gmtCreate`: site creation time
-   * 
-   * - `visitTime`: site access time
+   * The sort field. By default, results are sorted by creation time. Valid values:
+   * - gmtCreate: site creation time.
+   * - visitTime: site access time.
    * 
    * @example
    * visitTime
@@ -91,7 +86,7 @@ export class ListSitesRequest extends $dara.Model {
   orderBy?: string;
   /**
    * @remarks
-   * The number of the page to return. The default value is **1**.
+   * The page number for paging. The value must be greater than or equal to 1.
    * 
    * @example
    * 1
@@ -99,7 +94,7 @@ export class ListSitesRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. The default value is **500**.
+   * The number of entries per page for paging. Valid values: 1 to 500.
    * 
    * @example
    * 20
@@ -107,14 +102,10 @@ export class ListSitesRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The subscription plan type. Valid values:
-   * 
+   * The plan subscription type. Valid values:
    * - **basicplan**: Basic Edition.
-   * 
    * - **standardplan**: Standard Edition.
-   * 
-   * - **advancedplan**: Advanced Edition.
-   * 
+   * - **advancedplan**: Premium Edition.
    * - **enterpriseplan**: Enterprise Edition.
    * 
    * @example
@@ -123,7 +114,7 @@ export class ListSitesRequest extends $dara.Model {
   planSubscribeType?: string;
   /**
    * @remarks
-   * The resource group ID, used to filter query results.
+   * The resource group ID. Used as a filter condition for the query.
    * 
    * @example
    * rg-aekzd3styujvyei
@@ -131,7 +122,7 @@ export class ListSitesRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The site name, used to filter query results.
+   * The site name. Used as a filter condition for the query.
    * 
    * @example
    * example.com
@@ -139,14 +130,11 @@ export class ListSitesRequest extends $dara.Model {
   siteName?: string;
   /**
    * @remarks
-   * The match mode for the `SiteName` parameter. The default value is `exact`. Valid values:
+   * The search matching mode for the site name. Default is exact match. Valid values:
    * 
    * - **prefix**: prefix match.
-   * 
    * - **suffix**: suffix match.
-   * 
    * - **exact**: exact match.
-   * 
    * - **fuzzy**: fuzzy match.
    * 
    * @example
@@ -155,7 +143,7 @@ export class ListSitesRequest extends $dara.Model {
   siteSearchType?: string;
   /**
    * @remarks
-   * The site status, used to filter query results.
+   * The site status. Used as a filter condition for the query.
    * 
    * @example
    * pending
@@ -163,7 +151,7 @@ export class ListSitesRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * A list of tags to use for filtering sites.
+   * The tag filter rules.
    */
   tagFilter?: ListSitesRequestTagFilter[];
   static names(): { [key: string]: string } {