@alicloud/ddosbgp20180720 3.0.0 → 3.1.0

package/src/models/ModifyPolicyContentRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.Model {
   /**
    * @remarks
-   * The end of the destination port range. Valid values: **0** to **65535**.
+   * The end value of the destination port range. Valid values: **0** to **65535**.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   dstPortEnd?: number;
   /**
    * @remarks
-   * The start of the destination port range. Valid values: **0** to **65535**.
+   * The start value of the destination port range. Valid values: **0** to **65535**.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   dstPortStart?: number;
   /**
    * @remarks
-   * The ID of the rule.
+   * The rule ID.
    * 
    * @example
    * 83967609-7ea5-4f6d-a6ea-380b09e****
@@ -33,12 +33,7 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   id?: string;
   /**
    * @remarks
-   * The action triggered if the rule is matched. Valid values:
-   * 
-   * *   **permit**: 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**.
+   * The action to take when a fingerprint match is found. Valid values:
    * 
    * This parameter is required.
    * 
@@ -76,7 +71,7 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   offset?: number;
   /**
    * @remarks
-   * The payload. The value is a hexadecimal string.
+   * The detection payload, expressed in hexadecimal string format.
    * 
    * @example
    * abcd
@@ -86,9 +81,6 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
    * @remarks
    * The protocol type. Valid values:
    * 
-   * *   **tcp**
-   * *   **udp**
-   * 
    * This parameter is required.
    * 
    * @example
@@ -97,9 +89,7 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   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**.
+   * The rate limit value. Valid values: **1** to **100000**.
    * 
    * @example
    * 100
@@ -107,9 +97,7 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   rateValue?: number;
   /**
    * @remarks
-   * The sequence number that indicates the order for the rule to take effect. The value is an integer.
-   * 
-   * >  A smaller number indicates a higher priority.
+   * The priority number, expressed as an integer.
    * 
    * This parameter is required.
    * 
@@ -119,7 +107,7 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   seqNo?: number;
   /**
    * @remarks
-   * The end of the source port range. Valid values: **0** to **65535**.
+   * The end value of the source port range. Valid values: **0** to **65535**.
    * 
    * This parameter is required.
    * 
@@ -129,7 +117,7 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   srcPortEnd?: number;
   /**
    * @remarks
-   * The start of the source port range. Valid values: **0** to **65535**.
+   * The start value of the source port range. Valid values: **0** to **65535**.
    * 
    * This parameter is required.
    * 
@@ -183,7 +171,21 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
 }
 
 export class ModifyPolicyContentRequestContentL4RuleListConditionListOffset extends $dara.Model {
+  /**
+   * @remarks
+   * The end position. Valid values: **0** to **1499**.
+   * 
+   * @example
+   * 1499
+   */
   end?: number;
+  /**
+   * @remarks
+   * The start position. Valid values: **0** to **1499**.
+   * 
+   * @example
+   * 0
+   */
   start?: number;
   static names(): { [key: string]: string } {
     return {
@@ -211,29 +213,52 @@ export class ModifyPolicyContentRequestContentL4RuleListConditionListOffset exte
 export class ModifyPolicyContentRequestContentL4RuleListConditionList 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.
+   * The detection content.
    * 
    * @example
    * abcd
    */
   arg?: string;
+  /**
+   * @remarks
+   * The matching content.
+   * 
+   * @example
+   * test**
+   */
   content?: string;
   /**
    * @remarks
-   * The number of bytes from the start position for matching. Valid values: **1** to **2048**.
+   * The detection window length. Valid values: **1** to **2048**.
    * 
    * @example
    * 1200
    */
   depth?: number;
+  /**
+   * @remarks
+   * The character type. Valid values:
+   * 
+   * @example
+   * str
+   */
   encode?: string;
+  /**
+   * @remarks
+   * The matching range.
+   */
   offset?: ModifyPolicyContentRequestContentL4RuleListConditionListOffset;
+  /**
+   * @remarks
+   * The matching pattern. Valid values:
+   * 
+   * @example
+   * contain
+   */
   pattern?: string;
   /**
    * @remarks
-   * The start position for matching. Valid values: **0** to **2047**.
+   * The detection start position. Valid values: **0** to **2047**.
    * 
    * @example
    * 0
@@ -278,9 +303,7 @@ export class ModifyPolicyContentRequestContentL4RuleListConditionList extends $d
 export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
   /**
    * @remarks
-   * The action that is specified in the rule. Valid value:
-   * 
-   * *   **2**: The traffic is discarded.
+   * The action.
    * 
    * @example
    * 2
@@ -288,12 +311,12 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
   action?: string;
   /**
    * @remarks
-   * The match conditions.
+   * The list of detection conditions.
    */
   conditionList?: ModifyPolicyContentRequestContentL4RuleListConditionList[];
   /**
    * @remarks
-   * The minimum number of bytes in a session to trigger matching. Valid values: **0** to **2048**.
+   * The minimum number of bytes in a session flow that triggers rule matching. Valid values: **0** to **2048**.
    * 
    * @example
    * 0
@@ -301,10 +324,7 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
   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.
+   * The logical operator. Valid values:
    * 
    * @example
    * 0
@@ -312,10 +332,7 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
   match?: string;
   /**
    * @remarks
-   * The type of the rule. Valid values:
-   * 
-   * *   **char**: string match.
-   * *   **hex**: hexadecimal string match.
+   * The rule type. Valid values:
    * 
    * @example
    * char
@@ -323,7 +340,7 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
   method?: string;
   /**
    * @remarks
-   * The name of the rule.
+   * The rule name.
    * 
    * This parameter is required.
    * 
@@ -333,9 +350,7 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The priority of the rule. Valid values: 1 to 100.
-   * 
-   * >  A smaller value indicates a higher priority.
+   * The rule priority. Valid values: 1 to 100.
    * 
    * @example
    * 1
@@ -380,7 +395,7 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
 export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
   /**
    * @remarks
-   * The end of the destination port range. Valid values: **0** to **65535**.
+   * The end value of the destination port range. Valid values: **0** to **65535**.
    * 
    * This parameter is required.
    * 
@@ -390,7 +405,7 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
   dstPortEnd?: number;
   /**
    * @remarks
-   * The start of the destination port range. Valid values: **0** to **65535**.
+   * The start value of the destination port range. Valid values: **0** to **65535**.
    * 
    * This parameter is required.
    * 
@@ -400,7 +415,7 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
   dstPortStart?: number;
   /**
    * @remarks
-   * The ID of the rule.
+   * The rule ID.
    * 
    * @example
    * 412a7312-58ff-4e32-a202-0ab0*******
@@ -408,9 +423,7 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The action triggered if the rule is matched. Valid values:
-   * 
-   * *   **drop**: The traffic is discarded.
+   * The match action. Valid values:
    * 
    * This parameter is required.
    * 
@@ -422,9 +435,6 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
    * @remarks
    * The protocol type. Valid values:
    * 
-   * *   **tcp**
-   * *   **udp**
-   * 
    * This parameter is required.
    * 
    * @example
@@ -433,9 +443,7 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * The sequence number that indicates the order for the rule to take effect. The value is an integer.
-   * 
-   * >  A smaller number indicates a higher priority.
+   * The priority number, expressed as an integer.
    * 
    * This parameter is required.
    * 
@@ -445,7 +453,7 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
   seqNo?: number;
   /**
    * @remarks
-   * The end of the source port range. Valid values: **0** to **65535**.
+   * The end value of the source port range. Valid values: **0** to **65535**.
    * 
    * This parameter is required.
    * 
@@ -455,7 +463,7 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
   srcPortEnd?: number;
   /**
    * @remarks
-   * The start of the source port range. Valid values: **0** to **65535**.
+   * The start value of the source port range. Valid values: **0** to **65535**.
    * 
    * This parameter is required.
    * 
@@ -498,10 +506,111 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
   }
 }
 
+export class ModifyPolicyContentRequestContentSipDefense extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to enable SIP protection. Valid values:
+   * 
+   * @example
+   * true
+   */
+  enable?: boolean;
+  /**
+   * @remarks
+   * The SIP protection level.
+   * 
+   * @example
+   * normal
+   */
+  level?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable SIP defense mode.
+   */
+  sipDefend?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to enable SIP learning mode.
+   */
+  sipLearn?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to enable the SIP source rate limiting module.
+   */
+  sipModule?: boolean;
+  /**
+   * @remarks
+   * The SIP protection port. Valid values: **1** to **65535**.
+   * 
+   * @example
+   * 5060
+   */
+  sipPort?: string;
+  /**
+   * @remarks
+   * The SIP source rate limit value in PPS.
+   * 
+   * @example
+   * 1000
+   */
+  sipRate?: number;
+  /**
+   * @remarks
+   * The SIP activation threshold in Mbit/s.
+   * 
+   * @example
+   * 100
+   */
+  sipStartMbps?: number;
+  /**
+   * @remarks
+   * The SIP activation threshold in PPS.
+   * 
+   * @example
+   * 500
+   */
+  sipStartPps?: number;
+  static names(): { [key: string]: string } {
+    return {
+      enable: 'Enable',
+      level: 'Level',
+      sipDefend: 'SipDefend',
+      sipLearn: 'SipLearn',
+      sipModule: 'SipModule',
+      sipPort: 'SipPort',
+      sipRate: 'SipRate',
+      sipStartMbps: 'SipStartMbps',
+      sipStartPps: 'SipStartPps',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      enable: 'boolean',
+      level: 'string',
+      sipDefend: 'boolean',
+      sipLearn: 'boolean',
+      sipModule: 'boolean',
+      sipPort: 'string',
+      sipRate: 'number',
+      sipStartMbps: 'number',
+      sipStartPps: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class ModifyPolicyContentRequestContentSourceBlockList extends $dara.Model {
   /**
    * @remarks
-   * The validity period of the blacklist to which the source IP address is added. Unit: seconds.
+   * The duration for which the source IP address is added to the blacklist. Unit: seconds.
    * 
    * This parameter is required.
    * 
@@ -511,7 +620,7 @@ export class ModifyPolicyContentRequestContentSourceBlockList extends $dara.Mode
   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.
+   * The statistical period for source rate limiting blacklisting. Unit: seconds.
    * 
    * This parameter is required.
    * 
@@ -521,7 +630,7 @@ export class ModifyPolicyContentRequestContentSourceBlockList extends $dara.Mode
   everySeconds?: number;
   /**
    * @remarks
-   * The number of times that the source IP address exceeds a limit in a statistical period.
+   * The number of times the source IP address exceeds the rate limit within one statistical period.
    * 
    * This parameter is required.
    * 
@@ -531,12 +640,7 @@ export class ModifyPolicyContentRequestContentSourceBlockList extends $dara.Mode
   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.
+   * The source rate limiting type. Valid values:
    * 
    * This parameter is required.
    * 
@@ -574,7 +678,7 @@ export class ModifyPolicyContentRequestContentSourceBlockList extends $dara.Mode
 export class ModifyPolicyContentRequestContentSourceLimit extends $dara.Model {
   /**
    * @remarks
-   * The bandwidth limit on source IP addresses. Unit: bytes per second.
+   * The source bandwidth throttling value, in bytes per second.
    * 
    * @example
    * 2048
@@ -582,7 +686,7 @@ export class ModifyPolicyContentRequestContentSourceLimit extends $dara.Model {
   bps?: number;
   /**
    * @remarks
-   * The packets per second (pps) limit on source IP addresses.
+   * The source PPS rate limit, in packets per second.
    * 
    * @example
    * 64
@@ -590,7 +694,7 @@ export class ModifyPolicyContentRequestContentSourceLimit extends $dara.Model {
   pps?: number;
   /**
    * @remarks
-   * The bandwidth limit on source SYN packets. Unit: bytes per second.
+   * The source SYN bandwidth throttling value, in bytes per second.
    * 
    * @example
    * 2048
@@ -598,7 +702,7 @@ export class ModifyPolicyContentRequestContentSourceLimit extends $dara.Model {
   synBps?: number;
   /**
    * @remarks
-   * The pps limit on source SYN packets.
+   * The source SYN PPS rate limit, in packets per second.
    * 
    * @example
    * 64
@@ -634,7 +738,7 @@ export class ModifyPolicyContentRequestContentSourceLimit extends $dara.Model {
 export class ModifyPolicyContentRequestContent extends $dara.Model {
   /**
    * @remarks
-   * The validity period of the IP address blacklist. The value is a UNIX timestamp.
+   * The expiration time of the IP blacklist (UNIX timestamp).
    * 
    * @example
    * 1716878000
@@ -642,7 +746,7 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   blackIpListExpireAt?: number;
   /**
    * @remarks
-   * Specifies whether to enable ICMP blocking.
+   * Specifies whether to disable the ICMP protocol.
    * 
    * @example
    * true
@@ -650,7 +754,7 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   enableDropIcmp?: boolean;
   /**
    * @remarks
-   * Specifies whether to enable intelligent protection.
+   * Specifies whether to enable AI-based intelligent protection.
    * 
    * @example
    * true
@@ -658,7 +762,7 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   enableIntelligence?: boolean;
   /**
    * @remarks
-   * Specifies whether to enable port-specific mitigation.
+   * Specifies whether to enable port protection.
    * 
    * @example
    * true
@@ -666,16 +770,12 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   enableL4Defense?: boolean;
   /**
    * @remarks
-   * The byte-match filter rules.
+   * The list of byte-match filter rules.
    */
   fingerPrintRuleList?: ModifyPolicyContentRequestContentFingerPrintRuleList[];
   /**
    * @remarks
-   * The level of intelligent protection. Valid values:
-   * 
-   * *   **default**: normal.
-   * *   **hard**: strict.
-   * *   **weak**: loose.
+   * The protection level of AI-based intelligent protection. Valid values:
    * 
    * @example
    * default
@@ -683,42 +783,47 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   intelligenceLevel?: string;
   /**
    * @remarks
-   * The port-specific mitigation rules.
+   * The list of port-specific mitigation rules.
    */
   l4RuleList?: ModifyPolicyContentRequestContentL4RuleList[];
   /**
    * @remarks
-   * The port blocking rules.
+   * The list of port blocking rules.
    */
   portRuleList?: ModifyPolicyContentRequestContentPortRuleList[];
   /**
    * @remarks
-   * The ports whose traffic is filtered out by the filtering policies for UDP reflection attacks.
+   * The list of ports filtered by reflection attack prevention.
    */
   reflectBlockUdpPortList?: number[];
   /**
    * @remarks
-   * The countries in the location blacklist.
+   * The list of countries for location blacklist.
    */
   regionBlockCountryList?: number[];
   /**
    * @remarks
-   * The provinces in the location blacklist.
+   * The list of provinces for location blacklist.
    */
   regionBlockProvinceList?: number[];
   /**
    * @remarks
-   * The source IP addresses that are added to the blacklist.
+   * The SIP Protection Settings.
+   */
+  sipDefense?: ModifyPolicyContentRequestContentSipDefense;
+  /**
+   * @remarks
+   * The source rate limiting blacklist.
    */
   sourceBlockList?: ModifyPolicyContentRequestContentSourceBlockList[];
   /**
    * @remarks
-   * The settings for source rate limiting.
+   * The source rate limiting configuration.
    */
   sourceLimit?: ModifyPolicyContentRequestContentSourceLimit;
   /**
    * @remarks
-   * Specifies whether to add back-to-origin CIDR blocks of Anti-DDoS Proxy to the whitelist.
+   * 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).
    * 
    * @example
    * false
@@ -737,6 +842,7 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
       reflectBlockUdpPortList: 'ReflectBlockUdpPortList',
       regionBlockCountryList: 'RegionBlockCountryList',
       regionBlockProvinceList: 'RegionBlockProvinceList',
+      sipDefense: 'SipDefense',
       sourceBlockList: 'SourceBlockList',
       sourceLimit: 'SourceLimit',
       whitenGfbrNets: 'WhitenGfbrNets',
@@ -756,6 +862,7 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
       reflectBlockUdpPortList: { 'type': 'array', 'itemType': 'number' },
       regionBlockCountryList: { 'type': 'array', 'itemType': 'number' },
       regionBlockProvinceList: { 'type': 'array', 'itemType': 'number' },
+      sipDefense: ModifyPolicyContentRequestContentSipDefense,
       sourceBlockList: { 'type': 'array', 'itemType': ModifyPolicyContentRequestContentSourceBlockList },
       sourceLimit: ModifyPolicyContentRequestContentSourceLimit,
       whitenGfbrNets: 'boolean',
@@ -781,6 +888,9 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
     if(Array.isArray(this.regionBlockProvinceList)) {
       $dara.Model.validateArray(this.regionBlockProvinceList);
     }
+    if(this.sipDefense && typeof (this.sipDefense as any).validate === 'function') {
+      (this.sipDefense as any).validate();
+    }
     if(Array.isArray(this.sourceBlockList)) {
       $dara.Model.validateArray(this.sourceBlockList);
     }
@@ -803,7 +913,7 @@ export class ModifyPolicyContentRequest extends $dara.Model {
   content?: ModifyPolicyContentRequestContent;
   /**
    * @remarks
-   * The ID of the policy.
+   * The policy ID.
    * 
    * This parameter is required.
    * 
@@ -813,12 +923,19 @@ export class ModifyPolicyContentRequest extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The name of the policy.
+   * The policy name.
    * 
    * @example
    * demo**
    */
   name?: string;
+  /**
+   * @remarks
+   * The version of the port-specific mitigation policy. Valid values:
+   * 
+   * @example
+   * 2
+   */
   portVersion?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ModifyPolicyContentResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyPolicyContentResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The request ID. Alibaba Cloud generates a unique ID for each request, which can be used for troubleshooting and diagnostics.
    * 
    * @example
    * 3777EF25-940B-51F4-BB1D-99B5********

package/src/models/ModifyPolicyContentShrinkRequest.ts

@@ -10,7 +10,7 @@ export class ModifyPolicyContentShrinkRequest extends $dara.Model {
   contentShrink?: string;
   /**
    * @remarks
-   * The ID of the policy.
+   * The policy ID.
    * 
    * This parameter is required.
    * 
@@ -20,12 +20,19 @@ export class ModifyPolicyContentShrinkRequest extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The name of the policy.
+   * The policy name.
    * 
    * @example
    * demo**
    */
   name?: string;
+  /**
+   * @remarks
+   * The version of the port-specific mitigation policy. Valid values:
+   * 
+   * @example
+   * 2
+   */
   portVersion?: string;
   static names(): { [key: string]: string } {
     return {