@alicloud/ddosbgp20180720 3.1.1 → 3.1.3

package/src/models/ModifyPolicyRequest.ts

@@ -5,9 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
   /**
    * @remarks
-   * The end value of the destination port range. Valid values: **0** to **65535**.
+   * The rule comment.
    * 
-   * This parameter is required.
+   * @example
+   * comment
+   */
+  comment?: string;
+  /**
+   * @remarks
+   * The end value of the destination port range. Valid values: **0** to **65535**.
    * 
    * @example
    * 65535
@@ -17,8 +23,6 @@ export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
    * @remarks
    * The start value of the destination port range. Valid values: **0** to **65535**.
    * 
-   * This parameter is required.
-   * 
    * @example
    * 0
    */
@@ -35,6 +39,11 @@ export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
    * @remarks
    * The match action. Valid values:
    * 
+   * - **accept**: Allows traffic that matches the fingerprint.
+   * - **drop**: Drops traffic that matches the fingerprint.
+   * - **ip_rate**: Rate-limits the source IP address of traffic that matches the fingerprint. The rate limit value is specified by the **RateValue** parameter.
+   * - **session_rate**: Rate-limits the source session of traffic that matches the fingerprint. The rate limit value is specified by the **RateValue** parameter.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -45,8 +54,6 @@ export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
    * @remarks
    * The maximum packet length. Valid values: **1** to **1500**.
    * 
-   * This parameter is required.
-   * 
    * @example
    * 1500
    */
@@ -55,12 +62,18 @@ export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
    * @remarks
    * The minimum packet length. Valid values: **1** to **1500**.
    * 
-   * This parameter is required.
-   * 
    * @example
    * 1
    */
   minPktLen?: number;
+  /**
+   * @remarks
+   * The rule mode.
+   * 
+   * @example
+   * 1
+   */
+  mode?: number;
   /**
    * @remarks
    * The offset. Valid values: **0** to **1500**.
@@ -71,7 +84,7 @@ export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
   offset?: number;
   /**
    * @remarks
-   * The detection payload. Represented in hexadecimal string format.
+   * The detection payload. The value is in hexadecimal string format.
    * 
    * @example
    * abcd
@@ -81,7 +94,8 @@ export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
    * @remarks
    * The protocol type. Valid values:
    * 
-   * This parameter is required.
+   * - **tcp**: Transmission Control Protocol.
+   * - **udp**: User Datagram Protocol.
    * 
    * @example
    * udp
@@ -91,13 +105,24 @@ export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
    * @remarks
    * The rate limit value. Valid values: **1** to **100000**.
    * 
+   * > This parameter is required when the match action is source IP rate limiting or source session rate limiting (**MatchAction** is **ip_rate** or **session_rate**).
+   * 
    * @example
    * 100
    */
   rateValue?: number;
   /**
    * @remarks
-   * The priority number, represented as an integer.
+   * The rule.
+   * 
+   * @example
+   * (ip.version == 4)
+   */
+  rule?: string;
+  /**
+   * @remarks
+   * The priority, expressed as an integer.
+   * > A smaller value indicates a higher priority.
    * 
    * This parameter is required.
    * 
@@ -109,8 +134,6 @@ export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
    * @remarks
    * The end value of the source port range. Valid values: **0** to **65535**.
    * 
-   * This parameter is required.
-   * 
    * @example
    * 65535
    */
@@ -119,45 +142,59 @@ export class ModifyPolicyRequestContentFingerPrintRuleList extends $dara.Model {
    * @remarks
    * The start value of the source port range. Valid values: **0** to **65535**.
    * 
-   * This parameter is required.
-   * 
    * @example
    * 0
    */
   srcPortStart?: number;
+  /**
+   * @remarks
+   * The type.
+   * 
+   * @example
+   * 1
+   */
+  type?: number;
   static names(): { [key: string]: string } {
     return {
+      comment: 'Comment',
       dstPortEnd: 'DstPortEnd',
       dstPortStart: 'DstPortStart',
       id: 'Id',
       matchAction: 'MatchAction',
       maxPktLen: 'MaxPktLen',
       minPktLen: 'MinPktLen',
+      mode: 'Mode',
       offset: 'Offset',
       payloadBytes: 'PayloadBytes',
       protocol: 'Protocol',
       rateValue: 'RateValue',
+      rule: 'Rule',
       seqNo: 'SeqNo',
       srcPortEnd: 'SrcPortEnd',
       srcPortStart: 'SrcPortStart',
+      type: 'Type',
     };
   }
 
   static types(): { [key: string]: any } {
     return {
+      comment: 'string',
       dstPortEnd: 'number',
       dstPortStart: 'number',
       id: 'string',
       matchAction: 'string',
       maxPktLen: 'number',
       minPktLen: 'number',
+      mode: 'number',
       offset: 'number',
       payloadBytes: 'string',
       protocol: 'string',
       rateValue: 'number',
+      rule: 'string',
       seqNo: 'number',
       srcPortEnd: 'number',
       srcPortStart: 'number',
+      type: 'number',
     };
   }
 
@@ -175,6 +212,8 @@ export class ModifyPolicyRequestContentL4RuleListConditionListOffset extends $da
    * @remarks
    * The end position. Valid values: **0** to **1499**.
    * 
+   * > The end position must be greater than or equal to the start position.
+   * 
    * @example
    * 1499
    */
@@ -214,6 +253,7 @@ export class ModifyPolicyRequestContentL4RuleListConditionList extends $dara.Mod
   /**
    * @remarks
    * The detection content.
+   * > If the rule type is **char**, the value must be an ASCII string. If the rule type is **hex**, the value must be a hexadecimal string. Maximum length: 2048.
    * 
    * @example
    * abcd
@@ -223,6 +263,22 @@ export class ModifyPolicyRequestContentL4RuleListConditionList extends $dara.Mod
    * @remarks
    * The matching content.
    * 
+   * 1. When **Encode** is set to **str**, the value must meet the following requirements:
+   * 
+   * - The length of **Content** does not exceed 1500.
+   * 
+   * - **End** - **Start** >= the length of **Content**.
+   * 
+   * 2. When **Encode** is set to **hex**, the value must meet the following requirements:
+   * 
+   * - **Content** must be hexadecimal characters.
+   * 
+   * - The length of **Content** must be an even number.
+   * 
+   * - The length of **Content** does not exceed 3000.
+   * 
+   * - **End** - **Start** + 1 >= the length of **Content** / 2.
+   * 
    * @example
    * test**
    */
@@ -239,6 +295,10 @@ export class ModifyPolicyRequestContentL4RuleListConditionList extends $dara.Mod
    * @remarks
    * The character type. Valid values:
    * 
+   * - **str**: String.
+   * 
+   * - **hex**: Hexadecimal.
+   * 
    * @example
    * str
    */
@@ -250,7 +310,20 @@ export class ModifyPolicyRequestContentL4RuleListConditionList extends $dara.Mod
   offset?: ModifyPolicyRequestContentL4RuleListConditionListOffset;
   /**
    * @remarks
-   * The matching pattern.
+   * The matching pattern. Valid values depend on the **Encode** field:
+   * 
+   * (1) When **Encode** is set to **str**:
+   * - **contain**: Contains.
+   * 
+   * - **not_contain**: Does not contain.
+   * 
+   * - **regex**: Regular expression.
+   * 
+   * (2) When **Encode** is set to **hex**:
+   * 
+   * - **contain**: Contains.
+   * 
+   * - **not_contain**: Does not contain.
    * 
    * @example
    * contain
@@ -306,7 +379,7 @@ export class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
    * The action.
    * 
    * @example
-   * 2
+   * block
    */
   action?: string;
   /**
@@ -316,7 +389,7 @@ export class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
   conditionList?: ModifyPolicyRequestContentL4RuleListConditionList[];
   /**
    * @remarks
-   * The minimum number of bytes in a session flow that triggers rule matching. Valid values: **0** to **2048**.
+   * The minimum number of bytes in a session flow to trigger rule matching. Valid values: **0** to **2048**.
    * 
    * @example
    * 0
@@ -326,6 +399,10 @@ export class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
    * @remarks
    * The logical operator. Valid values:
    * 
+   * - **0**: Executes the action when the rule is hit.
+   * 
+   * - **1**: Executes the action when the rule is not hit.
+   * 
    * @example
    * 0
    */
@@ -334,6 +411,10 @@ export class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
    * @remarks
    * The rule type. Valid values:
    * 
+   * - **hex**: Hexadecimal matching.
+   * 
+   * - **char**: String matching.
+   * 
    * @example
    * char
    */
@@ -352,6 +433,8 @@ export class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
    * @remarks
    * The rule priority. Valid values: **1** to **100**.
    * 
+   * > A smaller value indicates a higher priority.
+   * 
    * @example
    * 1
    */
@@ -425,6 +508,8 @@ export class ModifyPolicyRequestContentPortRuleList extends $dara.Model {
    * @remarks
    * The match action. Valid values:
    * 
+   * - **drop**: Drop.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -435,6 +520,9 @@ export class ModifyPolicyRequestContentPortRuleList extends $dara.Model {
    * @remarks
    * The protocol type. Valid values:
    * 
+   * - **tcp**: Transmission Control Protocol.
+   * - **udp**: User Datagram Protocol.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -443,7 +531,8 @@ export class ModifyPolicyRequestContentPortRuleList extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * The priority number, represented as an integer.
+   * The priority, expressed as an integer.
+   * > A smaller value indicates a higher priority.
    * 
    * This parameter is required.
    * 
@@ -511,6 +600,9 @@ export class ModifyPolicyRequestContentSipDefense extends $dara.Model {
    * @remarks
    * Specifies whether to enable SIP protection. Valid values:
    * 
+   * - **true**: Enabled.
+   * - **false**: Disabled.
+   * 
    * @example
    * true
    */
@@ -548,7 +640,7 @@ export class ModifyPolicyRequestContentSipDefense extends $dara.Model {
   sipPort?: string;
   /**
    * @remarks
-   * The SIP source rate limit value in PPS.
+   * The SIP source rate limit value (PPS).
    * 
    * @example
    * 1000
@@ -556,7 +648,7 @@ export class ModifyPolicyRequestContentSipDefense extends $dara.Model {
   sipRate?: number;
   /**
    * @remarks
-   * The SIP activation threshold in Mbit/s.
+   * The SIP activation threshold (Mbit/s).
    * 
    * @example
    * 100
@@ -564,7 +656,7 @@ export class ModifyPolicyRequestContentSipDefense extends $dara.Model {
   sipStartMbps?: number;
   /**
    * @remarks
-   * The SIP activation threshold in PPS.
+   * The SIP activation threshold (PPS).
    * 
    * @example
    * 500
@@ -642,6 +734,14 @@ export class ModifyPolicyRequestContentSourceBlockList extends $dara.Model {
    * @remarks
    * The source rate limiting type. Valid values:
    * 
+   * - **3**: source PPS rate limiting.
+   * 
+   * - **4**: source bandwidth throttling.
+   * 
+   * - **5**: source SYN PPS rate limiting.
+   * 
+   * - **6**: source SYN bandwidth throttling.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -678,7 +778,7 @@ export class ModifyPolicyRequestContentSourceBlockList extends $dara.Model {
 export class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
   /**
    * @remarks
-   * The source bandwidth throttling. Unit: Byte/s.
+   * The source bandwidth throttling rate limit, in bytes per second.
    * 
    * @example
    * 2048
@@ -686,7 +786,7 @@ export class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
   bps?: number;
   /**
    * @remarks
-   * The source PPS rate limit. Unit: Packet/s.
+   * The source PPS rate limit, in packets per second.
    * 
    * @example
    * 64
@@ -694,7 +794,7 @@ export class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
   pps?: number;
   /**
    * @remarks
-   * The source SYN bandwidth throttling. Unit: Byte/s.
+   * The source SYN bandwidth throttling rate limit, in bytes per second.
    * 
    * @example
    * 2048
@@ -702,7 +802,7 @@ export class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
   synBps?: number;
   /**
    * @remarks
-   * The source SYN PPS rate limit. Unit: Packet/s.
+   * The source SYN PPS rate limit, in packets per second.
    * 
    * @example
    * 64
@@ -743,7 +843,7 @@ export class ModifyPolicyRequestContent extends $dara.Model {
   blackIpList?: string[];
   /**
    * @remarks
-   * The expiration time of the IP blacklist (UNIX timestamp).
+   * The timeout period of the IP blacklist (UNIX timestamp).
    * 
    * @example
    * 1716878000
@@ -767,7 +867,7 @@ export class ModifyPolicyRequestContent extends $dara.Model {
   enableIntelligence?: boolean;
   /**
    * @remarks
-   * Specifies whether to enable port protection.
+   * Specifies whether to enable port-specific mitigation.
    * 
    * @example
    * true
@@ -775,13 +875,17 @@ export class ModifyPolicyRequestContent extends $dara.Model {
   enableL4Defense?: boolean;
   /**
    * @remarks
-   * The list of byte-match filter rules.
+   * The list of Byte-Match Filter rules.
    */
   fingerPrintRuleList?: ModifyPolicyRequestContentFingerPrintRuleList[];
   /**
    * @remarks
    * The protection level of AI-based intelligent protection. Valid values:
    * 
+   * - **default**: Normal.
+   * - **weak**: Loose.
+   * - **hard**: Strict.
+   * 
    * @example
    * default
    */
@@ -803,17 +907,17 @@ export class ModifyPolicyRequestContent extends $dara.Model {
   reflectBlockUdpPortList?: number[];
   /**
    * @remarks
-   * The list of countries for location blacklist.
+   * The list of countries for the location blacklist.
    */
   regionBlockCountryList?: number[];
   /**
    * @remarks
-   * The list of provinces for location blacklist.
+   * The list of provinces for the location blacklist.
    */
   regionBlockProvinceList?: number[];
   /**
    * @remarks
-   * The SIP protection settings.
+   * The SIP Protection Settings.
    */
   sipDefense?: ModifyPolicyRequestContentSipDefense;
   /**
@@ -833,7 +937,7 @@ export class ModifyPolicyRequestContent extends $dara.Model {
   whiteIpList?: string[];
   /**
    * @remarks
-   * Specifies whether to whitelist the back-to-origin IP addresses of Anti-DDoS Pro and Anti-DDoS Premium (the Chinese mainland & outside the Chinese mainland).
+   * Specifies whether to enable whitelisting of back-to-origin IP addresses for Anti-DDoS Pro and Anti-DDoS Premium (the Chinese mainland and outside the Chinese mainland).
    * 
    * @example
    * false
@@ -928,7 +1032,30 @@ export class ModifyPolicyRequestContent extends $dara.Model {
 export class ModifyPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The action type.
+   * The action type. Valid values:
+   * 
+   * - **10**: modifies the name (Name is required).
+   * - **11**: modifies the blacklist timeout period (BlackIpListExpireAt is required). Only IP-specific mitigation policy is supported.
+   * - **12**: modifies the switch for whitelisting back-to-origin IP addresses of Anti-DDoS Pro and Anti-DDoS Premium (WhitenGfbrNets is required). Only IP-specific mitigation policy is supported.
+   * - **13**: modifies the switch for ICMP Blocking (EnableDropIcmp is required). Only IP-specific mitigation policy is supported.
+   * - **20**: adds entries to blacklists and whitelists (WhiteIpList and BlackIpList are optional). Only IP-specific mitigation policy is supported.
+   * - **21**: deletes entries from blacklists and whitelists (WhiteIpList and BlackIpList are optional). Only IP-specific mitigation policy is supported.
+   * - **22**: clears the whitelist. Only IP-specific mitigation policy is supported.
+   * - **23**: clears the blacklist. Only IP-specific mitigation policy is supported.
+   * - **30**: modifies the AI-based intelligent protection switch and level (EnableIntelligence and IntelligenceLevel are required). Only IP-specific mitigation policy is supported.
+   * - **31**: modifies the Location Blacklist configuration (RegionBlockCountryList and RegionBlockProvinceList are optional). Only IP-specific mitigation policy is supported.
+   * - **32**: modifies the source rate limiting configuration (SourceLimit and SourceBlockList are required). Only IP-specific mitigation policy is supported.
+   * - **33**: modifies the reflection attack port filtering (ReflectBlockUdpPortList is required). Only IP-specific mitigation policy is supported.
+   * - **40**: creates a port blocking rule (PortRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **41**: modifies a port blocking rule (PortRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **42**: deletes a port blocking rule (PortRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **50**: creates a byte-match filter rule (FingerPrintRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **51**: modifies a byte-match filter rule (FingerPrintRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **52**: deletes a byte-match filter rule (FingerPrintRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **60**: modifies the port-specific mitigation switch (EnableL4Defense is required). Only port-specific mitigation policy is supported.
+   * - **61**: creates a port-specific mitigation rule (L4RuleList is required). Only port-specific mitigation policy is supported.
+   * - **62**: modifies a port-specific mitigation rule (L4RuleList is required). Only port-specific mitigation policy is supported.
+   * - **63**: deletes a port-specific mitigation rule (L4RuleList is required). Only port-specific mitigation policy is supported.
    * 
    * This parameter is required.
    * 
@@ -963,6 +1090,10 @@ export class ModifyPolicyRequest extends $dara.Model {
    * @remarks
    * The version of the port-specific mitigation policy. Valid values:
    * 
+   * - **Not specified**: Modifies the default surf mitigation engine policy.
+   * - **2**: Modifies the new stream mitigation engine policy.
+   * > Only port-specific mitigation policies are supported.
+   * 
    * @example
    * 2
    */

package/src/models/ModifyPolicyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyPolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID. Alibaba Cloud generates a unique ID for each request, which can be used for troubleshooting and diagnostics.
+   * The request ID. Alibaba Cloud generates a unique ID for each API request. You can use this ID to troubleshoot issues.
    * 
    * @example
    * B4B379C2-9319-4C6B-B579-FE36831****

package/src/models/ModifyPolicyShrinkRequest.ts

@@ -5,7 +5,30 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyPolicyShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The action type.
+   * The action type. Valid values:
+   * 
+   * - **10**: modifies the name (Name is required).
+   * - **11**: modifies the blacklist timeout period (BlackIpListExpireAt is required). Only IP-specific mitigation policy is supported.
+   * - **12**: modifies the switch for whitelisting back-to-origin IP addresses of Anti-DDoS Pro and Anti-DDoS Premium (WhitenGfbrNets is required). Only IP-specific mitigation policy is supported.
+   * - **13**: modifies the switch for ICMP Blocking (EnableDropIcmp is required). Only IP-specific mitigation policy is supported.
+   * - **20**: adds entries to blacklists and whitelists (WhiteIpList and BlackIpList are optional). Only IP-specific mitigation policy is supported.
+   * - **21**: deletes entries from blacklists and whitelists (WhiteIpList and BlackIpList are optional). Only IP-specific mitigation policy is supported.
+   * - **22**: clears the whitelist. Only IP-specific mitigation policy is supported.
+   * - **23**: clears the blacklist. Only IP-specific mitigation policy is supported.
+   * - **30**: modifies the AI-based intelligent protection switch and level (EnableIntelligence and IntelligenceLevel are required). Only IP-specific mitigation policy is supported.
+   * - **31**: modifies the Location Blacklist configuration (RegionBlockCountryList and RegionBlockProvinceList are optional). Only IP-specific mitigation policy is supported.
+   * - **32**: modifies the source rate limiting configuration (SourceLimit and SourceBlockList are required). Only IP-specific mitigation policy is supported.
+   * - **33**: modifies the reflection attack port filtering (ReflectBlockUdpPortList is required). Only IP-specific mitigation policy is supported.
+   * - **40**: creates a port blocking rule (PortRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **41**: modifies a port blocking rule (PortRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **42**: deletes a port blocking rule (PortRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **50**: creates a byte-match filter rule (FingerPrintRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **51**: modifies a byte-match filter rule (FingerPrintRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **52**: deletes a byte-match filter rule (FingerPrintRuleList is required). Only IP-specific mitigation policy is supported.
+   * - **60**: modifies the port-specific mitigation switch (EnableL4Defense is required). Only port-specific mitigation policy is supported.
+   * - **61**: creates a port-specific mitigation rule (L4RuleList is required). Only port-specific mitigation policy is supported.
+   * - **62**: modifies a port-specific mitigation rule (L4RuleList is required). Only port-specific mitigation policy is supported.
+   * - **63**: deletes a port-specific mitigation rule (L4RuleList is required). Only port-specific mitigation policy is supported.
    * 
    * This parameter is required.
    * 
@@ -40,6 +63,10 @@ export class ModifyPolicyShrinkRequest extends $dara.Model {
    * @remarks
    * The version of the port-specific mitigation policy. Valid values:
    * 
+   * - **Not specified**: Modifies the default surf mitigation engine policy.
+   * - **2**: Modifies the new stream mitigation engine policy.
+   * > Only port-specific mitigation policies are supported.
+   * 
    * @example
    * 2
    */