@alicloud/esa20240910 3.3.0 → 3.5.0

package/src/models/CreateWafRuleRequest.ts

@@ -6,28 +6,27 @@ import { WafRuleConfig } from "./WafRuleConfig";
 export class CreateWafRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The detailed configuration of the WAF rule.
+   * The specific configuration of the WAF rule (`WafRuleConfig` data structure). The required fields vary depending on the Phase value:
+   * 
+   * - `http_custom`: `Expression` (match expression) and `Action` (action upon match) are required. Setting `Name` is recommended for easier identification.
+   * - `http_whitelist`: `Expression` is required. Matched requests are allowed directly (no Action).
+   * - `http_ratelimit`: `Expression` and `RateLimit` (rate limiting parameters) are required.
+   * - `ip_access_rule`: `Expression` (containing IP match) and `Action` are required.
+   * 
+   * > The complete field definitions are based on the `WafRuleConfig` data structure. If required fields are missing, the service returns `InvalidParameter(400)` / `Rule.Config.Malformed`.
    */
   config?: WafRuleConfig;
   /**
    * @remarks
-   * The phase in which the WAF rule runs.
-   * 
+   * The WAF rule execution phase. This **single-creation operation** supports the following phases (it does not support `http_anti_scan` or `http_bot`. For these two phases, use the batch operation `BatchCreateWafRules`):
    * - `http_whitelist`: whitelist rule
-   * 
    * - `http_custom`: custom rule
-   * 
    * - `http_managed`: managed rule
-   * 
-   * - `http_anti_scan`: anti-scan rule
-   * 
-   * - `http_ratelimit`: rate limit rule
-   * 
+   * - `http_ratelimit`: rate limiting rule
    * - `ip_access_rule`: IP access rule
+   * - `http_security_level_rule`: security rule
    * 
-   * - `http_bot`: Advanced Mode Bots
-   * 
-   * - `http_security_level_rule`: Security Rule
+   * > Note: `http_anti_scan` and `http_bot` can only be created through the batch operation. Passing these two values to this operation returns an error.
    * 
    * This parameter is required.
    * 
@@ -37,7 +36,7 @@ export class CreateWafRuleRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * The ID of the WAF ruleset. You can obtain this ID by calling the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ruleset ID.
    * 
    * @example
    * 10000001
@@ -45,7 +44,7 @@ export class CreateWafRuleRequest extends $dara.Model {
   rulesetId?: number;
   /**
    * @remarks
-   * The ID of the site. You can obtain this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -55,7 +54,7 @@ export class CreateWafRuleRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * If version management is enabled for the site, use this parameter to specify the version to which the configuration applies. The default is 0.
+   * The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.
    * 
    * @example
    * 0

package/src/models/CreateWafRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWafRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the newly created WAF rule.
+   * The ID of the WAF rule. You can call the [ListWafRules](https://help.aliyun.com/document_detail/2878257.html) operation to obtain the rule ID.
    * 
    * @example
    * 20000001
@@ -21,7 +21,7 @@ export class CreateWafRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ID of the ruleset to which the new rule belongs.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ruleset ID.
    * 
    * @example
    * 10000001

package/src/models/CreateWafRuleShrinkRequest.ts

@@ -5,28 +5,27 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWafRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The detailed configuration of the WAF rule.
+   * The specific configuration of the WAF rule (`WafRuleConfig` data structure). The required fields vary depending on the Phase value:
+   * 
+   * - `http_custom`: `Expression` (match expression) and `Action` (action upon match) are required. Setting `Name` is recommended for easier identification.
+   * - `http_whitelist`: `Expression` is required. Matched requests are allowed directly (no Action).
+   * - `http_ratelimit`: `Expression` and `RateLimit` (rate limiting parameters) are required.
+   * - `ip_access_rule`: `Expression` (containing IP match) and `Action` are required.
+   * 
+   * > The complete field definitions are based on the `WafRuleConfig` data structure. If required fields are missing, the service returns `InvalidParameter(400)` / `Rule.Config.Malformed`.
    */
   configShrink?: string;
   /**
    * @remarks
-   * The phase in which the WAF rule runs.
-   * 
+   * The WAF rule execution phase. This **single-creation operation** supports the following phases (it does not support `http_anti_scan` or `http_bot`. For these two phases, use the batch operation `BatchCreateWafRules`):
    * - `http_whitelist`: whitelist rule
-   * 
    * - `http_custom`: custom rule
-   * 
    * - `http_managed`: managed rule
-   * 
-   * - `http_anti_scan`: anti-scan rule
-   * 
-   * - `http_ratelimit`: rate limit rule
-   * 
+   * - `http_ratelimit`: rate limiting rule
    * - `ip_access_rule`: IP access rule
+   * - `http_security_level_rule`: security rule
    * 
-   * - `http_bot`: Advanced Mode Bots
-   * 
-   * - `http_security_level_rule`: Security Rule
+   * > Note: `http_anti_scan` and `http_bot` can only be created through the batch operation. Passing these two values to this operation returns an error.
    * 
    * This parameter is required.
    * 
@@ -36,7 +35,7 @@ export class CreateWafRuleShrinkRequest extends $dara.Model {
   phase?: string;
   /**
    * @remarks
-   * The ID of the WAF ruleset. You can obtain this ID by calling the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation.
+   * The ID of the WAF ruleset. You can call the [ListWafRulesets](https://help.aliyun.com/document_detail/2878359.html) operation to obtain the ruleset ID.
    * 
    * @example
    * 10000001
@@ -44,7 +43,7 @@ export class CreateWafRuleShrinkRequest extends $dara.Model {
   rulesetId?: number;
   /**
    * @remarks
-   * The ID of the site. You can obtain this ID by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 
@@ -54,7 +53,7 @@ export class CreateWafRuleShrinkRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * If version management is enabled for the site, use this parameter to specify the version to which the configuration applies. The default is 0.
+   * The version number of the site configuration. For sites with version management enabled, you can use this parameter to specify the site version on which the configuration takes effect. The default value is 0.
    * 
    * @example
    * 0

package/src/models/CreateWaitingRoomRuleRequest.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateWaitingRoomRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The rule content, which uses a conditional expression to match user requests. This parameter is not required when you add a global configuration. Two scenarios are supported:
+   * The rule content. Use a conditional expression to match user requests. This parameter is not required when you add 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\\").
    * 
-   * For the complete syntax of rule expressions, see <props="china">https://www.alibabacloud.com/help/en/edge-security-acceleration/esa/user-guide/work-with-rules-engine/<props="intl">https://www.alibabacloud.com/help/edge-security-acceleration/esa/user-guide/work-with-rules-engine/.
+   * For the complete syntax of rule expressions, refer to <props="china">https://www.alibabacloud.com/help/en/edge-security-acceleration/esa/user-guide/work-with-rules-engine/<props="intl">https://www.alibabacloud.com/help/edge-security-acceleration/esa/user-guide/work-with-rules-engine/
    * 
    * This parameter is required.
    * 
@@ -41,7 +41,7 @@ export class CreateWaitingRoomRuleRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * The site ID. You can call the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation to obtain the site ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateWaitingRoomRuleResponseBody.ts

@@ -13,7 +13,7 @@ export class CreateWaitingRoomRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The waiting room bypass rule ID.
+   * The ID of the waiting room bypass rule.
    * 
    * @example
    * 420072638347264

package/src/models/DescribeDdoSoverseasAttackCountRequest.ts

@@ -0,0 +1,36 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeDDoSOverseasAttackCountRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1039004047346160
+   */
+  siteId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      siteId: 'SiteId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      siteId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeDdoSoverseasAttackCountResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeDDoSOverseasAttackCountResponseBody } from "./DescribeDdoSoverseasAttackCountResponseBody";
+
+
+export class DescribeDDoSOverseasAttackCountResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeDDoSOverseasAttackCountResponseBody;
+  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: DescribeDDoSOverseasAttackCountResponseBody,
+    };
+  }
+
+  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/DescribeDdoSoverseasAttackCountResponseBody.ts

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeDDoSOverseasAttackCountResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * EBCECE18-DA96-5307-8506-01E5A0E21530
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of attacks supported by the plan.
+   * 
+   * @example
+   * 2
+   */
+  totalCount?: number;
+  /**
+   * @remarks
+   * The number of attacks that have been used.
+   * 
+   * @example
+   * 0
+   */
+  usedCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      requestId: 'RequestId',
+      totalCount: 'TotalCount',
+      usedCount: 'UsedCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      requestId: 'string',
+      totalCount: 'number',
+      usedCount: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribePurgeTasksRequest.ts

@@ -13,7 +13,7 @@ export class DescribePurgeTasksRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * The end time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
    * 
    * 
    * > The end time must be later than the start time.
@@ -41,6 +41,7 @@ export class DescribePurgeTasksRequest extends $dara.Model {
   /**
    * @remarks
    * The site ID, which can be obtained by calling the [ListSites](https://help.aliyun.com/document_detail/2850189.html) operation.
+   * >Notice: You must always specify SiteId. An error is reported if SiteId is not specified.</notice>
    * 
    * @example
    * 123456789****
@@ -48,7 +49,7 @@ export class DescribePurgeTasksRequest extends $dara.Model {
   siteId?: number;
   /**
    * @remarks
-   * The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
+   * The start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
    * 
    * @example
    * 2022-11-16T05:33:00Z
@@ -58,9 +59,9 @@ export class DescribePurgeTasksRequest extends $dara.Model {
    * @remarks
    * The task execution status. Valid values:
    * 
-   * - **Complete**: The task is complete.
-   * - **Refreshing**: The task is in progress.
-   * - **Failed**: The task failed.
+   * - **Complete**: Completed.
+   * - **Refreshing**: Refreshing.
+   * - **Failed**: Refresh failed.
    * 
    * @example
    * Complete
@@ -72,9 +73,9 @@ export class DescribePurgeTasksRequest extends $dara.Model {
    * - **file** (default): file refresh.
    * - **cachetag**: cache tag refresh.
    * - **directory**: directory refresh.
-   * - **ignoreParams**: parameter-stripped refresh.
+   * - **ignoreParams**: ignore parameters refresh.
    * - **hostname**: hostname refresh.
-   * - **purgeall**: refresh all cached content of the site.
+   * - **purgeall**: purge all cache under the site.
    * 
    * @example
    * file

package/src/models/DescribePurgeTasksResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribePurgeTasksResponseBodyTasks extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The creation time, in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).
+   * The creation time in ISO 8601 format (for example, 2024-01-01T00:00:00+Z).
    * 
    * @example
    * 2023-07-26T01:56:15Z
@@ -37,13 +37,13 @@ export class DescribePurgeTasksResponseBodyTasks extends $dara.Model {
   process?: string;
   /**
    * @remarks
-   * The task status. Valid values:
+   * The status. Valid values:
    * 
-   * - **Complete**: The task is complete.
+   * - **Complete**: Completed.
    * 
-   * - **Refreshing**: The task is in progress.
+   * - **Refreshing**: Refreshing.
    * 
-   * - **Failed**: The task failed.
+   * - **Failed**: Refresh failed.
    * 
    * @example
    * Complete
@@ -63,9 +63,9 @@ export class DescribePurgeTasksResponseBodyTasks extends $dara.Model {
    * - **file** (default): file refresh.
    * - **cachetag**: cache tag refresh.
    * - **directory**: directory refresh.
-   * - **ignoreParams**: parameter-stripped refresh.
+   * - **ignoreParams**: ignore parameters refresh.
    * - **hostname**: hostname refresh.
-   * - **purgeall**: refresh all cached content of the site.
+   * - **purgeall**: purge all cache under the site.
    * 
    * @example
    * file

package/src/models/DescribeRatePlanPriceGapRequest.ts

@@ -23,12 +23,10 @@ export class DescribeRatePlanPriceGapRequest extends $dara.Model {
   orderType?: string;
   /**
    * @remarks
-   * The specification change type. Valid values:
-   * - DOWNGRADE: downgrade.
-   * - UPGRADE: upgrade.
+   * The code of the target plan for the specification change.
    * 
    * @example
-   * UPGRADE
+   * standardplan
    */
   targetPlanCode?: string;
   /**

package/src/models/DescribeRatePlanPriceGapResponseBody.ts

@@ -68,7 +68,7 @@ export class DescribeRatePlanPriceGapResponseBodyPriceModel extends $dara.Model
   currency?: string;
   /**
    * @remarks
-   * The order discount amount.
+   * The discount amount of the order.
    * 
    * @example
    * 1

package/src/models/DescribeSiteWafTimeSeriesDataRequest.ts

@@ -0,0 +1,128 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeSiteWafTimeSeriesDataRequestFields extends $dara.Model {
+  /**
+   * @remarks
+   * The query dimension.
+   */
+  dimension?: string[];
+  /**
+   * @remarks
+   * The metric name.
+   * 
+   * >For more information about the available dimensions, see [Data analytics field description](https://help.aliyun.com/document_detail/2878520.html).
+   * 
+   * @example
+   * Traffic
+   */
+  fieldName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      dimension: 'Dimension',
+      fieldName: 'FieldName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      dimension: { 'type': 'array', 'itemType': 'string' },
+      fieldName: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.dimension)) {
+      $dara.Model.validateArray(this.dimension);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeSiteWafTimeSeriesDataRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The end of the time range to query.
+   * 
+   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
+   * 
+   * > The end time must be later than the start time.
+   * 
+   * @example
+   * 2023-04-09T16:00:00Z
+   */
+  endTime?: string;
+  /**
+   * @remarks
+   * The query metrics.
+   * 
+   * This parameter is required.
+   */
+  fields?: DescribeSiteWafTimeSeriesDataRequestFields[];
+  /**
+   * @remarks
+   * The time granularity of the queried data. Unit: seconds.
+   * 
+   * Based on the maximum time span of a single query, this parameter supports the values 60 (1 minute), 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see the **supported time granularity** section above.
+   * 
+   * @example
+   * 300
+   */
+  interval?: string;
+  /**
+   * @remarks
+   * The site ID. You can call the [ListSites](~~ListSites~~) operation to obtain the site ID.
+   * 
+   * If this parameter is left empty, user-level data is queried.
+   * 
+   * @example
+   * 11089268296****
+   */
+  siteId?: string;
+  /**
+   * @remarks
+   * The beginning of the time range to query.
+   * 
+   * Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0.
+   * 
+   * @example
+   * 2023-04-08T16:00:00Z
+   */
+  startTime?: string;
+  static names(): { [key: string]: string } {
+    return {
+      endTime: 'EndTime',
+      fields: 'Fields',
+      interval: 'Interval',
+      siteId: 'SiteId',
+      startTime: 'StartTime',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      endTime: 'string',
+      fields: { 'type': 'array', 'itemType': DescribeSiteWafTimeSeriesDataRequestFields },
+      interval: 'string',
+      siteId: 'string',
+      startTime: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.fields)) {
+      $dara.Model.validateArray(this.fields);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeSiteWafTimeSeriesDataResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeSiteWafTimeSeriesDataResponseBody } from "./DescribeSiteWafTimeSeriesDataResponseBody";
+
+
+export class DescribeSiteWafTimeSeriesDataResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeSiteWafTimeSeriesDataResponseBody;
+  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: DescribeSiteWafTimeSeriesDataResponseBody,
+    };
+  }
+
+  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);
+  }
+}
+