@alicloud/ddosbgp20180720 3.0.0 → 3.1.0

package/dist/models/ModifyPolicyRequest.d.ts

@@ -2,7 +2,7 @@ import * as $dara from '@darabonba/typescript';
 export declare class ModifyPolicyRequestContentFingerPrintRuleList 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.
      *
@@ -12,7 +12,7 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList 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.
      *
@@ -22,7 +22,7 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList extends $dara
     dstPortStart?: number;
     /**
      * @remarks
-     * The ID of the rule.
+     * The rule ID.
      *
      * @example
      * 5fbe941f-a0cf-4a49-9c7c-8fac********
@@ -30,12 +30,7 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList extends $dara
     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**.
+     * The match action. Valid values:
      *
      * This parameter is required.
      *
@@ -73,7 +68,7 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList extends $dara
     offset?: number;
     /**
      * @remarks
-     * The payload. The value is a hexadecimal string.
+     * The detection payload. Represented in hexadecimal string format.
      *
      * @example
      * abcd
@@ -81,10 +76,7 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList extends $dara
     payloadBytes?: string;
     /**
      * @remarks
-     * The type of the protocol. Valid values:
-     *
-     * *   **tcp**
-     * *   **udp**
+     * The protocol type. Valid values:
      *
      * This parameter is required.
      *
@@ -94,9 +86,7 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList 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
@@ -104,9 +94,7 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList 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, represented as an integer.
      *
      * This parameter is required.
      *
@@ -116,7 +104,7 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList 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.
      *
@@ -126,7 +114,7 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList 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.
      *
@@ -146,7 +134,21 @@ export declare class ModifyPolicyRequestContentFingerPrintRuleList extends $dara
     });
 }
 export declare class ModifyPolicyRequestContentL4RuleListConditionListOffset 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;
@@ -162,29 +164,52 @@ export declare class ModifyPolicyRequestContentL4RuleListConditionListOffset ext
 export declare class ModifyPolicyRequestContentL4RuleListConditionList 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?: ModifyPolicyRequestContentL4RuleListConditionListOffset;
+    /**
+     * @remarks
+     * The matching pattern.
+     *
+     * @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
@@ -204,9 +229,7 @@ export declare class ModifyPolicyRequestContentL4RuleListConditionList extends $
 export declare class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
     /**
      * @remarks
-     * The action that is specified in the rule. Valid value:
-     *
-     * *   **2**: The traffic is discarded.
+     * The action.
      *
      * @example
      * 2
@@ -214,12 +237,12 @@ export declare class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
     action?: string;
     /**
      * @remarks
-     * The match conditions.
+     * The list of detection conditions.
      */
     conditionList?: ModifyPolicyRequestContentL4RuleListConditionList[];
     /**
      * @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
@@ -227,10 +250,7 @@ export declare class ModifyPolicyRequestContentL4RuleList 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
@@ -238,10 +258,7 @@ export declare class ModifyPolicyRequestContentL4RuleList 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
@@ -249,7 +266,7 @@ export declare class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
     method?: string;
     /**
      * @remarks
-     * The name of the rule.
+     * The rule name.
      *
      * This parameter is required.
      *
@@ -259,9 +276,7 @@ export declare class ModifyPolicyRequestContentL4RuleList 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
@@ -281,7 +296,7 @@ export declare class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
 export declare class ModifyPolicyRequestContentPortRuleList 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.
      *
@@ -291,7 +306,7 @@ export declare class ModifyPolicyRequestContentPortRuleList 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.
      *
@@ -301,7 +316,7 @@ export declare class ModifyPolicyRequestContentPortRuleList extends $dara.Model
     dstPortStart?: number;
     /**
      * @remarks
-     * The ID of the rule.
+     * The rule ID.
      *
      * @example
      * c52c2fa6-fdac-40c4-8753-be7c*********
@@ -309,9 +324,7 @@ export declare class ModifyPolicyRequestContentPortRuleList 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.
      *
@@ -321,10 +334,7 @@ export declare class ModifyPolicyRequestContentPortRuleList extends $dara.Model
     matchAction?: string;
     /**
      * @remarks
-     * The type of the protocol. Valid values:
-     *
-     * *   **tcp**
-     * *   **udp**
+     * The protocol type. Valid values:
      *
      * This parameter is required.
      *
@@ -334,9 +344,7 @@ export declare class ModifyPolicyRequestContentPortRuleList 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, represented as an integer.
      *
      * This parameter is required.
      *
@@ -346,7 +354,7 @@ export declare class ModifyPolicyRequestContentPortRuleList 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.
      *
@@ -356,7 +364,7 @@ export declare class ModifyPolicyRequestContentPortRuleList 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.
      *
@@ -375,10 +383,85 @@ export declare class ModifyPolicyRequestContentPortRuleList extends $dara.Model
         [key: string]: any;
     });
 }
+export declare class ModifyPolicyRequestContentSipDefense 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;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class ModifyPolicyRequestContentSourceBlockList 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.
      *
@@ -388,7 +471,7 @@ export declare class ModifyPolicyRequestContentSourceBlockList extends $dara.Mod
     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.
      *
@@ -398,7 +481,7 @@ export declare class ModifyPolicyRequestContentSourceBlockList extends $dara.Mod
     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.
      *
@@ -408,12 +491,7 @@ export declare class ModifyPolicyRequestContentSourceBlockList extends $dara.Mod
     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.
      *
@@ -435,7 +513,7 @@ export declare class ModifyPolicyRequestContentSourceBlockList extends $dara.Mod
 export declare class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
     /**
      * @remarks
-     * The bandwidth limit on source IP addresses. Unit: bytes per second.
+     * The source bandwidth throttling. Unit: Byte/s.
      *
      * @example
      * 2048
@@ -443,7 +521,7 @@ export declare class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
     bps?: number;
     /**
      * @remarks
-     * The packets per second (pps) limit on source IP addresses.
+     * The source PPS rate limit. Unit: Packet/s.
      *
      * @example
      * 64
@@ -451,7 +529,7 @@ export declare class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
     pps?: number;
     /**
      * @remarks
-     * The bandwidth limit on source SYN packets. Unit: bytes per second.
+     * The source SYN bandwidth throttling. Unit: Byte/s.
      *
      * @example
      * 2048
@@ -459,7 +537,7 @@ export declare class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
     synBps?: number;
     /**
      * @remarks
-     * The pps limit on source SYN packets.
+     * The source SYN PPS rate limit. Unit: Packet/s.
      *
      * @example
      * 64
@@ -479,12 +557,12 @@ export declare class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
 export declare class ModifyPolicyRequestContent extends $dara.Model {
     /**
      * @remarks
-     * The IP addresses in the blacklist.
+     * The IP blacklist.
      */
     blackIpList?: string[];
     /**
      * @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
@@ -492,7 +570,7 @@ export declare class ModifyPolicyRequestContent extends $dara.Model {
     blackIpListExpireAt?: number;
     /**
      * @remarks
-     * Specifies whether to enable ICMP blocking.
+     * Specifies whether to disable the ICMP protocol.
      *
      * @example
      * true
@@ -500,7 +578,7 @@ export declare class ModifyPolicyRequestContent extends $dara.Model {
     enableDropIcmp?: boolean;
     /**
      * @remarks
-     * Specifies whether to enable intelligent protection.
+     * Specifies whether to enable AI-based intelligent protection.
      *
      * @example
      * true
@@ -508,7 +586,7 @@ export declare class ModifyPolicyRequestContent extends $dara.Model {
     enableIntelligence?: boolean;
     /**
      * @remarks
-     * Specifies whether to enable port-specific mitigation.
+     * Specifies whether to enable port protection.
      *
      * @example
      * true
@@ -516,16 +594,12 @@ export declare class ModifyPolicyRequestContent extends $dara.Model {
     enableL4Defense?: boolean;
     /**
      * @remarks
-     * The byte-match filter rules.
+     * The list of byte-match filter rules.
      */
     fingerPrintRuleList?: ModifyPolicyRequestContentFingerPrintRuleList[];
     /**
      * @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
@@ -533,47 +607,52 @@ export declare class ModifyPolicyRequestContent extends $dara.Model {
     intelligenceLevel?: string;
     /**
      * @remarks
-     * The port-specific mitigation rules.
+     * The list of port-specific mitigation rules.
      */
     l4RuleList?: ModifyPolicyRequestContentL4RuleList[];
     /**
      * @remarks
-     * The port blocking rules.
+     * The list of port blocking rules.
      */
     portRuleList?: ModifyPolicyRequestContentPortRuleList[];
     /**
      * @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?: ModifyPolicyRequestContentSipDefense;
+    /**
+     * @remarks
+     * The source rate limiting blacklist.
      */
     sourceBlockList?: ModifyPolicyRequestContentSourceBlockList[];
     /**
      * @remarks
-     * The settings for source rate limiting.
+     * The source rate limiting configuration.
      */
     sourceLimit?: ModifyPolicyRequestContentSourceLimit;
     /**
      * @remarks
-     * The IP addresses in the whitelist.
+     * The IP whitelist.
      */
     whiteIpList?: string[];
     /**
      * @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
@@ -593,30 +672,7 @@ export declare class ModifyPolicyRequestContent extends $dara.Model {
 export declare class ModifyPolicyRequest extends $dara.Model {
     /**
      * @remarks
-     * The type of the action. Valid values:
-     *
-     * *   **10**: modifies the name. If you specify this value, `Name` is required.
-     * *   **11**: modifies the blacklist validity period. If you specify this value, `BlackIpListExpireAt` is required. Only IP-specific mitigation policies support this value.
-     * *   **12**: changes the status of the feature of adding back-to-origin CIDR blocks of Anti-DDoS Proxy to the whitelist. If you specify this value, `WhitenGfbrNets` is required. Only IP-specific mitigation policies support this value.
-     * *   **13**: changes the status of the ICMP blocking feature. If you specify this value, `EnableDropIcmp` is required. Only IP-specific mitigation policies support this value.
-     * *   **20**: adds IP addresses to the blacklist or the whitelist. If you specify this value, you must specify at least one of `WhiteIpList` and `BlackIpList`. Only IP-specific mitigation policies support this value.
-     * *   **21**: removes IP addresses from the blacklist or the whitelist. If you specify this value, at least one of `WhiteIpList` and `BlackIpList` is required. Only IP-specific mitigation policies support this value.
-     * *   **22**: clears the whitelist. Only IP-specific mitigation policies support this value.
-     * *   **23**: clears the blacklist. Only IP-specific mitigation policies support this value.
-     * *   **30**: modifies the status and level of intelligent protection. If you specify this value, `EnableIntelligence` and `IntelligenceLevel` are required. Only IP-specific mitigation policies support this value.
-     * *   **31**: modifies the location blacklist settings. If you specify this value, one of `RegionBlockCountryList` and `RegionBlockProvinceList` is required. Only IP-specific mitigation policies support this value.
-     * *   **32**: modifies the settings for source rate limiting. If you specify this value, `SourceLimit` and `SourceBlockList` are required. Only IP-specific mitigation policies support this value.
-     * *   **33**: modifies the settings for reflection attack filtering. If you specify this value, `ReflectBlockUdpPortList` is required. Only IP-specific mitigation policies support this value.
-     * *   **40**: creates a port blocking rule. If you specify this value, `PortRuleList` is required. Only IP-specific mitigation policies support this value.
-     * *   **41**: modifies the port blocking rule. If you specify this value, `PortRuleList` is required. Only IP-specific mitigation policies support this value.
-     * *   **42**: deletes the port blocking rule. If you specify this value, `PortRuleList` is required. Only IP-specific mitigation policies support this value.
-     * *   **50**: creates a byte-match filter rule. If you specify this value, `FingerPrintRuleList` is required. Only IP-specific mitigation policies support this value.
-     * *   **51**: modifies the byte-match filter rule. If you specify this value, `FingerPrintRuleList` is required. Only IP-specific mitigation policies support this value.
-     * *   **52**: deletes the byte-match filter rule. If you specify this value, `FingerPrintRuleList` is required. Only IP-specific mitigation policies support this value.
-     * *   **60**: changes the status of the port-specific mitigation feature. If you specify this value, `EnableL4Defense` is required. Only port-specific mitigation policies support this value.
-     * *   **61**: creates a port-specific mitigation rule. If you specify this value, `L4RuleList` is required. Only port-specific mitigation policies support this value.
-     * *   **62**: modifies the port-specific mitigation rule. If you specify this value, `L4RuleList` is required. Only port-specific mitigation policies support this value.
-     * *   **63**: deletes the port-specific mitigation rule. If you specify this value, `L4RuleList` is required. Only port-specific mitigation policies support this value.
+     * The action type.
      *
      * This parameter is required.
      *
@@ -631,7 +687,7 @@ export declare class ModifyPolicyRequest extends $dara.Model {
     content?: ModifyPolicyRequestContent;
     /**
      * @remarks
-     * The ID of the policy.
+     * The policy ID.
      *
      * This parameter is required.
      *
@@ -641,12 +697,19 @@ export declare class ModifyPolicyRequest 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;