@alicloud/esa20240910 2.36.0 → 2.37.0

package/src/models/GetOriginRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetOriginRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Configuration ID.
+   * The configuration ID.
    * 
    * @example
    * 352816096987136
@@ -13,10 +13,10 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   configId?: number;
   /**
    * @remarks
-   * Configuration type, which can be used to query global or rule configurations. Value range:
+   * The configuration type to query. Valid values:
    * 
-   * - global: Query global configuration.
-   * - rule: Query rule configuration.
+   * *   global: global configurations.
+   * *   rule: rule configurations.
    * 
    * @example
    * rule
@@ -24,20 +24,64 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   configType?: string;
   /**
    * @remarks
-   * Rewrite the DNS resolution record for the origin request.
+   * The hostname that overrides the resolved hostname of an incoming request.
    * 
    * @example
    * test.example.com
    */
   dnsRecord?: string;
+  /**
+   * @remarks
+   * 302 follow switch. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
+   * @example
+   * on
+   */
   follow302Enable?: string;
+  /**
+   * @remarks
+   * The maximum number of 302 follow times. Valid values: 1 to 5.
+   * 
+   * @example
+   * 1
+   */
   follow302MaxTries?: string;
+  /**
+   * @remarks
+   * Retains the original request parameters switch. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
+   * @example
+   * on
+   */
   follow302RetainArgs?: string;
+  /**
+   * @remarks
+   * Retain the original request header switch. Valid values:
+   * 
+   * *   on
+   * *   off
+   * 
+   * @example
+   * on
+   */
   follow302RetainHeader?: string;
+  /**
+   * @remarks
+   * Target Host
+   * 
+   * @example
+   * test.com
+   */
   follow302TargetHost?: string;
   /**
    * @remarks
-   * HOST carried in the origin request.
+   * The Host header in origin requests.
    * 
    * @example
    * origin.example.com
@@ -45,7 +89,7 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   originHost?: string;
   /**
    * @remarks
-   * Port of the origin server accessed when using the HTTP protocol for origin.
+   * The origin port that is accessed when the HTTP protocol is used to back to the origin.
    * 
    * @example
    * 8080
@@ -53,7 +97,7 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   originHttpPort?: string;
   /**
    * @remarks
-   * Port of the origin server accessed when using the HTTPS protocol for origin.
+   * The origin port that is accessed when the HTTPS protocol is used to back to the origin.
    * 
    * @example
    * 4433
@@ -61,22 +105,30 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   originHttpsPort?: string;
   /**
    * @remarks
-   * mTLS switch. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * The MTLS switch. Valid values:
+   * 
+   * *   on
+   * *   off
    * 
    * @example
    * on
    */
   originMtls?: string;
+  /**
+   * @remarks
+   * The read timeout period (in seconds) on the origin.
+   * 
+   * @example
+   * 10
+   */
   originReadTimeout?: string;
   /**
    * @remarks
-   * Protocol used for the origin request. Value range:
+   * The protocol used for origin requests. Valid values:
    * 
-   * - http: Use HTTP protocol for origin.
-   * - https: Use HTTPS protocol for origin.
-   * - follow: Follow the client\\"s protocol for origin.
+   * *   http: HTTP.
+   * *   https: HTTPS.
+   * *   follow: follows the protocol used by the client.
    * 
    * @example
    * http
@@ -84,7 +136,7 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   originScheme?: string;
   /**
    * @remarks
-   * SNI carried in the origin request.
+   * The SNI in origin requests.
    * 
    * @example
    * origin.example.com
@@ -92,9 +144,10 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   originSni?: string;
   /**
    * @remarks
-   * Origin certificate verification switch. Value range: 
-   * - on: Enable. 
-   * - off: Disable.
+   * The origin certificate verification switch. Valid values:
+   * 
+   * *   on
+   * *   off
    * 
    * @example
    * on
@@ -102,16 +155,28 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   originVerify?: string;
   /**
    * @remarks
-   * Use the range chunk method for origin file download. Value range:
+   * Use range requests to download an object from the source. Valid values:
    * 
-   * - on: Enable.
-   * - off: Disable.
-   * - force: Force.
+   * *   on
+   * *   off
+   * *   force: enables range origin fetch by force.
    * 
    * @example
    * on
    */
   range?: string;
+  /**
+   * @remarks
+   * The size of the range part. Valid values:
+   * 
+   * *   512KB
+   * *   1MB
+   * *   2MB
+   * *   4MB
+   * 
+   * @example
+   * 1MB
+   */
   rangeChunkSize?: string;
   /**
    * @remarks
@@ -123,9 +188,10 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   requestId?: 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, e.g., (http.host eq \\"video.example.com\\")
+   * 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\\")
@@ -133,9 +199,10 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   rule?: string;
   /**
    * @remarks
-   * Rule switch. This parameter does not need to be set when adding a global configuration. Value range:
-   * - on: Enable.
-   * - off: Disable.
+   * 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
@@ -143,7 +210,7 @@ export class GetOriginRuleResponseBody 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 you add global configurations.
    * 
    * @example
    * rule_example
@@ -151,7 +218,7 @@ export class GetOriginRuleResponseBody extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * Rule execution order. The smaller the value, the higher the priority.
+   * The rule execution order. The smaller the value, the higher the priority.
    * 
    * @example
    * 1
@@ -159,7 +226,7 @@ export class GetOriginRuleResponseBody 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, defaulting to version 0.
+   * The version number of the 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
    * 1

package/src/models/GetTransportLayerApplicationRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetTransportLayerApplicationRequest extends $dara.Model {
   /**
    * @remarks
-   * Application ID, which can be obtained by calling the [ListTransportLayerApplications](~~ListTransportLayerApplications~~) interface.
+   * Number of forwarding rules contained in the transport layer acceleration application.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetTransportLayerApplicationRequest extends $dara.Model {
   applicationId?: number;
   /**
    * @remarks
-   * Site ID, which can be obtained by calling the [ListSites](~~ListSites~~) interface.
+   * Transport layer application ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetTransportLayerApplicationResponseBody.ts

@@ -5,11 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   /**
    * @remarks
-   * Client IP pass-through protocol, supporting:
-   * - **off**: No pass-through.
-   * - **PPv1**: PROXY Protocol v1, supports client IP pass-through for TCP protocol.
-   * - **PPv2**: PROXY Protocol v2, supports client IP pass-through for TCP and UDP protocols.
-   * - **SPP**: Simple Proxy Protocol, supports client IP pass-through for UDP protocol.
+   * The domain name of the transport layer application.
    * 
    * @example
    * off
@@ -17,19 +13,18 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   clientIPPassThroughMode?: string;
   /**
    * @remarks
-   * Comment information of the rule.
+   * Switch for IP access rules. When turned on, the IP access rules in WAF take effect on the transport layer application.
+   * 
+   * - on: Turned on.
+   * - off: Turned off.
    * 
    * @example
-   * 测试
+   * IPv6 switch.
    */
   comment?: string;
   /**
    * @remarks
-   * Edge port. Supports:
-   * 
-   * - A single port, such as 80.
-   * - Port range, such as 81-85, representing ports 81, 82, 83, 84, 85.
-   * - Combination of ports and port ranges, separated by commas, for example 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, 90.
+   * Comment information of the rule.
    * 
    * @example
    * 80
@@ -37,10 +32,11 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   edgePort?: string;
   /**
    * @remarks
-   * Forwarding rule protocol, with values:
-   * 
-   * - TCP: TCP protocol.
-   * - UDP: UDP protocol.
+   * Client IP pass-through protocol, supporting:
+   * - **off**: No pass-through.
+   * - **PPv1**: PROXY Protocol v1, supports client IP pass-through for TCP protocol.
+   * - **PPv2**: PROXY Protocol v2, supports client IP pass-through for TCP and UDP protocols.
+   * - **SPP**: Simple Proxy Protocol, supports client IP pass-through for UDP protocol.
    * 
    * @example
    * TCP
@@ -48,7 +44,10 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * Rule ID.
+   * Status of the transport layer application
+   * 
+   * - **deploying**: Deploying. In this state, modification and deletion are not allowed.
+   * - **active**: Active.
    * 
    * @example
    * 1234323***
@@ -56,7 +55,10 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   ruleId?: number;
   /**
    * @remarks
-   * Specific value of the origin, which needs to match the type of the origin.
+   * Origin port. Supports:
+   * 
+   * - A single port, when the origin port is a single port, any valid edge port combination is supported.
+   * - Port range, only when the edge port is a port range, the origin port can be set as a port range and the size of the range must be consistent with the edge port. For example, if the edge port is 90-93, the origin port cannot be set to 81-85 because the origin port range is 5 and the edge port range is 3, which are inconsistent.
    * 
    * @example
    * 1.1.1.1
@@ -64,10 +66,7 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   source?: string;
   /**
    * @remarks
-   * Origin port. Supports:
-   * 
-   * - A single port, when the origin port is a single port, any valid edge port combination is supported.
-   * - Port range, only when the edge port is a port range, the origin port can be set as a port range and the size of the range must be consistent with the edge port. For example, if the edge port is 90-93, the origin port cannot be set to 81-85 because the origin port range is 5 and the edge port range is 3, which are inconsistent.
+   * The CNAME domain corresponding to the transport layer acceleration application. This field is not empty only when the site is accessed via CNAME.
    * 
    * @example
    * 80
@@ -75,11 +74,7 @@ export class GetTransportLayerApplicationResponseBodyRules extends $dara.Model {
   sourcePort?: string;
   /**
    * @remarks
-   * Origin type, supporting:
-   * - **ip**: IP.
-   * - **domain**: Domain name.
-   * - **OP**: Origin pool.
-   * - **LB**: Load balancer.
+   * Rule ID.
    * 
    * @example
    * domain
@@ -149,7 +144,7 @@ export class GetTransportLayerApplicationResponseBodyStaticIpV4List extends $dar
 export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Transport layer application ID.
+   * Specific value of the origin, which needs to match the type of the origin.
    * 
    * @example
    * 17099311410****
@@ -157,28 +152,22 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   applicationId?: number;
   /**
    * @remarks
-   * The CNAME domain corresponding to the transport layer acceleration application. This field is not empty only when the site is accessed via CNAME.
+   * Whether to enable China mainland network access optimization, default is off. Value range:
+   * - on: Enabled.
+   * - off: Disabled.
    * 
    * @example
    * example.com.ialicdn.com
    */
   cname?: string;
   /**
-   * @remarks
-   * Whether to enable China mainland network access optimization, default is off. Value range:
-   * - on: Enabled.
-   * - off: Disabled.
-   * 
    * @example
    * on
    */
   crossBorderOptimization?: string;
   /**
    * @remarks
-   * Switch for IP access rules. When turned on, the IP access rules in WAF take effect on the transport layer application.
-   * 
-   * - on: Turned on.
-   * - off: Turned off.
+   * #/components/schemas/WafRuleMatch2
    * 
    * @example
    * on
@@ -186,7 +175,7 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   ipAccessRule?: string;
   /**
    * @remarks
-   * IPv6 switch.
+   * Ipv6 switch
    * 
    * @example
    * on
@@ -194,7 +183,7 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   ipv6?: string;
   /**
    * @remarks
-   * The domain name of the transport layer application.
+   * Query Transport Layer Acceleration Application
    * 
    * @example
    * test.example.com
@@ -210,12 +199,19 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * List of forwarding rules.
+   * Edge port. Supports:
+   * 
+   * - A single port, such as 80.
+   * - Port range, such as 81-85, representing ports 81, 82, 83, 84, 85.
+   * - Combination of ports and port ranges, separated by commas, for example 80,81-85,90, representing ports 80, 81, 82, 83, 84, 85, 90.
    */
   rules?: GetTransportLayerApplicationResponseBodyRules[];
   /**
    * @remarks
-   * Number of forwarding rules contained in the transport layer acceleration application.
+   * Forwarding rule protocol, with values:
+   * 
+   * - TCP: TCP protocol.
+   * - UDP: UDP protocol.
    * 
    * @example
    * 1
@@ -223,7 +219,7 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   rulesCount?: number;
   /**
    * @remarks
-   * Site ID.
+   * Details of the forwarding rule.
    * 
    * @example
    * 123456****
@@ -232,12 +228,6 @@ export class GetTransportLayerApplicationResponseBody extends $dara.Model {
   staticIp?: string;
   staticIpV4List?: GetTransportLayerApplicationResponseBodyStaticIpV4List[];
   /**
-   * @remarks
-   * Status of the transport layer application
-   * 
-   * - **deploying**: Deploying. In this state, modification and deletion are not allowed.
-   * - **active**: Active.
-   * 
    * @example
    * active
    */

package/src/models/ListListsResponseBody.ts

@@ -83,6 +83,7 @@ export class ListListsResponseBodyLists extends $dara.Model {
 }
 
 export class ListListsResponseBody extends $dara.Model {
+  itemsUsage?: number;
   /**
    * @remarks
    * The array that contains list information, including list data after paging.
@@ -130,6 +131,7 @@ export class ListListsResponseBody extends $dara.Model {
   usage?: number;
   static names(): { [key: string]: string } {
     return {
+      itemsUsage: 'ItemsUsage',
       lists: 'Lists',
       pageNumber: 'PageNumber',
       pageSize: 'PageSize',
@@ -141,6 +143,7 @@ export class ListListsResponseBody extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      itemsUsage: 'number',
       lists: { 'type': 'array', 'itemType': ListListsResponseBodyLists },
       pageNumber: 'number',
       pageSize: 'number',

package/src/models/SetHttpDdoSattackRuleActionRequest.ts

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class SetHttpDDoSAttackRuleActionRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * js
+   */
+  ruleAction?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 100000
+   */
+  ruleIds?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 123456****
+   */
+  siteId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      ruleAction: 'RuleAction',
+      ruleIds: 'RuleIds',
+      siteId: 'SiteId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ruleAction: 'string',
+      ruleIds: 'string',
+      siteId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/SetHttpDdoSattackRuleActionResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { SetHttpDDoSAttackRuleActionResponseBody } from "./SetHttpDdoSattackRuleActionResponseBody";
+
+
+export class SetHttpDDoSAttackRuleActionResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: SetHttpDDoSAttackRuleActionResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: SetHttpDDoSAttackRuleActionResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/SetHttpDdoSattackRuleActionResponseBody.ts

@@ -0,0 +1,34 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class SetHttpDDoSAttackRuleActionResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * C370DAF1-C838-4288-A1A0-9A87633D2***
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/SetHttpDdoSattackRuleStatusRequest.ts

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class SetHttpDDoSAttackRuleStatusRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 87570
+   */
+  ruleIds?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 123456****
+   */
+  siteId?: number;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * on
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      ruleIds: 'RuleIds',
+      siteId: 'SiteId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ruleIds: 'string',
+      siteId: 'number',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+