@alicloud/waf-openapi20211001 4.1.0 → 4.1.2

package/src/models/DescribeApisecStatisticsRequest.ts

@@ -0,0 +1,87 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeApisecStatisticsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the hybrid cloud cluster.
+   * 
+   * >  This parameter is available only in hybrid cloud scenarios. You can call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query hybrid cloud clusters.
+   * 
+   * @example
+   * 428
+   */
+  clusterId?: string;
+  /**
+   * @remarks
+   * The region in which the Web Application Firewall (WAF) instance is deployed. Valid values:
+   * 
+   * * **cn-hangzhou**: Chinese mainland
+   * * **ap-southeast-1**: outside the Chinese mainland
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * waf_v2_public_cn-uax***b09
+   */
+  instanceId?: string;
+  /**
+   * @remarks
+   * The region ID of the WAF instance. Valid values:
+   * 
+   * *   **cn-hangzhou**: Chinese mainland.
+   * *   **ap-southeast-1**: outside the Chinese mainland.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
+   * @example
+   * rg-aek2***uwbs5q
+   */
+  resourceManagerResourceGroupId?: string;
+  /**
+   * @remarks
+   * The type of the statistics. Valid values:
+   * 
+   * *   **risk**: risk-related statistics.
+   * *   **event**: event-related statistics.
+   * 
+   * @example
+   * asset_num
+   */
+  type?: string;
+  static names(): { [key: string]: string } {
+    return {
+      clusterId: 'ClusterId',
+      instanceId: 'InstanceId',
+      regionId: 'RegionId',
+      resourceManagerResourceGroupId: 'ResourceManagerResourceGroupId',
+      type: 'Type',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      clusterId: 'string',
+      instanceId: 'string',
+      regionId: 'string',
+      resourceManagerResourceGroupId: 'string',
+      type: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeApisecStatisticsResponse.ts

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

@@ -0,0 +1,45 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeApisecStatisticsResponseBodyData } from "./DescribeApisecStatisticsResponseBodyData";
+
+
+export class DescribeApisecStatisticsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned results.
+   */
+  data?: DescribeApisecStatisticsResponseBodyData;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 221F0F14-54C6-59A1-9967-72***81B61A
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: DescribeApisecStatisticsResponseBodyData,
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeApisecStatisticsResponseBodyData.ts

@@ -0,0 +1,184 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeApisecStatisticsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The number of handled events.
+   * 
+   * @example
+   * 1
+   */
+  actioned?: number;
+  /**
+   * @remarks
+   * The number of APIs.
+   * 
+   * @example
+   * /api/v1/login
+   */
+  api?: number;
+  /**
+   * @remarks
+   * The number of confirmed events.
+   * 
+   * @example
+   * 10
+   */
+  confirmed?: number;
+  /**
+   * @remarks
+   * The number of domain names.
+   * 
+   * @example
+   * a.aliyun.com
+   */
+  domain?: number;
+  /**
+   * @remarks
+   * The number of fixed risks.
+   * 
+   * @example
+   * 0
+   */
+  fixed?: number;
+  /**
+   * @remarks
+   * The number of high-risk events.
+   * 
+   * @example
+   * 10
+   */
+  high?: number;
+  /**
+   * @remarks
+   * The number of ignored risks.
+   * 
+   * @example
+   * 0
+   */
+  ignore?: number;
+  /**
+   * @remarks
+   * The number of low-risk events.
+   * 
+   * @example
+   * 10
+   */
+  low?: number;
+  /**
+   * @remarks
+   * The number of moderate-risk events.
+   * 
+   * @example
+   * 10
+   */
+  medium?: number;
+  /**
+   * @remarks
+   * The number of events to be confirmed.
+   * 
+   * @example
+   * 10
+   */
+  toBeConfirmed?: number;
+  /**
+   * @remarks
+   * The number of risks to be fixed.
+   * 
+   * @example
+   * 10
+   */
+  toBeFixed?: number;
+  /**
+   * @remarks
+   * The number of new high-risk events today.
+   * 
+   * @example
+   * 10
+   */
+  todayHigh?: string;
+  /**
+   * @remarks
+   * The number of new low-risk events today.
+   * 
+   * @example
+   * 10
+   */
+  todayLow?: number;
+  /**
+   * @remarks
+   * The number of new moderate-risk events today.
+   * 
+   * @example
+   * 10
+   */
+  todayMedium?: string;
+  /**
+   * @remarks
+   * The total number of new events today.
+   * 
+   * @example
+   * 30
+   */
+  todayTotal?: string;
+  /**
+   * @remarks
+   * The total number of events.
+   * 
+   * @example
+   * 30
+   */
+  total?: number;
+  static names(): { [key: string]: string } {
+    return {
+      actioned: 'Actioned',
+      api: 'Api',
+      confirmed: 'Confirmed',
+      domain: 'Domain',
+      fixed: 'Fixed',
+      high: 'High',
+      ignore: 'Ignore',
+      low: 'Low',
+      medium: 'Medium',
+      toBeConfirmed: 'ToBeConfirmed',
+      toBeFixed: 'ToBeFixed',
+      todayHigh: 'TodayHigh',
+      todayLow: 'TodayLow',
+      todayMedium: 'TodayMedium',
+      todayTotal: 'TodayTotal',
+      total: 'Total',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      actioned: 'number',
+      api: 'number',
+      confirmed: 'number',
+      domain: 'number',
+      fixed: 'number',
+      high: 'number',
+      ignore: 'number',
+      low: 'number',
+      medium: 'number',
+      toBeConfirmed: 'number',
+      toBeFixed: 'number',
+      todayHigh: 'string',
+      todayLow: 'number',
+      todayMedium: 'string',
+      todayTotal: 'string',
+      total: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeApisecSuggestionsRequest.ts

@@ -0,0 +1,84 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeApisecSuggestionsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the API.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * a60fd7e3021fe371c06dc1dcb883def0
+   */
+  apiId?: string;
+  /**
+   * @remarks
+   * The ID of the hybrid cloud cluster.
+   * >For hybrid cloud scenarios only, you can call the [DescribeHybridCloudClusters](https://help.aliyun.com/document_detail/2849376.html) operation to query the hybrid cloud clusters.
+   * 
+   * @example
+   * 428
+   */
+  clusterId?: string;
+  /**
+   * @remarks
+   * The ID of the Web Application Firewall (WAF) instance.
+   * 
+   * >  You can call the [DescribeInstance](https://help.aliyun.com/document_detail/433756.html) operation to query the ID of the WAF instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * waf_v2_public_cn-pe336n43m04
+   */
+  instanceId?: string;
+  /**
+   * @remarks
+   * The region in which the WAF instance is deployed. Valid values:
+   * 
+   * *   **cn-hangzhou**: Chinese mainland
+   * *   **ap-southeast-1**: outside the Chinese mainland
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud resource group.
+   * 
+   * @example
+   * rg-acfm***q
+   */
+  resourceManagerResourceGroupId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      apiId: 'ApiId',
+      clusterId: 'ClusterId',
+      instanceId: 'InstanceId',
+      regionId: 'RegionId',
+      resourceManagerResourceGroupId: 'ResourceManagerResourceGroupId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      apiId: 'string',
+      clusterId: 'string',
+      instanceId: 'string',
+      regionId: 'string',
+      resourceManagerResourceGroupId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeApisecSuggestionsResponse.ts

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

@@ -0,0 +1,45 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeApisecSuggestionsResponseBodyData } from "./DescribeApisecSuggestionsResponseBodyData";
+
+
+export class DescribeApisecSuggestionsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The protection suggestions.
+   */
+  data?: DescribeApisecSuggestionsResponseBodyData[];
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * D7861F61-5B61-46CE-A47C-6B19160D5EB0
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: { 'type': 'array', 'itemType': DescribeApisecSuggestionsResponseBodyData },
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.data)) {
+      $dara.Model.validateArray(this.data);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeApisecSuggestionsResponseBodyData.ts

@@ -0,0 +1,95 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeApisecSuggestionsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The API.
+   * 
+   * @example
+   * /apisec/v1/saveinfo
+   */
+  apiFormat?: string;
+  /**
+   * @remarks
+   * The domain name or IP address of the API.
+   * 
+   * @example
+   * a.aliyun.com
+   */
+  matchedHost?: string;
+  /**
+   * @remarks
+   * The rule ID of the protection suggestion.
+   * 
+   * @example
+   * 15060a1f8fed40130b7c4a7bf8d8733b
+   */
+  suggestId?: string;
+  /**
+   * @remarks
+   * The rule content of the protection suggestion. The value is a string that consists of multiple parameters in the JSON format. Valid values:
+   * 
+   * *   **event_tags**: event type
+   * *   **black_iplist**: IP address blacklist
+   * *   **ip_baseline**: IP address
+   * *   **freq_baseline**: throttling frequency
+   * *   **client_id_baseline**: client information
+   * *   **country_baseline**: country information
+   * *   **province_baseline**: province information
+   * *   **sensitive_type**: sensitive information
+   * 
+   * @example
+   * {
+   *     "rule": "ClientRule",
+   *     "client_id_baseline": ["Edge"]
+   * }
+   */
+  suggestRule?: string;
+  /**
+   * @remarks
+   * The rule type of the protection suggestion. Valid values:
+   * 
+   * *   **BotRule**: bot management rules
+   * *   **BlackIPRule**: IP address blacklist rules
+   * *   **WhiteIPRule**: IP address whitelist rules
+   * *   **RateLimitRule**: throttling rules
+   * *   **ClientRule**: client rules
+   * *   **GeoRule**: region-related rules
+   * *   **SensitiveRule**: sensitive information rules
+   * *   **UnauthRule**: authentication rules
+   * 
+   * @example
+   * WhiteIPRule
+   */
+  suggestType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      apiFormat: 'ApiFormat',
+      matchedHost: 'MatchedHost',
+      suggestId: 'SuggestId',
+      suggestRule: 'SuggestRule',
+      suggestType: 'SuggestType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      apiFormat: 'string',
+      matchedHost: 'string',
+      suggestId: 'string',
+      suggestRule: 'string',
+      suggestType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+