@alicloud/ddosbgp20180720 3.1.1 → 3.1.3

package/src/models/ModifyPolicyContentRequest.ts

@@ -5,9 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyPolicyContentRequestContentFingerPrintRuleList 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 ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
    * @remarks
    * The start value of the destination port range. Valid values: **0** to **65535**.
    * 
-   * This parameter is required.
-   * 
    * @example
    * 0
    */
@@ -33,7 +37,12 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   id?: string;
   /**
    * @remarks
-   * The action to take when a fingerprint match is found. Valid values:
+   * The action to take when the fingerprint is matched. Valid values:
+   * 
+   * - **permit**: 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 is specified by the **RateValue** parameter.
+   * - **session_rate**: rate-limits the source session of traffic that matches the fingerprint. The rate limit is specified by the **RateValue** parameter.
    * 
    * This parameter is required.
    * 
@@ -45,8 +54,6 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
    * @remarks
    * The maximum packet length. Valid values: **1** to **1500**.
    * 
-   * This parameter is required.
-   * 
    * @example
    * 1500
    */
@@ -55,12 +62,18 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
    * @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 ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   offset?: number;
   /**
    * @remarks
-   * The detection payload, expressed in hexadecimal string format.
+   * The detection payload. The value is in hexadecimal string format.
    * 
    * @example
    * abcd
@@ -81,7 +94,8 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
    * @remarks
    * The protocol type. Valid values:
    * 
-   * This parameter is required.
+   * - **tcp**: Transmission Control Protocol.
+   * - **udp**: User Datagram Protocol.
    * 
    * @example
    * tcp
@@ -89,7 +103,9 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   protocol?: string;
   /**
    * @remarks
-   * The rate limit value. Valid values: **1** to **100000**.
+   * The rate limit. 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 set to **ip_rate** or **session_rate**).
    * 
    * @example
    * 100
@@ -97,7 +113,16 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
   rateValue?: number;
   /**
    * @remarks
-   * The priority number, expressed as an integer.
+   * The rule.
+   * 
+   * @example
+   * (ip.version == 4)
+   */
+  rule?: string;
+  /**
+   * @remarks
+   * The priority of the rule, represented as an integer.
+   * >A smaller value indicates a higher priority.
    * 
    * This parameter is required.
    * 
@@ -109,8 +134,6 @@ export class ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
    * @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 ModifyPolicyContentRequestContentFingerPrintRuleList extends $dara.
    * @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 ModifyPolicyContentRequestContentL4RuleListConditionListOffset exte
    * @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 ModifyPolicyContentRequestContentL4RuleListConditionList extends $d
   /**
    * @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 ModifyPolicyContentRequestContentL4RuleListConditionList extends $d
    * @remarks
    * The matching content.
    * 
+   * 1. When **Encode** is set to **str**, the following requirements must be met:
+   * 
+   * - The length of **Content** must not exceed 1500.
+   * 
+   * - **End** - **Start** >= length of **Content**.
+   * 
+   * 2. When **Encode** is set to **hex**, the following requirements must be met:
+   * 
+   * - **Content** must be hexadecimal characters.
+   * 
+   * - The length of **Content** must be an even number.
+   * 
+   * - The length of **Content** must not exceed 3000.
+   * 
+   * - **End** - **Start** + 1 >= length of **Content** / 2.
+   * 
    * @example
    * test**
    */
@@ -239,6 +295,10 @@ export class ModifyPolicyContentRequestContentL4RuleListConditionList extends $d
    * @remarks
    * The character type. Valid values:
    * 
+   * - **str**: string.
+   * 
+   * - **hex**: hexadecimal.
+   * 
    * @example
    * str
    */
@@ -252,6 +312,10 @@ export class ModifyPolicyContentRequestContentL4RuleListConditionList extends $d
    * @remarks
    * The matching pattern. Valid values:
    * 
+   * - **contain**: contains.
+   * 
+   * - **not_contain**: does not contain.
+   * 
    * @example
    * contain
    */
@@ -306,7 +370,7 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
    * The action.
    * 
    * @example
-   * 2
+   * block
    */
   action?: string;
   /**
@@ -316,7 +380,7 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
   conditionList?: ModifyPolicyContentRequestContentL4RuleListConditionList[];
   /**
    * @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 +390,10 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
    * @remarks
    * The logical operator. Valid values:
    * 
+   * - **0**: executes the action when the rule is matched.
+   * 
+   * - **1**: executes the action when the rule is not matched.
+   * 
    * @example
    * 0
    */
@@ -334,6 +402,10 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
    * @remarks
    * The rule type. Valid values:
    * 
+   * - **char**: string matching.
+   * 
+   * - **hex**: hexadecimal matching.
+   * 
    * @example
    * char
    */
@@ -351,6 +423,7 @@ export class ModifyPolicyContentRequestContentL4RuleList extends $dara.Model {
   /**
    * @remarks
    * The rule priority. Valid values: 1 to 100.
+   * > A smaller value indicates a higher priority.
    * 
    * @example
    * 1
@@ -425,6 +498,8 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
    * @remarks
    * The match action. Valid values:
    * 
+   * - **drop**: Drop.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -435,6 +510,9 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
    * @remarks
    * The protocol type. Valid values:
    * 
+   * - **tcp**: Transmission Control Protocol.
+   * - **udp**: User Datagram Protocol.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -443,7 +521,8 @@ export class ModifyPolicyContentRequestContentPortRuleList extends $dara.Model {
   protocol?: string;
   /**
    * @remarks
-   * The priority number, expressed as an integer.
+   * The priority of the rule, represented as an integer.
+   * >A smaller value indicates a higher priority.
    * 
    * This parameter is required.
    * 
@@ -511,6 +590,9 @@ export class ModifyPolicyContentRequestContentSipDefense extends $dara.Model {
    * @remarks
    * Specifies whether to enable SIP protection. Valid values:
    * 
+   * - **true**: Enabled.
+   * - **false**: Disabled.
+   * 
    * @example
    * true
    */
@@ -548,7 +630,7 @@ export class ModifyPolicyContentRequestContentSipDefense extends $dara.Model {
   sipPort?: string;
   /**
    * @remarks
-   * The SIP source rate limit value in PPS.
+   * The SIP source rate limit (PPS).
    * 
    * @example
    * 1000
@@ -556,7 +638,7 @@ export class ModifyPolicyContentRequestContentSipDefense extends $dara.Model {
   sipRate?: number;
   /**
    * @remarks
-   * The SIP activation threshold in Mbit/s.
+   * The SIP activation threshold (Mbps).
    * 
    * @example
    * 100
@@ -564,7 +646,7 @@ export class ModifyPolicyContentRequestContentSipDefense extends $dara.Model {
   sipStartMbps?: number;
   /**
    * @remarks
-   * The SIP activation threshold in PPS.
+   * The SIP activation threshold (PPS).
    * 
    * @example
    * 500
@@ -641,6 +723,10 @@ export class ModifyPolicyContentRequestContentSourceBlockList extends $dara.Mode
   /**
    * @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.
    * 
@@ -678,7 +764,7 @@ export class ModifyPolicyContentRequestContentSourceBlockList extends $dara.Mode
 export class ModifyPolicyContentRequestContentSourceLimit extends $dara.Model {
   /**
    * @remarks
-   * The source bandwidth throttling value, in bytes per second.
+   * The source bandwidth throttling value, in bytes per second (byte/s).
    * 
    * @example
    * 2048
@@ -686,7 +772,7 @@ export class ModifyPolicyContentRequestContentSourceLimit extends $dara.Model {
   bps?: number;
   /**
    * @remarks
-   * The source PPS rate limit, in packets per second.
+   * The source PPS rate limit, in packets per second (packet/s).
    * 
    * @example
    * 64
@@ -694,7 +780,7 @@ export class ModifyPolicyContentRequestContentSourceLimit extends $dara.Model {
   pps?: number;
   /**
    * @remarks
-   * The source SYN bandwidth throttling value, in bytes per second.
+   * The source SYN bandwidth throttling value, in bytes per second (byte/s).
    * 
    * @example
    * 2048
@@ -702,7 +788,7 @@ export class ModifyPolicyContentRequestContentSourceLimit extends $dara.Model {
   synBps?: number;
   /**
    * @remarks
-   * The source SYN PPS rate limit, in packets per second.
+   * The source SYN PPS rate limit, in packets per second (packet/s).
    * 
    * @example
    * 64
@@ -754,7 +840,7 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   enableDropIcmp?: boolean;
   /**
    * @remarks
-   * Specifies whether to enable AI-based intelligent protection.
+   * Specifies whether to enable AI-based intelligent analysis.
    * 
    * @example
    * true
@@ -762,7 +848,7 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   enableIntelligence?: boolean;
   /**
    * @remarks
-   * Specifies whether to enable port protection.
+   * Specifies whether to enable port-specific mitigation.
    * 
    * @example
    * true
@@ -770,12 +856,16 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   enableL4Defense?: boolean;
   /**
    * @remarks
-   * The list of byte-match filter rules.
+   * The list of Byte-Match Filter rules.
    */
   fingerPrintRuleList?: ModifyPolicyContentRequestContentFingerPrintRuleList[];
   /**
    * @remarks
-   * The protection level of AI-based intelligent protection. Valid values:
+   * The protection level of AI-based intelligent analysis. Valid values:
+   * 
+   * - **default**: Normal.
+   * - **hard**: Strict.
+   * - **weak**: Loose.
    * 
    * @example
    * default
@@ -793,7 +883,7 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   portRuleList?: ModifyPolicyContentRequestContentPortRuleList[];
   /**
    * @remarks
-   * The list of ports filtered by reflection attack prevention.
+   * The list of ports filtered by the reflection attack prevention feature.
    */
   reflectBlockUdpPortList?: number[];
   /**
@@ -823,7 +913,7 @@ export class ModifyPolicyContentRequestContent extends $dara.Model {
   sourceLimit?: ModifyPolicyContentRequestContentSourceLimit;
   /**
    * @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 whitelist the back-to-origin IP addresses of Anti-DDoS Pro and Anti-DDoS Premium (the Chinese mainland and outside the Chinese mainland).
    * 
    * @example
    * false
@@ -933,6 +1023,10 @@ export class ModifyPolicyContentRequest 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/ModifyPolicyContentResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyPolicyContentResponseBody 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 request. You can use this ID to troubleshoot issues.
    * 
    * @example
    * 3777EF25-940B-51F4-BB1D-99B5********

package/src/models/ModifyPolicyContentShrinkRequest.ts

@@ -30,6 +30,10 @@ export class ModifyPolicyContentShrinkRequest 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
    */