@alicloud/esa20240910 2.33.0 → 2.34.1

package/src/models/UpdateHttpIncomingRequestHeaderModificationRuleRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpIncomingRequestHeaderModificationRuleRequestRequestHeaderModification extends $dara.Model {
   /**
    * @remarks
+   * The name of the request header.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,12 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
   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 UpdateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
    */
   operation?: string;
   /**
+   * @remarks
+   * The value type. Valid values:
+   * 
+   * *   static
+   * *   dynamic
+   * 
    * @example
    * static
    */
   type?: string;
   /**
+   * @remarks
+   * The value of the request header.
+   * 
    * @example
    * headerValue
    */
@@ -59,35 +76,61 @@ export class UpdateHttpIncomingRequestHeaderModificationRuleRequestRequestHeader
 export class UpdateHttpIncomingRequestHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * 419717024278528
    */
   configId?: number;
+  /**
+   * @remarks
+   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   */
   requestHeaderModification?: UpdateHttpIncomingRequestHeaderModificationRuleRequestRequestHeaderModification[];
   /**
+   * @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 configurations. 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 configurations. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The rule name. You do not need to set this parameter when you add global configurations.
+   * 
    * @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](~~ListSites~~) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdateHttpIncomingRequestHeaderModificationRuleResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateHttpIncomingRequestHeaderModificationRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * BFEF3861-8BB7-5B63-954C-6575EA7FB2CA
    */

package/src/models/UpdateHttpIncomingRequestHeaderModificationRuleShrinkRequest.ts

@@ -5,35 +5,61 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpIncomingRequestHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration ID. You can call the ListHttpIncomingRequestHeaderModificationRules operation to query the ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * 419717024278528
    */
   configId?: number;
+  /**
+   * @remarks
+   * The configurations of modifying request headers. You can add, delete, or modify a request header.
+   */
   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 configurations. 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 configurations. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   ruleEnable?: string;
   /**
+   * @remarks
+   * The rule name. You do not need to set this parameter when you add global configurations.
+   * 
    * @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](~~ListSites~~) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdateHttpIncomingResponseHeaderModificationRuleRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHeaderModification extends $dara.Model {
   /**
    * @remarks
+   * The name of the response header.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,12 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
   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 UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
    */
   operation?: string;
   /**
+   * @remarks
+   * The value type of the column. Valid values:
+   * 
+   * *   static
+   * *   dynamic
+   * 
    * @example
    * static
    */
   type?: string;
   /**
+   * @remarks
+   * The value of the response header.
+   * 
    * @example
    * headerValue
    */
@@ -59,35 +76,61 @@ export class UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHead
 export class UpdateHttpIncomingResponseHeaderModificationRuleRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the configuration. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * 352816096987136
    */
   configId?: number;
+  /**
+   * @remarks
+   * Modifies a response header. You can add, delete, or modify a request header.
+   */
   responseHeaderModification?: UpdateHttpIncomingResponseHeaderModificationRuleRequestResponseHeaderModification[];
   /**
+   * @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

package/src/models/UpdateHttpIncomingResponseHeaderModificationRuleResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateHttpIncomingResponseHeaderModificationRuleResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 15C66C7B-671A-4297-9187-2C4477247A74
    */

package/src/models/UpdateHttpIncomingResponseHeaderModificationRuleShrinkRequest.ts

@@ -5,35 +5,61 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateHttpIncomingResponseHeaderModificationRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the configuration. You can call the ListHttpIncomingResponseHeaderModificationRules operation to query the ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * 352816096987136
    */
   configId?: number;
+  /**
+   * @remarks
+   * Modifies a response header. You can add, delete, or modify a request header.
+   */
   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

package/src/models/UpdateRoutineConfigDescriptionRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateRoutineConfigDescriptionRequest extends $dara.Model {
   /**
+   * @remarks
+   * The routine description.
+   * 
    * @example
    * description of this routine
    */
   description?: string;
   /**
    * @remarks
+   * The routine name.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdateRoutineConfigDescriptionResponseBody.ts

@@ -5,13 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateRoutineConfigDescriptionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * EDBD3EB3-97DA-5465-AEF5-8DCA5DC5E395
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the operation is successful.
+   * 
    * @example
    * OK
    */

package/src/models/UpdateRoutineRouteRequest.ts

@@ -4,46 +4,84 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateRoutineRouteRequest extends $dara.Model {
   /**
+   * @remarks
+   * Bypass mode. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */
   bypass?: string;
   /**
    * @remarks
+   * The ID of the configuration.
+   * 
    * This parameter is required.
    * 
    * @example
    * 35281609698****
    */
   configId?: number;
+  /**
+   * @remarks
+   * The exception origin switch. After you turn on this switch, if a function exception occurs, such as CPU usage exceeding the upper limit, requests are sent 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 name of the function.
+   * 
    * @example
    * test-routine1
    */
   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/UpdateRoutineRouteResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateRoutineRouteResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 34DCBC8A-****-****-****-6DAA11D7DDBD
    */

package/src/models/UpdateSeoBypassRequest.ts

@@ -5,6 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateSeoBypassRequest extends $dara.Model {
   /**
    * @remarks
+   * Specifies whether to enable the feature. Valid values:
+   * 
+   * *   **on:**
+   * *   **off**
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +18,8 @@ export class UpdateSeoBypassRequest extends $dara.Model {
   enable?: string;
   /**
    * @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/UpdateSeoBypassResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateSeoBypassResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */

package/src/models/UpdateUrlObservationRequest.ts

@@ -5,6 +5,8 @@ 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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,11 @@ export class UpdateUrlObservationRequest extends $dara.Model {
   configId?: number;
   /**
    * @remarks
+   * SDK integration. Valid values:
+   * 
+   * *   **automatic** (Recommended)
+   * *   **manual**
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +28,8 @@ export class UpdateUrlObservationRequest extends $dara.Model {
   sdkType?: string;
   /**
    * @remarks
+   * The website ID, which can be obtained by calling the [ListSites](~~ListSites~~) operation.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdateVideoProcessingRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateVideoProcessingRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the configuration. You can call the [ListVideoProcessings](~~ListVideoProcessings~~) operation to obtain the ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,52 +14,90 @@ export class UpdateVideoProcessingRequest extends $dara.Model {
    */
   configId?: number;
   /**
+   * @remarks
+   * The custom end parameter for FLV files.
+   * 
    * @example
    * end
    */
   flvSeekEnd?: string;
   /**
+   * @remarks
+   * The custom start parameter for FLV files.
+   * 
    * @example
    * start
    */
   flvSeekStart?: string;
   /**
+   * @remarks
+   * FLV Seeking Valid values:
+   * 
+   * *   by_byte: Seek by byte.
+   * *   by_time: Seek by time.
+   * 
    * @example
    * by_byte
    */
   flvVideoSeekMode?: string;
   /**
+   * @remarks
+   * Customize the mp4 end parameter.
+   * 
    * @example
    * end
    */
   mp4SeekEnd?: string;
   /**
+   * @remarks
+   * Customize the mp4 start parameter.
+   * 
    * @example
    * start
    */
   mp4SeekStart?: 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. Two scenarios:
+   * 
+   * *   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
@@ -65,6 +105,12 @@ export class UpdateVideoProcessingRequest extends $dara.Model {
    */
   siteId?: number;
   /**
+   * @remarks
+   * Video seeking. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
    * @example
    * on
    */

package/src/models/UpdateVideoProcessingResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateVideoProcessingResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 3558df77-8a7a-4060-a900-2d7949403836
    */