@alicloud/esa20240910 2.32.1 → 2.34.0

package/src/models/CreateHttpIncomingRequestHeaderModificationRuleRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeaderModification extends $dara.Model {
   /**
    * @remarks
+   * The name of the request header.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,12 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
   name?: string;
   /**
    * @remarks
+   * The action. Valid values:
+   * 
+   * *   add: adds a response header.
+   * *   del: deletes a response header.
+   * *   modify: modifies a response header.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,11 +28,20 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
    */
   operation?: string;
   /**
+   * @remarks
+   * The type of the value. Valid values:
+   * 
+   * *   static
+   * *   dynamic
+   * 
    * @example
    * static
    */
   type?: string;
   /**
+   * @remarks
+   * The value of the request header.
+   * 
    * @example
    * headvalue
    */
@@ -59,31 +76,53 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
 export class CreateHttpIncomingRequestHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
+   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   * 
    * This parameter is required.
    */
   requestHeaderModification?: CreateHttpIncomingRequestHeaderModificationRuleRequestRequestHeaderModification[];
   /**
+   * @remarks
+   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * 
+   * *   true: Match all incoming requests.
+   * *   Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request
+   * 
    * @example
    * (http.host eq "video.example.com")
    */
   rule?: string;
   /**
+   * @remarks
+   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The rule name. You do not need to set this parameter when you add global configuration.
+   * 
    * @example
    * rule_example
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * 
    * @example
    * 1
    */
   sequence?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -91,6 +130,9 @@ export class CreateHttpIncomingRequestHeaderModificationRuleRequest extends $dar
    */
   siteId?: number;
   /**
+   * @remarks
+   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * 
    * @example
    * 0
    */

package/src/models/CreateHttpIncomingRequestHeaderModificationRuleResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateHttpIncomingRequestHeaderModificationRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 35281609698****
    */
   configId?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 7C414690-9D7B-5D66-9CD9-AD0B3F25ED49
    */

package/src/models/CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest.ts

@@ -5,31 +5,53 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   * 
    * This parameter is required.
    */
   requestHeaderModificationShrink?: string;
   /**
+   * @remarks
+   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * 
+   * *   true: Match all incoming requests.
+   * *   Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request
+   * 
    * @example
    * (http.host eq "video.example.com")
    */
   rule?: string;
   /**
+   * @remarks
+   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The rule name. You do not need to set this parameter when you add global configuration.
+   * 
    * @example
    * rule_example
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * 
    * @example
    * 1
    */
   sequence?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +59,9 @@ export class CreateHttpIncomingRequestHeaderModificationRuleShrinkRequest extend
    */
   siteId?: number;
   /**
+   * @remarks
+   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * 
    * @example
    * 0
    */

package/src/models/CreateHttpIncomingResponseHeaderModificationRuleRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpIncomingResponseHeaderModificationRuleRequestResponseHeaderModification extends $dara.Model {
   /**
    * @remarks
+   * The name of the response header.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,12 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
   name?: string;
   /**
    * @remarks
+   * The action. Valid values:
+   * 
+   * *   add: adds a response header.
+   * *   del: deletes a response header.
+   * *   modify: modifies a response header.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,11 +28,20 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
    */
   operation?: string;
   /**
+   * @remarks
+   * The type of the value. Valid values:
+   * 
+   * *   static
+   * *   dynamic
+   * 
    * @example
    * static
    */
   type?: string;
   /**
+   * @remarks
+   * The value of the response header.
+   * 
    * @example
    * headerValue
    */
@@ -59,31 +76,53 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
 export class CreateHttpIncomingResponseHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
+   * The configurations of modifying response headers. You can add, delete, or modify a response header.
+   * 
    * This parameter is required.
    */
   responseHeaderModification?: CreateHttpIncomingResponseHeaderModificationRuleRequestResponseHeaderModification[];
   /**
+   * @remarks
+   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * 
+   * *   true: Match all incoming requests.
+   * *   Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request
+   * 
    * @example
    * (http.host eq "video.example.com")
    */
   rule?: string;
   /**
+   * @remarks
+   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The rule name. You do not need to set this parameter when you add global configuration.
+   * 
    * @example
    * rule_example
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * 
    * @example
    * 1
    */
   sequence?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -91,6 +130,9 @@ export class CreateHttpIncomingResponseHeaderModificationRuleRequest extends $da
    */
   siteId?: number;
   /**
+   * @remarks
+   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * 
    * @example
    * 0
    */

package/src/models/CreateHttpIncomingResponseHeaderModificationRuleResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateHttpIncomingResponseHeaderModificationRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 434497172875264
    */
   configId?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 156A6B-677B1A-4297B7-9187B7-2B44792
    */

package/src/models/CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest.ts

@@ -5,31 +5,53 @@ import * as $dara from '@darabonba/typescript';
 export class CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The configurations of modifying response headers. You can add, delete, or modify a response header.
+   * 
    * This parameter is required.
    */
   responseHeaderModificationShrink?: string;
   /**
+   * @remarks
+   * The content of the rule. A conditional expression is used to match a user request. You do not need to set this parameter when you add global configuration. Use cases:
+   * 
+   * *   true: Match all incoming requests.
+   * *   Set the value to a custom expression, for example: (http.host eq "video.example.com"): Match the specified request
+   * 
    * @example
    * (http.host eq "video.example.com")
    */
   rule?: string;
   /**
+   * @remarks
+   * Specifies whether to enable the rule. Valid values: You do not need to set this parameter when you add global configuration. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The rule name. You do not need to set this parameter when you add global configuration.
+   * 
    * @example
    * rule_example
    */
   ruleName?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed. A smaller value gives priority to the rule.
+   * 
    * @example
    * 1
    */
   sequence?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -37,6 +59,9 @@ export class CreateHttpIncomingResponseHeaderModificationRuleShrinkRequest exten
    */
   siteId?: number;
   /**
+   * @remarks
+   * The version number of the website configurations. You can use this parameter to specify a version of your website to apply the feature settings. By default, version 0 is used.
+   * 
    * @example
    * 0
    */

package/src/models/CreateRoutineCodeDeploymentRequest.ts

@@ -5,12 +5,22 @@ import * as $dara from '@darabonba/typescript';
 export class CreateRoutineCodeDeploymentRequestCodeVersions extends $dara.Model {
   /**
    * @remarks
+   * The version of the code.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 1723599747213377175
    */
   codeVersion?: string;
   /**
    * @remarks
+   * The phased release ratio of the code version. Valid values: 1 to 100.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 100
    */
   percentage?: number;
   static names(): { [key: string]: string } {
@@ -39,24 +49,35 @@ 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.
+   * 
    * This parameter is required.
    */
   codeVersions?: CreateRoutineCodeDeploymentRequestCodeVersions[];
   /**
    * @remarks
+   * The name of the environment. Only supports test environment `staging` or production environment `production`.
+   * 
    * This parameter is required.
    * 
    * @example
-   * production
+   * staging
    */
   env?: string;
   /**
    * @remarks
+   * The function name.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * test
    */
   name?: string;
   /**
    * @remarks
+   * The deployment policy. Valid value: percentage.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateRoutineCodeDeploymentResponseBody.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateRoutineCodeDeploymentResponseBodyCodeVersions extends $dara.Model {
+  /**
+   * @remarks
+   * The version of the code.
+   * 
+   * @example
+   * 1723599747213377175
+   */
   codeVersion?: string;
+  /**
+   * @remarks
+   * The phased release ratio.
+   * 
+   * @example
+   * 100
+   */
   percentage?: number;
   static names(): { [key: string]: string } {
     return {
@@ -29,9 +43,34 @@ export class CreateRoutineCodeDeploymentResponseBodyCodeVersions extends $dara.M
 }
 
 export class CreateRoutineCodeDeploymentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration list of the phased release version number.
+   */
   codeVersions?: CreateRoutineCodeDeploymentResponseBodyCodeVersions[];
+  /**
+   * @remarks
+   * The deployment record ID.
+   * 
+   * @example
+   * 234
+   */
   deploymentId?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395
+   */
   requestId?: string;
+  /**
+   * @remarks
+   * The phased release policy. The constant string is "percentage".
+   * 
+   * @example
+   * percentage
+   */
   strategy?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateRoutineCodeDeploymentShrinkRequest.ts

@@ -5,24 +5,35 @@ 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.
+   * 
    * This parameter is required.
    */
   codeVersionsShrink?: string;
   /**
    * @remarks
+   * The name of the environment. Only supports test environment `staging` or production environment `production`.
+   * 
    * This parameter is required.
    * 
    * @example
-   * production
+   * staging
    */
   env?: string;
   /**
    * @remarks
+   * The function name.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * test
    */
   name?: string;
   /**
    * @remarks
+   * The deployment policy. Valid value: percentage.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateRoutineRouteRequest.ts

@@ -4,23 +4,50 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateRoutineRouteRequest extends $dara.Model {
   /**
+   * @remarks
+   * Bypass mode Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   bypass?: string;
+  /**
+   * @remarks
+   * The exception origin fetch switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent back to the origin. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
+   * @example
+   * on
+   */
   fallback?: string;
   /**
+   * @remarks
+   * The routing switch. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   routeEnable?: string;
   /**
+   * @remarks
+   * The name of the route.
+   * 
    * @example
    * test_route
    */
   routeName?: string;
   /**
    * @remarks
+   * The edge function name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -28,17 +55,25 @@ export class CreateRoutineRouteRequest extends $dara.Model {
    */
   routineName?: string;
   /**
+   * @remarks
+   * The content of the rule.
+   * 
    * @example
    * (http.host eq \\"video.example.com\\")
    */
   rule?: string;
   /**
+   * @remarks
+   * The order in which the rule is executed.
+   * 
    * @example
    * 1
    */
   sequence?: number;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateRoutineRouteResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateRoutineRouteResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 35281609698****
    */
   configId?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */

package/src/models/CreateUrlObservationRequest.ts

@@ -5,6 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateUrlObservationRequest extends $dara.Model {
   /**
    * @remarks
+   * SDK integration. Supported
+   * 
+   * *   **automatic**
+   * *   **manual**
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +18,8 @@ export class CreateUrlObservationRequest extends $dara.Model {
   sdkType?: string;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +28,8 @@ export class CreateUrlObservationRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
+   * The URL of the web page to monitor.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateUrlObservationResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateUrlObservationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The configuration ID.
+   * 
    * @example
    * 35281609698****
    */