@alicloud/ddosbgp20180720 2.7.2 → 3.0.0

package/src/models/ListPolicyResponseBody.ts

@@ -0,0 +1,886 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListPolicyResponseBodyPolicyListContentFingerPrintRuleList extends $dara.Model {
+  /**
+   * @remarks
+   * The end of the destination port range. Valid values: **0** to **65535**.
+   * 
+   * @example
+   * 65535
+   */
+  dstPortEnd?: number;
+  /**
+   * @remarks
+   * The start of the destination port range. Valid values: **0** to **65535**.
+   * 
+   * @example
+   * 0
+   */
+  dstPortStart?: number;
+  /**
+   * @remarks
+   * The ID of the rule.
+   * 
+   * @example
+   * 2c0b09cd-a565-4481-9acb-418b********
+   */
+  id?: string;
+  /**
+   * @remarks
+   * The action triggered if the rule is matched. Valid values:
+   * 
+   * *   **accept**: allows the traffic that matches the conditions in the byte-match filter rule.
+   * *   **drop**: discards the traffic that matches the conditions in the byte-match filter rule.
+   * *   **ip_rate**: limits rates on the source IP address whose traffic matches the conditions in the byte-match filter rule. The rate limit is specified by **RateValue**.
+   * *   **session_rate**: limits the number of sessions from the source IP address whose traffic matches the conditions in the byte-match filter rule. The rate limit is specified by **RateValue**.
+   * 
+   * @example
+   * drop
+   */
+  matchAction?: string;
+  /**
+   * @remarks
+   * The maximum packet length. Valid values: **1** to **1500**.
+   * 
+   * @example
+   * 1500
+   */
+  maxPktLen?: number;
+  /**
+   * @remarks
+   * The minimum packet length. Valid values: **1** to **1500**.
+   * 
+   * @example
+   * 1
+   */
+  minPktLen?: number;
+  /**
+   * @remarks
+   * The offset. Valid values: **0** to **1500**.
+   * 
+   * @example
+   * 0
+   */
+  offset?: number;
+  /**
+   * @remarks
+   * The payload. The value is a hexadecimal string.
+   * 
+   * @example
+   * abcd
+   */
+  payloadBytes?: string;
+  /**
+   * @remarks
+   * The protocol type. Valid values:
+   * 
+   * *   **tcp**
+   * *   **udp**
+   * 
+   * @example
+   * udp
+   */
+  protocol?: string;
+  /**
+   * @remarks
+   * The rate limit. Valid values: **1** to **100000**.
+   * 
+   * >  This parameter is required when **MatchAction** is set to **ip_rate** or **session_rate**.
+   * 
+   * @example
+   * 1000
+   */
+  rateValue?: number;
+  /**
+   * @remarks
+   * The sequence number that indicates the order for the rule to take effect. The value is an integer.
+   * 
+   * @example
+   * 1
+   */
+  seqNo?: number;
+  /**
+   * @remarks
+   * The end of the source port range. Valid values: **0** to **65535**.
+   * 
+   * @example
+   * 65535
+   */
+  srcPortEnd?: number;
+  /**
+   * @remarks
+   * The start of the source port range. Valid values: **0** to **65535**.
+   * 
+   * @example
+   * 0
+   */
+  srcPortStart?: number;
+  static names(): { [key: string]: string } {
+    return {
+      dstPortEnd: 'DstPortEnd',
+      dstPortStart: 'DstPortStart',
+      id: 'Id',
+      matchAction: 'MatchAction',
+      maxPktLen: 'MaxPktLen',
+      minPktLen: 'MinPktLen',
+      offset: 'Offset',
+      payloadBytes: 'PayloadBytes',
+      protocol: 'Protocol',
+      rateValue: 'RateValue',
+      seqNo: 'SeqNo',
+      srcPortEnd: 'SrcPortEnd',
+      srcPortStart: 'SrcPortStart',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      dstPortEnd: 'number',
+      dstPortStart: 'number',
+      id: 'string',
+      matchAction: 'string',
+      maxPktLen: 'number',
+      minPktLen: 'number',
+      offset: 'number',
+      payloadBytes: 'string',
+      protocol: 'string',
+      rateValue: 'number',
+      seqNo: 'number',
+      srcPortEnd: 'number',
+      srcPortStart: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListPolicyResponseBodyPolicyListContentL4RuleListConditionListOffset extends $dara.Model {
+  end?: number;
+  start?: number;
+  static names(): { [key: string]: string } {
+    return {
+      end: 'End',
+      start: 'Start',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      end: 'number',
+      start: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListPolicyResponseBodyPolicyListContentL4RuleListConditionList extends $dara.Model {
+  /**
+   * @remarks
+   * The term that is used for matching.
+   * 
+   * >  If Method is set to **char**, the value of this parameter must be ASCII strings. If Method is set to **hex**, the value of this parameter must be hexadecimal strings. Maximum length: 2,048.
+   * 
+   * @example
+   * test
+   */
+  arg?: string;
+  content?: string;
+  /**
+   * @remarks
+   * The number of bytes from the start position for matching. Valid values: **1** to **2048**.
+   * 
+   * @example
+   * 32
+   */
+  depth?: number;
+  encode?: string;
+  offset?: ListPolicyResponseBodyPolicyListContentL4RuleListConditionListOffset;
+  pattern?: string;
+  /**
+   * @remarks
+   * The start position for matching. Valid values: **0** to **2047**.
+   * 
+   * @example
+   * 0
+   */
+  position?: number;
+  static names(): { [key: string]: string } {
+    return {
+      arg: 'Arg',
+      content: 'Content',
+      depth: 'Depth',
+      encode: 'Encode',
+      offset: 'Offset',
+      pattern: 'Pattern',
+      position: 'Position',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      arg: 'string',
+      content: 'string',
+      depth: 'number',
+      encode: 'string',
+      offset: ListPolicyResponseBodyPolicyListContentL4RuleListConditionListOffset,
+      pattern: 'string',
+      position: 'number',
+    };
+  }
+
+  validate() {
+    if(this.offset && typeof (this.offset as any).validate === 'function') {
+      (this.offset as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListPolicyResponseBodyPolicyListContentL4RuleList extends $dara.Model {
+  /**
+   * @remarks
+   * The action that is specified in the rule. Valid value:
+   * 
+   * *   **2**: The traffic is discarded.
+   * 
+   * @example
+   * 2
+   */
+  action?: string;
+  /**
+   * @remarks
+   * The match conditions.
+   */
+  conditionList?: ListPolicyResponseBodyPolicyListContentL4RuleListConditionList[];
+  /**
+   * @remarks
+   * The minimum number of bytes in a session to trigger matching. Valid values: **0** to **2048**.
+   * 
+   * @example
+   * 0
+   */
+  limited?: number;
+  /**
+   * @remarks
+   * The condition based on which an action is performed. Valid values:
+   * 
+   * *   **0**: If the rule is matched, the action specified in the rule is performed.
+   * *   **1**: If the rule is not matched, the action specified in the rule is performed.
+   * 
+   * @example
+   * 1
+   */
+  match?: string;
+  /**
+   * @remarks
+   * The type of the rule. Valid values:
+   * 
+   * *   **char**: string match.
+   * *   **hex**: hexadecimal string match.
+   * 
+   * @example
+   * char
+   */
+  method?: string;
+  /**
+   * @remarks
+   * The name of the rule.
+   * 
+   * @example
+   * test**
+   */
+  name?: string;
+  /**
+   * @remarks
+   * The priority of the rule.
+   * 
+   * @example
+   * 1
+   */
+  priority?: number;
+  static names(): { [key: string]: string } {
+    return {
+      action: 'Action',
+      conditionList: 'ConditionList',
+      limited: 'Limited',
+      match: 'Match',
+      method: 'Method',
+      name: 'Name',
+      priority: 'Priority',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      action: 'string',
+      conditionList: { 'type': 'array', 'itemType': ListPolicyResponseBodyPolicyListContentL4RuleListConditionList },
+      limited: 'number',
+      match: 'string',
+      method: 'string',
+      name: 'string',
+      priority: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.conditionList)) {
+      $dara.Model.validateArray(this.conditionList);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListPolicyResponseBodyPolicyListContentPortRuleList extends $dara.Model {
+  /**
+   * @remarks
+   * The end of the destination port range. Valid values: **0** to **65535**.
+   * 
+   * @example
+   * 65535
+   */
+  dstPortEnd?: number;
+  /**
+   * @remarks
+   * The start of the destination port range. Valid values: **0** to **65535**.
+   * 
+   * @example
+   * 0
+   */
+  dstPortStart?: number;
+  /**
+   * @remarks
+   * The ID of the rule.
+   * 
+   * @example
+   * 8f3c3062-6c20-425d-8405-2bd1********
+   */
+  id?: string;
+  /**
+   * @remarks
+   * The action triggered if the rule is matched. Valid value:
+   * 
+   * *   **drop**: The traffic is discarded.
+   * 
+   * @example
+   * drop
+   */
+  matchAction?: string;
+  /**
+   * @remarks
+   * The protocol type. Valid values:
+   * 
+   * *   **tcp**
+   * *   **udp**
+   * 
+   * @example
+   * udp
+   */
+  protocol?: string;
+  /**
+   * @remarks
+   * The sequence number that indicates the order for the rule to take effect. The value is an integer.
+   * 
+   * @example
+   * 1
+   */
+  seqNo?: number;
+  /**
+   * @remarks
+   * The end of the source port range. Valid values: **0** to **65535**.
+   * 
+   * @example
+   * 65535
+   */
+  srcPortEnd?: number;
+  /**
+   * @remarks
+   * The start of the source port range. Valid values: **0** to **65535**.
+   * 
+   * @example
+   * 0
+   */
+  srcPortStart?: number;
+  static names(): { [key: string]: string } {
+    return {
+      dstPortEnd: 'DstPortEnd',
+      dstPortStart: 'DstPortStart',
+      id: 'Id',
+      matchAction: 'MatchAction',
+      protocol: 'Protocol',
+      seqNo: 'SeqNo',
+      srcPortEnd: 'SrcPortEnd',
+      srcPortStart: 'SrcPortStart',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      dstPortEnd: 'number',
+      dstPortStart: 'number',
+      id: 'string',
+      matchAction: 'string',
+      protocol: 'string',
+      seqNo: 'number',
+      srcPortEnd: 'number',
+      srcPortStart: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListPolicyResponseBodyPolicyListContentSourceBlockList extends $dara.Model {
+  /**
+   * @remarks
+   * The validity period of the blacklist to which the source IP address is added. Unit: seconds.
+   * 
+   * @example
+   * 120
+   */
+  blockExpireSeconds?: number;
+  /**
+   * @remarks
+   * The statistical period during which the system collects data on source IP addresses to determine whether to add the source IP addresses to the blacklist. Unit: seconds.
+   * 
+   * @example
+   * 60
+   */
+  everySeconds?: number;
+  /**
+   * @remarks
+   * The number of times that the source IP address exceeds a limit in a statistical period.
+   * 
+   * @example
+   * 5
+   */
+  exceedLimitTimes?: number;
+  /**
+   * @remarks
+   * The type of the source rate limit. Valid values:
+   * 
+   * *   **3**: the PPS limit on source IP addresses.
+   * *   **4**: the bandwidth limit on source IP addresses.
+   * *   **5**: the PPS limit on source SYN packets.
+   * *   **6**: the bandwidth limit on source SYN packets.
+   * 
+   * @example
+   * 3
+   */
+  type?: number;
+  static names(): { [key: string]: string } {
+    return {
+      blockExpireSeconds: 'BlockExpireSeconds',
+      everySeconds: 'EverySeconds',
+      exceedLimitTimes: 'ExceedLimitTimes',
+      type: 'Type',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      blockExpireSeconds: 'number',
+      everySeconds: 'number',
+      exceedLimitTimes: 'number',
+      type: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListPolicyResponseBodyPolicyListContentSourceLimit extends $dara.Model {
+  /**
+   * @remarks
+   * The bandwidth limit on source IP addresses. Unit: bytes per second.
+   * 
+   * @example
+   * 2048
+   */
+  bps?: number;
+  /**
+   * @remarks
+   * The packets per second (PPS) limit on source IP addresses.
+   * 
+   * @example
+   * 64
+   */
+  pps?: number;
+  /**
+   * @remarks
+   * The bandwidth limit on source SYN packets. Unit: bytes per second.
+   * 
+   * @example
+   * 2048
+   */
+  synBps?: number;
+  /**
+   * @remarks
+   * The PPS limit on source SYN packets.
+   * 
+   * @example
+   * 64
+   */
+  synPps?: number;
+  static names(): { [key: string]: string } {
+    return {
+      bps: 'Bps',
+      pps: 'Pps',
+      synBps: 'SynBps',
+      synPps: 'SynPps',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bps: 'number',
+      pps: 'number',
+      synBps: 'number',
+      synPps: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListPolicyResponseBodyPolicyListContent extends $dara.Model {
+  /**
+   * @remarks
+   * The validity period of the IP address blacklist. The value is a UNIX timestamp.
+   * 
+   * @example
+   * 1716878000
+   */
+  blackIpListExpireAt?: number;
+  /**
+   * @remarks
+   * Indicates whether ICMP blocking is enabled.
+   * 
+   * @example
+   * false
+   */
+  enableDropIcmp?: boolean;
+  /**
+   * @remarks
+   * Indicates whether intelligent protection is enabled.
+   * 
+   * @example
+   * true
+   */
+  enableIntelligence?: boolean;
+  /**
+   * @remarks
+   * Indicates whether port-specific mitigation is enabled.
+   * 
+   * @example
+   * true
+   */
+  enableL4Defense?: boolean;
+  /**
+   * @remarks
+   * The byte-match filter rules.
+   */
+  fingerPrintRuleList?: ListPolicyResponseBodyPolicyListContentFingerPrintRuleList[];
+  /**
+   * @remarks
+   * The level of intelligent protection. Valid values:
+   * 
+   * *   **default**: normal.
+   * *   **hard**: strict.
+   * *   **weak**: loose.
+   * 
+   * @example
+   * default
+   */
+  intelligenceLevel?: string;
+  /**
+   * @remarks
+   * The port-specific mitigation rules.
+   */
+  l4RuleList?: ListPolicyResponseBodyPolicyListContentL4RuleList[];
+  /**
+   * @remarks
+   * The port blocking rules.
+   */
+  portRuleList?: ListPolicyResponseBodyPolicyListContentPortRuleList[];
+  portVersion?: string;
+  /**
+   * @remarks
+   * The ports whose traffic is filtered out by the filtering policies for UDP reflection attacks.
+   */
+  reflectBlockUdpPortList?: number[];
+  /**
+   * @remarks
+   * The countries in the location blacklist.
+   */
+  regionBlockCountryList?: number[];
+  /**
+   * @remarks
+   * The provinces in the location blacklist.
+   */
+  regionBlockProvinceList?: number[];
+  /**
+   * @remarks
+   * The source IP addresses that are added to the blacklist.
+   */
+  sourceBlockList?: ListPolicyResponseBodyPolicyListContentSourceBlockList[];
+  /**
+   * @remarks
+   * The settings for source rate limiting.
+   */
+  sourceLimit?: ListPolicyResponseBodyPolicyListContentSourceLimit;
+  /**
+   * @remarks
+   * Indicates whether back-to-origin CIDR blocks of Anti-DDoS Proxy are added to the whitelist.
+   * 
+   * @example
+   * false
+   */
+  whitenGfbrNets?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      blackIpListExpireAt: 'BlackIpListExpireAt',
+      enableDropIcmp: 'EnableDropIcmp',
+      enableIntelligence: 'EnableIntelligence',
+      enableL4Defense: 'EnableL4Defense',
+      fingerPrintRuleList: 'FingerPrintRuleList',
+      intelligenceLevel: 'IntelligenceLevel',
+      l4RuleList: 'L4RuleList',
+      portRuleList: 'PortRuleList',
+      portVersion: 'PortVersion',
+      reflectBlockUdpPortList: 'ReflectBlockUdpPortList',
+      regionBlockCountryList: 'RegionBlockCountryList',
+      regionBlockProvinceList: 'RegionBlockProvinceList',
+      sourceBlockList: 'SourceBlockList',
+      sourceLimit: 'SourceLimit',
+      whitenGfbrNets: 'WhitenGfbrNets',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      blackIpListExpireAt: 'number',
+      enableDropIcmp: 'boolean',
+      enableIntelligence: 'boolean',
+      enableL4Defense: 'boolean',
+      fingerPrintRuleList: { 'type': 'array', 'itemType': ListPolicyResponseBodyPolicyListContentFingerPrintRuleList },
+      intelligenceLevel: 'string',
+      l4RuleList: { 'type': 'array', 'itemType': ListPolicyResponseBodyPolicyListContentL4RuleList },
+      portRuleList: { 'type': 'array', 'itemType': ListPolicyResponseBodyPolicyListContentPortRuleList },
+      portVersion: 'string',
+      reflectBlockUdpPortList: { 'type': 'array', 'itemType': 'number' },
+      regionBlockCountryList: { 'type': 'array', 'itemType': 'number' },
+      regionBlockProvinceList: { 'type': 'array', 'itemType': 'number' },
+      sourceBlockList: { 'type': 'array', 'itemType': ListPolicyResponseBodyPolicyListContentSourceBlockList },
+      sourceLimit: ListPolicyResponseBodyPolicyListContentSourceLimit,
+      whitenGfbrNets: 'boolean',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.fingerPrintRuleList)) {
+      $dara.Model.validateArray(this.fingerPrintRuleList);
+    }
+    if(Array.isArray(this.l4RuleList)) {
+      $dara.Model.validateArray(this.l4RuleList);
+    }
+    if(Array.isArray(this.portRuleList)) {
+      $dara.Model.validateArray(this.portRuleList);
+    }
+    if(Array.isArray(this.reflectBlockUdpPortList)) {
+      $dara.Model.validateArray(this.reflectBlockUdpPortList);
+    }
+    if(Array.isArray(this.regionBlockCountryList)) {
+      $dara.Model.validateArray(this.regionBlockCountryList);
+    }
+    if(Array.isArray(this.regionBlockProvinceList)) {
+      $dara.Model.validateArray(this.regionBlockProvinceList);
+    }
+    if(Array.isArray(this.sourceBlockList)) {
+      $dara.Model.validateArray(this.sourceBlockList);
+    }
+    if(this.sourceLimit && typeof (this.sourceLimit as any).validate === 'function') {
+      (this.sourceLimit as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListPolicyResponseBodyPolicyList extends $dara.Model {
+  /**
+   * @remarks
+   * The number of protected objects that are added to the policy.
+   * 
+   * @example
+   * 0
+   */
+  attachedCount?: number;
+  /**
+   * @remarks
+   * The content of the policy.
+   */
+  content?: ListPolicyResponseBodyPolicyListContent;
+  /**
+   * @remarks
+   * The ID of the policy.
+   * 
+   * @example
+   * 877afbdf-3982-4d36-9886-f043********
+   */
+  id?: string;
+  /**
+   * @remarks
+   * The name of the policy.
+   * 
+   * @example
+   * test**
+   */
+  name?: string;
+  /**
+   * @remarks
+   * The remarks of the policy.
+   * 
+   * @example
+   * test
+   */
+  remark?: string;
+  /**
+   * @remarks
+   * The type of the policy. Valid values:
+   * 
+   * *   **default**: the default mitigation policy.
+   * *   **l3**: IP-specific mitigation policies.
+   * *   **l4**: port-specific mitigation policies.
+   * 
+   * @example
+   * l3
+   */
+  type?: string;
+  static names(): { [key: string]: string } {
+    return {
+      attachedCount: 'AttachedCount',
+      content: 'Content',
+      id: 'Id',
+      name: 'Name',
+      remark: 'Remark',
+      type: 'Type',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      attachedCount: 'number',
+      content: ListPolicyResponseBodyPolicyListContent,
+      id: 'string',
+      name: 'string',
+      remark: 'string',
+      type: 'string',
+    };
+  }
+
+  validate() {
+    if(this.content && typeof (this.content as any).validate === 'function') {
+      (this.content as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListPolicyResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The policies.
+   */
+  policyList?: ListPolicyResponseBodyPolicyList[];
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * B4B379C2-9319-4C6B-B579-FE36831B09F4
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of policies.
+   * 
+   * @example
+   * 10
+   */
+  total?: number;
+  static names(): { [key: string]: string } {
+    return {
+      policyList: 'PolicyList',
+      requestId: 'RequestId',
+      total: 'Total',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      policyList: { 'type': 'array', 'itemType': ListPolicyResponseBodyPolicyList },
+      requestId: 'string',
+      total: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.policyList)) {
+      $dara.Model.validateArray(this.policyList);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+