@alicloud/esa20240910 3.3.0 → 3.5.0

package/src/models/CreateRedirectRuleRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRedirectRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to preserve the query string from the original request. Valid values:
+   * Specifies whether to preserve the query string. Valid values:
    * 
-   * - `on`: Preserves the query string.
-   * 
-   * - `off`: Discards the query string.
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * This parameter is required.
    * 
@@ -19,11 +18,9 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   reserveQueryString?: string;
   /**
    * @remarks
-   * The rule content, which is a conditional expression used to match user requests. Do not set this parameter when adding a global configuration. The following 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, such as `(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, such as (http.host eq \\"video.example.com\\").
    * 
    * @example
    * (http.host eq "video.example.com")
@@ -31,11 +28,9 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Specifies whether to enable the rule. Do not set this parameter when adding a global configuration. Valid values:
-   * 
-   * - `on`: The rule is enabled.
-   * 
-   * - `off`: The rule is 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
@@ -43,7 +38,7 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. Do not set this parameter when adding a global configuration.
+   * The rule name. You do not need to set this parameter when adding a global configuration.
    * 
    * @example
    * rule_example
@@ -51,7 +46,7 @@ export class CreateRedirectRuleRequest 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
@@ -59,7 +54,7 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site ID. To get this value, call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -69,7 +64,7 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * For sites with configuration version management enabled, specify the version to which this configuration applies.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is version 0.
    * 
    * @example
    * 0
@@ -77,17 +72,13 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * The status code that the edge node returns to the client for the redirect. Valid values:
+   * The response status code used by the node when responding to the client with the redirect address. Valid values:
    * 
    * - 301
-   * 
    * - 302
-   * 
    * - 303
-   * 
    * - 307
-   * 
-   * - 308
+   * - 308.
    * 
    * This parameter is required.
    * 
@@ -97,7 +88,7 @@ export class CreateRedirectRuleRequest extends $dara.Model {
   statusCode?: string;
   /**
    * @remarks
-   * The target URL for the redirect.
+   * The target URL after redirection.
    * 
    * This parameter is required.
    * 
@@ -109,9 +100,8 @@ export class CreateRedirectRuleRequest extends $dara.Model {
    * @remarks
    * The redirect type. Valid values:
    * 
-   * - `static`: Static mode.
-   * 
-   * - `dynamic`: Dynamic mode.
+   * - static: Static pattern.
+   * - dynamic: Dynamic pattern.
    * 
    * This parameter is required.
    * 

package/src/models/CreateRedirectRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRedirectRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The config ID.
+   * The configuration ID.
    * 
    * @example
    * 35281609698****

package/src/models/CreateRewriteUrlRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRewriteUrlRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The query string after the rewrite.
+   * The query string after rewriting.
    * 
    * @example
    * example=123
@@ -13,11 +13,10 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   queryString?: string;
   /**
    * @remarks
-   * The query string rewrite mode. Valid values:
+   * The query string rewrite type. Valid values:
    * 
-   * - `static`: Static mode.
-   * 
-   * - `dynamic`: Dynamic mode.
+   * - static: static mode.
+   * - dynamic: dynamic mode.
    * 
    * @example
    * static
@@ -28,11 +27,10 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   rewriteQueryStringType?: string;
   /**
    * @remarks
-   * The URI rewrite mode. Valid values:
-   * 
-   * - `static`: Static mode.
+   * The URI rewrite type. Valid values:
    * 
-   * - `dynamic`: Dynamic mode.
+   * - static: static mode.
+   * - dynamic: dynamic mode.
    * 
    * @example
    * static
@@ -43,11 +41,9 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   rewriteUriType?: string;
   /**
    * @remarks
-   * The conditional expression used to match user requests. This parameter is not required when you add a global configuration. Two use cases are supported:
-   * 
-   * - To match all inbound 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")`.
+   * The rule content, which uses conditional expressions to match user requests. This parameter does not need to be set when adding global configurations. There are two usage scenarios:
+   * - 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")
@@ -55,11 +51,9 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * This parameter is not required when you add a global configuration. Valid values:
-   * 
-   * - `on`: Enables the rule.
-   * 
-   * - `off`: Disables the rule.
+   * The rule switch. This parameter does not need to be set when adding global configurations. Valid values:
+   * - on: enabled.
+   * - off: disabled.
    * 
    * @example
    * on
@@ -67,7 +61,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   ruleEnable?: string;
   /**
    * @remarks
-   * The rule name. This parameter is not required when you add a global configuration.
+   * The rule name. This parameter does not need to be set when adding global configurations.
    * 
    * @example
    * rule_example
@@ -75,7 +69,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The execution priority of the rule. A lower value indicates a higher priority.
+   * The rule execution order. A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -83,7 +77,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site ID. Obtain it by calling the [ListSites](~~ListSites~~) operation.
+   * The site ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
    * 
    * This parameter is required.
    * 
@@ -93,7 +87,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * If configuration versioning is enabled for the site, this parameter specifies the target version. The default value is 0.
+   * The version number of the site configuration. For sites with configuration version management enabled, you can use this parameter to specify the site version for which the configuration takes effect. Default value: 0.
    * 
    * @example
    * 0
@@ -101,7 +95,7 @@ export class CreateRewriteUrlRuleRequest extends $dara.Model {
   siteVersion?: number;
   /**
    * @remarks
-   * The target URI after the rewrite.
+   * The destination URI after rewriting.
    * 
    * @example
    * /image/example.jpg

package/src/models/CreateRewriteUrlRuleResponseBody.ts

@@ -13,7 +13,7 @@ export class CreateRewriteUrlRuleResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * CB1A380B-09F0-41BB-280B-72F8FD6DA2FE

package/src/models/CreateRoutineCodeDeploymentRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRoutineCodeDeploymentRequestCodeVersions extends $dara.Model {
   /**
    * @remarks
-   * The version of the code.
+   * The code version number.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateRoutineCodeDeploymentRequestCodeVersions extends $dara.Model
   codeVersion?: string;
   /**
    * @remarks
-   * The phased release ratio of the code version. Valid values: 1 to 100.
+   * The canary release percentage for the code version. Valid values: 1 to 100.
    * 
    * This parameter is required.
    * 
@@ -49,14 +49,17 @@ export class CreateRoutineCodeDeploymentRequestCodeVersions extends $dara.Model
 export class CreateRoutineCodeDeploymentRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration list of phased release version numbers. A maximum of two versions are supported, and the sum of the total proportions is equal to 100.
+   * The list of percentage-based canary release version configurations. A maximum of two versions are supported, and the total percentage must equal 100.
    * 
    * This parameter is required.
    */
   codeVersions?: CreateRoutineCodeDeploymentRequestCodeVersions[];
   /**
    * @remarks
-   * The name of the environment. Only supports test environment `staging` or production environment `production`.
+   * The environment name.  
+   * Valid values:
+   * - `staging`: staging environment 
+   * - `production`: production environment
    * 
    * This parameter is required.
    * 
@@ -66,7 +69,7 @@ export class CreateRoutineCodeDeploymentRequest extends $dara.Model {
   env?: string;
   /**
    * @remarks
-   * The function name.
+   * The name of the Edge Function Routine.
    * 
    * This parameter is required.
    * 
@@ -76,7 +79,9 @@ export class CreateRoutineCodeDeploymentRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The deployment policy. Valid value: percentage.
+   * The deployment strategy.  
+   * Valid values:
+   * - `percentage`: percentage mode
    * 
    * This parameter is required.
    * 

package/src/models/CreateRoutineCodeDeploymentResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRoutineCodeDeploymentResponseBodyCodeVersions extends $dara.Model {
   /**
    * @remarks
-   * The version of the code.
+   * The code version number.
    * 
    * @example
    * 1723599747213377175
@@ -13,7 +13,7 @@ export class CreateRoutineCodeDeploymentResponseBodyCodeVersions extends $dara.M
   codeVersion?: string;
   /**
    * @remarks
-   * The phased release ratio.
+   * The canary release percentage for the code version.
    * 
    * @example
    * 100
@@ -45,7 +45,7 @@ export class CreateRoutineCodeDeploymentResponseBodyCodeVersions extends $dara.M
 export class CreateRoutineCodeDeploymentResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The configuration list of the phased release version number.
+   * The list of percentage-based canary release code version configurations.
    */
   codeVersions?: CreateRoutineCodeDeploymentResponseBodyCodeVersions[];
   /**
@@ -66,7 +66,7 @@ export class CreateRoutineCodeDeploymentResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The phased release policy. The constant string is "percentage".
+   * The canary release strategy. Fixed value: percentage.
    * 
    * @example
    * percentage

package/src/models/CreateRoutineCodeDeploymentShrinkRequest.ts

@@ -5,14 +5,17 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRoutineCodeDeploymentShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration list of phased release version numbers. A maximum of two versions are supported, and the sum of the total proportions is equal to 100.
+   * The list of percentage-based canary release version configurations. A maximum of two versions are supported, and the total percentage must equal 100.
    * 
    * This parameter is required.
    */
   codeVersionsShrink?: string;
   /**
    * @remarks
-   * The name of the environment. Only supports test environment `staging` or production environment `production`.
+   * The environment name.  
+   * Valid values:
+   * - `staging`: staging environment 
+   * - `production`: production environment
    * 
    * This parameter is required.
    * 
@@ -22,7 +25,7 @@ export class CreateRoutineCodeDeploymentShrinkRequest extends $dara.Model {
   env?: string;
   /**
    * @remarks
-   * The function name.
+   * The name of the Edge Function Routine.
    * 
    * This parameter is required.
    * 
@@ -32,7 +35,9 @@ export class CreateRoutineCodeDeploymentShrinkRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The deployment policy. Valid value: percentage.
+   * The deployment strategy.  
+   * Valid values:
+   * - `percentage`: percentage mode
    * 
    * This parameter is required.
    * 

package/src/models/CreateRoutineRouteRequest.ts

@@ -6,8 +6,8 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   /**
    * @remarks
    * The bypass mode. Valid values:
-   * - on: enabled.
-   * - off: disabled.
+   * - on: enabled
+   * - off: disabled
    * 
    * @example
    * on
@@ -15,9 +15,9 @@ 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:
-   * - on: enabled.
-   * - off: disabled.
+   * 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.
    * 
    * @example
    * on
@@ -26,8 +26,10 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   /**
    * @remarks
    * The route switch. Valid values:
-   * - on: enabled.
-   * - off: disabled.
+   * - on: enabled
+   * - off: disabled
+   * 
+   * This parameter is required.
    * 
    * @example
    * on
@@ -37,13 +39,15 @@ export class CreateRoutineRouteRequest extends $dara.Model {
    * @remarks
    * The route name.
    * 
+   * This parameter is required.
+   * 
    * @example
    * test_route
    */
   routeName?: string;
   /**
    * @remarks
-   * The name of the edge function routine.
+   * The Edge Routine name.
    * 
    * This parameter is required.
    * 
@@ -55,13 +59,15 @@ export class CreateRoutineRouteRequest extends $dara.Model {
    * @remarks
    * The rule content.
    * 
+   * This parameter is required.
+   * 
    * @example
    * (http.host eq \\"video.example.com\\")
    */
   rule?: string;
   /**
    * @remarks
-   * The rule execution sequence.
+   * The rule execution order.
    * 
    * @example
    * 1
@@ -69,7 +75,7 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   sequence?: number;
   /**
    * @remarks
-   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
+   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
    * 
    * This parameter is required.
    * 
@@ -79,7 +85,7 @@ export class CreateRoutineRouteRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The edge routine timeout period. Valid values: 5 to 60. Unit: seconds.
+   * The Edge Routine timeout period. Valid values: 5 to 60. Unit: seconds.
    * 
    * @example
    * 5

package/src/models/CreateSiteRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class CreateSiteRequest extends $dara.Model {
   /**
    * @remarks
-   * The access type for the site. Valid values:
+   * The access type of the site. Valid values:
    * 
-   * - **NS**: NS-based access.
-   * 
-   * - **CNAME**: CNAME-based access.
+   * - **NS**: access by using managed NS.
+   * - **CNAME**: access by configuring a CNAME record.
    * 
    * This parameter is required.
    * 
@@ -19,13 +18,10 @@ export class CreateSiteRequest extends $dara.Model {
   accessType?: string;
   /**
    * @remarks
-   * The acceleration region. Valid values are:
-   * 
-   * - **domestic**: Chinese mainland only.
-   * 
-   * - **global**: Global.
-   * 
-   * - **overseas**: Global (excluding the Chinese mainland).
+   * The acceleration region. Valid values:
+   * - **domestic**: the Chinese mainland only.
+   * - **global**: global.
+   * - **overseas**: global (excluding the Chinese mainland).
    * 
    * This parameter is required.
    * 
@@ -35,7 +31,7 @@ export class CreateSiteRequest extends $dara.Model {
   coverage?: string;
   /**
    * @remarks
-   * The ID of the instance. You can obtain the instance ID by calling the [ListUserRatePlanInstances](https://help.aliyun.com/document_detail/2852398.html) operation. You must specify either the instance ID or the site ID. If you specify both, the instance ID takes precedence.
+   * The instance ID. You can obtain the instance ID by calling the [ListUserRatePlanInstances](https://help.aliyun.com/document_detail/2852398.html) operation. You must specify at least one of the instance ID and site ID. If both are specified, the instance ID takes precedence.
    * 
    * This parameter is required.
    * 
@@ -45,7 +41,7 @@ export class CreateSiteRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the resource group. If you do not specify this parameter, the system automatically uses the ID of the default resource group.
+   * The resource group ID. If you do not specify this parameter, the system automatically uses the default resource group ID.
    * 
    * @example
    * rg-acfmw4znnok****
@@ -53,7 +49,7 @@ export class CreateSiteRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The name of the site.
+   * The site name.
    * 
    * This parameter is required.
    * 

package/src/models/CreateSiteResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateSiteResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A comma-separated list of name servers assigned to the site. This parameter is returned only if the site uses NS-based access. To activate the site, you must change your domain\\"s DNS servers to these name servers. This verifies your ownership of the site and activates it.
+   * The list of name servers assigned to the site, separated by commas (,). This field has a value when the access type of the site is NS. You need to change the DNS servers of the site to these name servers. Then you can verify the site ownership and activate the site.
    * 
    * @example
    * ns1.example.com,ns2.example.com
@@ -21,7 +21,7 @@ export class CreateSiteResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ID of the site.
+   * The site ID.
    * 
    * @example
    * 1234567890123
@@ -29,7 +29,7 @@ export class CreateSiteResponseBody extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The verification code for the site. This parameter is returned only if the site uses CNAME-based access. To activate the site, you must add a TXT record to your domain\\"s DNS settings. Set the record\\"s host to **_esaauth.[your_site_name]** and its value to this **verification code**. This verifies your ownership of the site and activates it.
+   * The verification code of the site. When the access type of the site is CNAME, you need to add a TXT record with the record name **_esaauth.[site name]** and the record value set to the **verification code** on the DNS server of the site. Then you can verify the site ownership and activate the site.
    * 
    * @example
    * verify_aah9dioasmov****