@alicloud/ddosbgp20180720 3.1.1 → 3.1.3

package/src/models/ListPolicyResponseBody.ts

@@ -3,6 +3,14 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListPolicyResponseBodyPolicyListContentFingerPrintRuleList extends $dara.Model {
+  /**
+   * @remarks
+   * The rule remarks.
+   * 
+   * @example
+   * comment
+   */
+  comment?: string;
   /**
    * @remarks
    * The end value of the destination port range. Valid values: **0** to **65535**.
@@ -31,6 +39,11 @@ export class ListPolicyResponseBodyPolicyListContentFingerPrintRuleList extends
    * @remarks
    * The match action. Valid values:
    * 
+   * - **accept**: Allow traffic that matches the fingerprint.
+   * - **drop**: Drop traffic that matches the fingerprint.
+   * - **ip_rate**: Rate-limit the source IP address of traffic that matches the fingerprint. The rate limit is specified by the **RateValue** parameter.
+   * - **session_rate**: Rate-limit the source session of traffic that matches the fingerprint. The rate limit is specified by the **RateValue** parameter.
+   * 
    * @example
    * drop
    */
@@ -51,6 +64,14 @@ export class ListPolicyResponseBodyPolicyListContentFingerPrintRuleList extends
    * 1
    */
   minPktLen?: number;
+  /**
+   * @remarks
+   * The rule mode.
+   * 
+   * @example
+   * 1
+   */
+  mode?: number;
   /**
    * @remarks
    * The offset. Valid values: **0** to **1500**.
@@ -61,7 +82,7 @@ export class ListPolicyResponseBodyPolicyListContentFingerPrintRuleList extends
   offset?: number;
   /**
    * @remarks
-   * The detection payload, represented in hexadecimal string format.
+   * The detection payload, represented as a hexadecimal string.
    * 
    * @example
    * abcd
@@ -71,6 +92,9 @@ export class ListPolicyResponseBodyPolicyListContentFingerPrintRuleList extends
    * @remarks
    * The protocol type. Valid values:
    * 
+   * - **tcp**: Transmission Control Protocol.
+   * - **udp**: User Datagram Protocol.
+   * 
    * @example
    * udp
    */
@@ -79,10 +103,20 @@ export class ListPolicyResponseBodyPolicyListContentFingerPrintRuleList extends
    * @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
    * 1000
    */
   rateValue?: number;
+  /**
+   * @remarks
+   * The rule.
+   * 
+   * @example
+   * (ip.version == 4)
+   */
+  rule?: string;
   /**
    * @remarks
    * The priority number, represented as an integer.
@@ -107,39 +141,55 @@ export class ListPolicyResponseBodyPolicyListContentFingerPrintRuleList extends
    * 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',
     };
   }
 
@@ -157,6 +207,8 @@ export class ListPolicyResponseBodyPolicyListContentL4RuleListConditionListOffse
    * @remarks
    * The end position. Valid values: **0** to **1499**.
    * 
+   * > The end position must be greater than or equal to the start position.
+   * 
    * @example
    * 1499
    */
@@ -196,6 +248,7 @@ export class ListPolicyResponseBodyPolicyListContentL4RuleListConditionList exte
   /**
    * @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
    * test
@@ -203,7 +256,23 @@ export class ListPolicyResponseBodyPolicyListContentL4RuleListConditionList exte
   arg?: string;
   /**
    * @remarks
-   * The match content.
+   * The matching content.
+   * 
+   * 1. If **Encode** is set to **str**, the following requirements must be met:
+   * 
+   * - The length of **Content** cannot exceed 1500.
+   * 
+   * - **End** - **Start** >= the length of **Content**.
+   * 
+   * 2. If **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** cannot exceed 3000.
+   * 
+   * - **End** - **Start** + 1 >= the length of **Content** / 2.
    * 
    * @example
    * test**
@@ -221,18 +290,26 @@ export class ListPolicyResponseBodyPolicyListContentL4RuleListConditionList exte
    * @remarks
    * The character type. Valid values:
    * 
+   * - **str**: string.
+   * 
+   * - **hex**: hexadecimal.
+   * 
    * @example
    * str
    */
   encode?: string;
   /**
    * @remarks
-   * The match range.
+   * The matching range.
    */
   offset?: ListPolicyResponseBodyPolicyListContentL4RuleListConditionListOffset;
   /**
    * @remarks
-   * The match pattern. Valid values:
+   * The matching pattern. Valid values:
+   * 
+   * - **contain**: contains.
+   * 
+   * - **not_contain**: does not contain.
    * 
    * @example
    * contain
@@ -287,6 +364,8 @@ export class ListPolicyResponseBodyPolicyListContentL4RuleList extends $dara.Mod
    * @remarks
    * The action. Valid values:
    * 
+   * - **2**: Drop.
+   * 
    * @example
    * 2
    */
@@ -308,6 +387,10 @@ export class ListPolicyResponseBodyPolicyListContentL4RuleList extends $dara.Mod
    * @remarks
    * The logical operator. Valid values:
    * 
+   * - **0**: Execute the action when matched.
+   * 
+   * - **1**: Execute the action when not matched.
+   * 
    * @example
    * 1
    */
@@ -316,6 +399,10 @@ export class ListPolicyResponseBodyPolicyListContentL4RuleList extends $dara.Mod
    * @remarks
    * The rule type. Valid values:
    * 
+   * - **char**: string matching.
+   * 
+   * - **hex**: hexadecimal matching.
+   * 
    * @example
    * char
    */
@@ -401,6 +488,8 @@ export class ListPolicyResponseBodyPolicyListContentPortRuleList extends $dara.M
    * @remarks
    * The match action. Valid values:
    * 
+   * - **drop**: Drop.
+   * 
    * @example
    * drop
    */
@@ -409,6 +498,9 @@ export class ListPolicyResponseBodyPolicyListContentPortRuleList extends $dara.M
    * @remarks
    * The protocol type. Valid values:
    * 
+   * - **tcp**: Transmission Control Protocol.
+   * - **udp**: User Datagram Protocol.
+   * 
    * @example
    * udp
    */
@@ -477,6 +569,9 @@ export class ListPolicyResponseBodyPolicyListContentSipDefense extends $dara.Mod
    * @remarks
    * Indicates whether SIP protection is enabled. Valid values:
    * 
+   * - **true**: Enabled.
+   * - **false**: Disabled.
+   * 
    * @example
    * true
    */
@@ -491,17 +586,17 @@ export class ListPolicyResponseBodyPolicyListContentSipDefense extends $dara.Mod
   level?: string;
   /**
    * @remarks
-   * The switch for the SIP defense mode.
+   * Indicates whether SIP defense mode is enabled.
    */
   sipDefend?: boolean;
   /**
    * @remarks
-   * The switch for the SIP learning mode.
+   * Indicates whether SIP learning mode is enabled.
    */
   sipLearn?: boolean;
   /**
    * @remarks
-   * The switch for the SIP source rate limiting module.
+   * Indicates whether the SIP source rate limiting module is enabled.
    */
   sipModule?: boolean;
   /**
@@ -514,7 +609,7 @@ export class ListPolicyResponseBodyPolicyListContentSipDefense extends $dara.Mod
   sipPort?: string;
   /**
    * @remarks
-   * The SIP source rate limit value (PPS).
+   * The SIP source rate limit value in PPS.
    * 
    * @example
    * 1000
@@ -522,7 +617,7 @@ export class ListPolicyResponseBodyPolicyListContentSipDefense extends $dara.Mod
   sipRate?: number;
   /**
    * @remarks
-   * The SIP activation threshold (Mbit/s).
+   * The SIP activation threshold in Mbit/s.
    * 
    * @example
    * 100
@@ -530,7 +625,7 @@ export class ListPolicyResponseBodyPolicyListContentSipDefense extends $dara.Mod
   sipStartMbps?: number;
   /**
    * @remarks
-   * The SIP activation threshold (PPS).
+   * The SIP activation threshold in PPS.
    * 
    * @example
    * 500
@@ -602,6 +697,14 @@ export class ListPolicyResponseBodyPolicyListContentSourceBlockList extends $dar
    * @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.
+   * 
    * @example
    * 3
    */
@@ -636,7 +739,7 @@ export class ListPolicyResponseBodyPolicyListContentSourceBlockList extends $dar
 export class ListPolicyResponseBodyPolicyListContentSourceLimit 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
@@ -644,7 +747,7 @@ export class ListPolicyResponseBodyPolicyListContentSourceLimit extends $dara.Mo
   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
@@ -652,7 +755,7 @@ export class ListPolicyResponseBodyPolicyListContentSourceLimit extends $dara.Mo
   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
@@ -660,7 +763,7 @@ export class ListPolicyResponseBodyPolicyListContentSourceLimit extends $dara.Mo
   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
@@ -720,7 +823,7 @@ export class ListPolicyResponseBodyPolicyListContent extends $dara.Model {
   enableIntelligence?: boolean;
   /**
    * @remarks
-   * Indicates whether port protection is enabled.
+   * Indicates whether port-specific mitigation is enabled.
    * 
    * @example
    * true
@@ -728,20 +831,24 @@ export class ListPolicyResponseBodyPolicyListContent extends $dara.Model {
   enableL4Defense?: boolean;
   /**
    * @remarks
-   * The list of byte-match filter rules.
+   * The list of Byte-Match Filter rules.
    */
   fingerPrintRuleList?: ListPolicyResponseBodyPolicyListContentFingerPrintRuleList[];
   /**
    * @remarks
    * The protection level of AI-based intelligent analysis. Valid values:
    * 
+   * - **default**: Normal.
+   * - **hard**: Strict.
+   * - **weak**: Loose.
+   * 
    * @example
    * default
    */
   intelligenceLevel?: string;
   /**
    * @remarks
-   * The list of port protection rules.
+   * The list of port-specific mitigation rules.
    */
   l4RuleList?: ListPolicyResponseBodyPolicyListContentL4RuleList[];
   /**
@@ -751,7 +858,11 @@ export class ListPolicyResponseBodyPolicyListContent extends $dara.Model {
   portRuleList?: ListPolicyResponseBodyPolicyListContentPortRuleList[];
   /**
    * @remarks
-   * The version of the port-specific mitigation policies. Valid values:
+   * The version of the port-specific mitigation policy. Valid values:
+   * 
+   * - **Not specified**: the default surf mitigation engine policy.
+   * - **2**: the new stream mitigation engine policy.
+   * > Only port-specific mitigation policies support this parameter.
    * 
    * @example
    * 2
@@ -774,12 +885,12 @@ export class ListPolicyResponseBodyPolicyListContent extends $dara.Model {
   regionBlockProvinceList?: number[];
   /**
    * @remarks
-   * The SIP protection configuration.
+   * The SIP Protection Settings.
    */
   sipDefense?: ListPolicyResponseBodyPolicyListContentSipDefense;
   /**
    * @remarks
-   * The source rate limiting blacklist.
+   * The list of source rate limiting blacklist rules.
    */
   sourceBlockList?: ListPolicyResponseBodyPolicyListContentSourceBlockList[];
   /**
@@ -789,7 +900,7 @@ export class ListPolicyResponseBodyPolicyListContent extends $dara.Model {
   sourceLimit?: ListPolicyResponseBodyPolicyListContentSourceLimit;
   /**
    * @remarks
-   * Indicates whether whitelisting of back-to-origin CIDR blocks of Anti-DDoS Pro and Anti-DDoS Premium (the Chinese mainland & outside the Chinese mainland) is enabled.
+   * Indicates whether the back-to-origin CIDR blocks of Anti-DDoS Pro and Anti-DDoS Premium (the Chinese mainland & outside the Chinese mainland) are added to the whitelist.
    * 
    * @example
    * false
@@ -914,6 +1025,9 @@ export class ListPolicyResponseBodyPolicyList extends $dara.Model {
   /**
    * @remarks
    * The policy type. Valid values:
+   * - **default**: default mitigation policy.
+   * - **l3**: IP-specific mitigation policy.
+   * - **l4**: port-specific mitigation policy.
    * 
    * @example
    * l3
@@ -961,7 +1075,7 @@ export class ListPolicyResponseBody extends $dara.Model {
   policyList?: ListPolicyResponseBodyPolicyList[];
   /**
    * @remarks
-   * The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request. It can be used to troubleshoot and locate issues.
+   * The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.
    * 
    * @example
    * B4B379C2-9319-4C6B-B579-FE36831B09F4