@alicloud/ddosbgp20180720 2.7.2 → 3.1.0

package/src/models/DescribeRegionsResponseBody.ts

@@ -0,0 +1,116 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeRegionsResponseBodyRegions extends $dara.Model {
+  /**
+   * @remarks
+   * The English name of the region.
+   * 
+   * @example
+   * China (Hangzhou)
+   */
+  regionEnName?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The Chinese name of the region.
+   * 
+   * @example
+   * 华东1（杭州）
+   */
+  regionName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      regionEnName: 'RegionEnName',
+      regionId: 'RegionId',
+      regionName: 'RegionName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      regionEnName: 'string',
+      regionId: 'string',
+      regionName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeRegionsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The HTTP status code.
+   * 
+   * @example
+   * 200
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The region information of cloud assets that can be protected by Anti-DDoS Origin, including region IDs and names.
+   */
+  regions?: DescribeRegionsResponseBodyRegions[];
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * F7CA8B4E-FB15-4336-A351-8DC29D66EA82
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the call was successful. Valid values:
+   * - **true**: The call was successful.
+   * - **false**: The call failed.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      regions: 'Regions',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      regions: { 'type': 'array', 'itemType': DescribeRegionsResponseBodyRegions },
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.regions)) {
+      $dara.Model.validateArray(this.regions);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeTrafficRequest.ts

@@ -0,0 +1,132 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeTrafficRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The end time of the query. Specify a UNIX timestamp. Unit: seconds.
+   * 
+   * If you do not set this parameter, the current time is used as the end time.
+   * 
+   * @example
+   * 1563445054
+   */
+  endTime?: number;
+  /**
+   * @remarks
+   * The type of traffic statistics to query. Valid values:
+   * 
+   * - **max**: the peak traffic within the statistical interval.
+   * - **avg**: the average traffic within the statistical interval.
+   * 
+   * @example
+   * max
+   */
+  flowType?: string;
+  /**
+   * @remarks
+   * The ID of the Anti-DDoS Origin instance to query.
+   * 
+   * > You can call [DescribeInstanceList](https://help.aliyun.com/document_detail/118698.html) to query the IDs of all Anti-DDoS Origin instances.
+   * 
+   * 
+   * If the instance specified here is used for traffic diversion, you must set the **Interval** request parameter.
+   * 
+   * @example
+   * ddosbgp-cn-n6w203qg****
+   */
+  instanceId?: string;
+  /**
+   * @remarks
+   * The time interval for traffic statistics. Unit: seconds. This parameter specifies the length of each interval for which traffic data is aggregated. Default value: **5**.
+   * 
+   * @example
+   * 5
+   */
+  interval?: number;
+  /**
+   * @remarks
+   * The assets that are assigned public IP addresses to query. If you do not specify this parameter in Settings, the traffic statistics of all assets that are assigned public IP addresses protected by the Anti-DDoS Origin instance are queried.
+   * 
+   * > The assets that are assigned public IP addresses must have been added as protected objects of the Anti-DDoS Origin instance. You can invoke [DescribePackIpList](https://help.aliyun.com/document_detail/118701.html) to query all protected objects of the Anti-DDoS Origin instance.
+   * 
+   * @example
+   * 39.XX.XX.96
+   */
+  ip?: string;
+  /**
+   * @remarks
+   * The CIDR block used for traffic diversion to query.
+   * 
+   * @example
+   * 111.XX.XX.0/24
+   */
+  ipnet?: string;
+  /**
+   * @remarks
+   * The region ID of the Anti-DDoS Origin instance.
+   * 
+   * > You can call [DescribeRegions](https://help.aliyun.com/document_detail/118703.html) to query all region IDs supported by Anti-DDoS Origin.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The ID of the resource group to which the Anti-DDoS Origin instance belongs in Resource Management.
+   * 
+   * If you do not set this parameter, the default resource group is used.
+   * 
+   * @example
+   * rg-acfm2pz25js****
+   */
+  resourceGroupId?: string;
+  /**
+   * @remarks
+   * The start time of the query. Specify a UNIX timestamp. Unit: seconds.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 1619798400
+   */
+  startTime?: number;
+  static names(): { [key: string]: string } {
+    return {
+      endTime: 'EndTime',
+      flowType: 'FlowType',
+      instanceId: 'InstanceId',
+      interval: 'Interval',
+      ip: 'Ip',
+      ipnet: 'Ipnet',
+      regionId: 'RegionId',
+      resourceGroupId: 'ResourceGroupId',
+      startTime: 'StartTime',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      endTime: 'number',
+      flowType: 'string',
+      instanceId: 'string',
+      interval: 'number',
+      ip: 'string',
+      ipnet: 'string',
+      regionId: 'string',
+      resourceGroupId: 'string',
+      startTime: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeTrafficResponse.ts

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

@@ -0,0 +1,140 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeTrafficResponseBodyFlowList extends $dara.Model {
+  /**
+   * @remarks
+   * The bandwidth of attack traffic. Unit: bps.
+   * 
+   * > This field is returned only when attack traffic exists.
+   * 
+   * @example
+   * 0
+   */
+  attackBps?: number;
+  /**
+   * @remarks
+   * The packet forwarding rate of attack traffic. Unit: pps.
+   * > This field is returned only when attack traffic exists.
+   * 
+   * @example
+   * 0
+   */
+  attackPps?: number;
+  /**
+   * @remarks
+   * The type of the traffic statistics. Valid values:
+   * 
+   * - **max**: the peak traffic within the statistical interval.
+   * - **avg**: the average traffic within the statistical interval.
+   * 
+   * @example
+   * max
+   */
+  flowType?: string;
+  /**
+   * @remarks
+   * The bandwidth of total traffic. Unit: Kbps.
+   * 
+   * @example
+   * 417
+   */
+  kbps?: number;
+  /**
+   * @remarks
+   * The ID of the traffic statistics entry.
+   * 
+   * @example
+   * 8e33f19e-5644-11eb-b5c1-d89d67182200
+   */
+  name?: string;
+  /**
+   * @remarks
+   * The packet forwarding rate of total traffic. Unit: pps.
+   * 
+   * @example
+   * 274
+   */
+  pps?: number;
+  /**
+   * @remarks
+   * The time of the traffic statistics. Expressed as a UNIX timestamp. Unit: seconds.
+   * 
+   * @example
+   * 1620951900
+   */
+  time?: number;
+  static names(): { [key: string]: string } {
+    return {
+      attackBps: 'AttackBps',
+      attackPps: 'AttackPps',
+      flowType: 'FlowType',
+      kbps: 'Kbps',
+      name: 'Name',
+      pps: 'Pps',
+      time: 'Time',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      attackBps: 'number',
+      attackPps: 'number',
+      flowType: 'string',
+      kbps: 'number',
+      name: 'string',
+      pps: 'number',
+      time: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeTrafficResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The traffic statistics.
+   */
+  flowList?: DescribeTrafficResponseBodyFlowList[];
+  /**
+   * @remarks
+   * The ID of the request.
+   * 
+   * @example
+   * 6A507DC8-F657-4C13-84E2-D1D1B9400753
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      flowList: 'FlowList',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      flowList: { 'type': 'array', 'itemType': DescribeTrafficResponseBodyFlowList },
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.flowList)) {
+      $dara.Model.validateArray(this.flowList);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DetachFromPolicyRequest.ts

@@ -0,0 +1,131 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DetachFromPolicyRequestIpPortProtocolList extends $dara.Model {
+  /**
+   * @remarks
+   * The IP address of the protected object.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 47.118.172.***
+   */
+  ip?: string;
+  /**
+   * @remarks
+   * The port of the protected object.
+   * 
+   * @example
+   * 8*
+   */
+  port?: number;
+  /**
+   * @remarks
+   * The port range of the protected object.
+   * > Only port-specific mitigation policies support this parameter.
+   * 
+   * @example
+   * 8*-9*
+   */
+  portRange?: string;
+  /**
+   * @remarks
+   * The protocol type of the protected object. Valid values:
+   * 
+   * - **tcp**: Transmission Control Protocol.
+   * - **udp**: User Datagram Protocol.
+   * 
+   * @example
+   * tcp
+   */
+  protocol?: string;
+  static names(): { [key: string]: string } {
+    return {
+      ip: 'Ip',
+      port: 'Port',
+      portRange: 'PortRange',
+      protocol: 'Protocol',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ip: 'string',
+      port: 'number',
+      portRange: 'string',
+      protocol: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DetachFromPolicyRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The list of protected objects.
+   * 
+   * This parameter is required.
+   */
+  ipPortProtocolList?: DetachFromPolicyRequestIpPortProtocolList[];
+  /**
+   * @remarks
+   * The policy type. Valid values:
+   * - **default**: default mitigation policy.
+   * - **l3**: IP-specific mitigation policy.
+   * - **l4**: port-specific mitigation policy.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * l3
+   */
+  policyType?: string;
+  /**
+   * @remarks
+   * The version of the port-specific mitigation policy. Valid values:
+   * 
+   * - **Not specified**: dissociates the default surf anti-DDoS engine policy.
+   * - **2**: dissociates the new stream anti-DDoS engine policy.
+   * > Only port-specific mitigation policies support this parameter.
+   * 
+   * @example
+   * 2
+   */
+  portVersion?: string;
+  static names(): { [key: string]: string } {
+    return {
+      ipPortProtocolList: 'IpPortProtocolList',
+      policyType: 'PolicyType',
+      portVersion: 'PortVersion',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ipPortProtocolList: { 'type': 'array', 'itemType': DetachFromPolicyRequestIpPortProtocolList },
+      policyType: 'string',
+      portVersion: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.ipPortProtocolList)) {
+      $dara.Model.validateArray(this.ipPortProtocolList);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DetachFromPolicyResponse.ts

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

@@ -0,0 +1,34 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DetachFromPolicyResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The request ID. Alibaba Cloud generates a unique identifier for each request. You can use this ID to troubleshoot issues.
+   * 
+   * @example
+   * 1B0F7EC6-51D7-4D70-B0EC-CD8A9E99****
+   */
+  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/DetachFromPolicyShrinkRequest.ts

@@ -0,0 +1,62 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DetachFromPolicyShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The list of protected objects.
+   * 
+   * This parameter is required.
+   */
+  ipPortProtocolListShrink?: string;
+  /**
+   * @remarks
+   * The policy type. Valid values:
+   * - **default**: default mitigation policy.
+   * - **l3**: IP-specific mitigation policy.
+   * - **l4**: port-specific mitigation policy.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * l3
+   */
+  policyType?: string;
+  /**
+   * @remarks
+   * The version of the port-specific mitigation policy. Valid values:
+   * 
+   * - **Not specified**: dissociates the default surf anti-DDoS engine policy.
+   * - **2**: dissociates the new stream anti-DDoS engine policy.
+   * > Only port-specific mitigation policies support this parameter.
+   * 
+   * @example
+   * 2
+   */
+  portVersion?: string;
+  static names(): { [key: string]: string } {
+    return {
+      ipPortProtocolListShrink: 'IpPortProtocolList',
+      policyType: 'PolicyType',
+      portVersion: 'PortVersion',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ipPortProtocolListShrink: 'string',
+      policyType: 'string',
+      portVersion: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+