@alicloud/ddosbgp20180720 2.7.2 → 3.0.0

package/dist/models/ModifyPolicyRequest.d.ts

@@ -0,0 +1,661 @@
+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**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 65535
+     */
+    dstPortEnd?: number;
+    /**
+     * @remarks
+     * The start of the destination port range. Valid values: **0** to **65535**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 0
+     */
+    dstPortStart?: number;
+    /**
+     * @remarks
+     * The ID of the rule.
+     *
+     * @example
+     * 5fbe941f-a0cf-4a49-9c7c-8fac********
+     */
+    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**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * drop
+     */
+    matchAction?: string;
+    /**
+     * @remarks
+     * The maximum packet length. Valid values: **1** to **1500**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 1500
+     */
+    maxPktLen?: number;
+    /**
+     * @remarks
+     * The minimum packet length. Valid values: **1** to **1500**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 1
+     */
+    minPktLen?: number;
+    /**
+     * @remarks
+     * The offset. Valid values: **0** to **1500**.
+     *
+     * @example
+     * 0
+     */
+    offset?: number;
+    /**
+     * @remarks
+     * The payload. The value is a hexadecimal string.
+     *
+     * @example
+     * abcd
+     */
+    payloadBytes?: string;
+    /**
+     * @remarks
+     * The type of the protocol. Valid values:
+     *
+     * *   **tcp**
+     * *   **udp**
+     *
+     * This parameter is required.
+     *
+     * @example
+     * udp
+     */
+    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**.
+     *
+     * @example
+     * 100
+     */
+    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.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 1
+     */
+    seqNo?: number;
+    /**
+     * @remarks
+     * The end of the source port range. Valid values: **0** to **65535**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 65535
+     */
+    srcPortEnd?: number;
+    /**
+     * @remarks
+     * The start of the source port range. Valid values: **0** to **65535**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 0
+     */
+    srcPortStart?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ModifyPolicyRequestContentL4RuleListConditionListOffset extends $dara.Model {
+    end?: number;
+    start?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+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.
+     *
+     * @example
+     * abcd
+     */
+    arg?: string;
+    content?: string;
+    /**
+     * @remarks
+     * The number of bytes from the start position for matching. Valid values: **1** to **2048**.
+     *
+     * @example
+     * 1200
+     */
+    depth?: number;
+    encode?: string;
+    offset?: ModifyPolicyRequestContentL4RuleListConditionListOffset;
+    pattern?: string;
+    /**
+     * @remarks
+     * The start position for matching. Valid values: **0** to **2047**.
+     *
+     * @example
+     * 0
+     */
+    position?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ModifyPolicyRequestContentL4RuleList extends $dara.Model {
+    /**
+     * @remarks
+     * The action that is specified in the rule. Valid value:
+     *
+     * *   **2**: The traffic is discarded.
+     *
+     * @example
+     * 2
+     */
+    action?: string;
+    /**
+     * @remarks
+     * The match conditions.
+     */
+    conditionList?: ModifyPolicyRequestContentL4RuleListConditionList[];
+    /**
+     * @remarks
+     * The minimum number of bytes in a session to trigger matching. Valid values: **0** to **2048**.
+     *
+     * @example
+     * 0
+     */
+    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.
+     *
+     * @example
+     * 0
+     */
+    match?: string;
+    /**
+     * @remarks
+     * The type of the rule. Valid values:
+     *
+     * *   **char**: string match.
+     * *   **hex**: hexadecimal string match.
+     *
+     * @example
+     * char
+     */
+    method?: string;
+    /**
+     * @remarks
+     * The name of the rule.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * test****
+     */
+    name?: string;
+    /**
+     * @remarks
+     * The priority of the rule. Valid values: **1** to **100**.
+     *
+     * >  A smaller value indicates a higher priority.
+     *
+     * @example
+     * 1
+     */
+    priority?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ModifyPolicyRequestContentPortRuleList extends $dara.Model {
+    /**
+     * @remarks
+     * The end of the destination port range. Valid values: **0** to **65535**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 65535
+     */
+    dstPortEnd?: number;
+    /**
+     * @remarks
+     * The start of the destination port range. Valid values: **0** to **65535**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 0
+     */
+    dstPortStart?: number;
+    /**
+     * @remarks
+     * The ID of the rule.
+     *
+     * @example
+     * c52c2fa6-fdac-40c4-8753-be7c*********
+     */
+    id?: string;
+    /**
+     * @remarks
+     * The action triggered if the rule is matched. Valid values:
+     *
+     * *   **drop**: The traffic is discarded.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * drop
+     */
+    matchAction?: string;
+    /**
+     * @remarks
+     * The type of the protocol. Valid values:
+     *
+     * *   **tcp**
+     * *   **udp**
+     *
+     * This parameter is required.
+     *
+     * @example
+     * tcp
+     */
+    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.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 1
+     */
+    seqNo?: number;
+    /**
+     * @remarks
+     * The end of the source port range. Valid values: **0** to **65535**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 65535
+     */
+    srcPortEnd?: number;
+    /**
+     * @remarks
+     * The start of the source port range. Valid values: **0** to **65535**.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 0
+     */
+    srcPortStart?: 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.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 120
+     */
+    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.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 60
+     */
+    everySeconds?: number;
+    /**
+     * @remarks
+     * The number of times that the source IP address exceeds a limit in a statistical period.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 5
+     */
+    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.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 3
+     */
+    type?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ModifyPolicyRequestContentSourceLimit extends $dara.Model {
+    /**
+     * @remarks
+     * The bandwidth limit on source IP addresses. Unit: bytes per second.
+     *
+     * @example
+     * 2048
+     */
+    bps?: number;
+    /**
+     * @remarks
+     * The packets per second (pps) limit on source IP addresses.
+     *
+     * @example
+     * 64
+     */
+    pps?: number;
+    /**
+     * @remarks
+     * The bandwidth limit on source SYN packets. Unit: bytes per second.
+     *
+     * @example
+     * 2048
+     */
+    synBps?: number;
+    /**
+     * @remarks
+     * The pps limit on source SYN packets.
+     *
+     * @example
+     * 64
+     */
+    synPps?: number;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ModifyPolicyRequestContent extends $dara.Model {
+    /**
+     * @remarks
+     * The IP addresses in the blacklist.
+     */
+    blackIpList?: string[];
+    /**
+     * @remarks
+     * The validity period of the IP address blacklist. The value is a UNIX timestamp.
+     *
+     * @example
+     * 1716878000
+     */
+    blackIpListExpireAt?: number;
+    /**
+     * @remarks
+     * Specifies whether to enable ICMP blocking.
+     *
+     * @example
+     * true
+     */
+    enableDropIcmp?: boolean;
+    /**
+     * @remarks
+     * Specifies whether to enable intelligent protection.
+     *
+     * @example
+     * true
+     */
+    enableIntelligence?: boolean;
+    /**
+     * @remarks
+     * Specifies whether to enable port-specific mitigation.
+     *
+     * @example
+     * true
+     */
+    enableL4Defense?: boolean;
+    /**
+     * @remarks
+     * The byte-match filter rules.
+     */
+    fingerPrintRuleList?: ModifyPolicyRequestContentFingerPrintRuleList[];
+    /**
+     * @remarks
+     * The level of intelligent protection. Valid values:
+     *
+     * *   **default**: normal.
+     * *   **hard**: strict.
+     * *   **weak**: loose.
+     *
+     * @example
+     * default
+     */
+    intelligenceLevel?: string;
+    /**
+     * @remarks
+     * The port-specific mitigation rules.
+     */
+    l4RuleList?: ModifyPolicyRequestContentL4RuleList[];
+    /**
+     * @remarks
+     * The port blocking rules.
+     */
+    portRuleList?: ModifyPolicyRequestContentPortRuleList[];
+    /**
+     * @remarks
+     * The ports whose traffic is filtered out by the filtering policies for UDP reflection attacks.
+     */
+    reflectBlockUdpPortList?: number[];
+    /**
+     * @remarks
+     * The countries in the location blacklist.
+     */
+    regionBlockCountryList?: number[];
+    /**
+     * @remarks
+     * The provinces in the location blacklist.
+     */
+    regionBlockProvinceList?: number[];
+    /**
+     * @remarks
+     * The source IP addresses that are added to the blacklist.
+     */
+    sourceBlockList?: ModifyPolicyRequestContentSourceBlockList[];
+    /**
+     * @remarks
+     * The settings for source rate limiting.
+     */
+    sourceLimit?: ModifyPolicyRequestContentSourceLimit;
+    /**
+     * @remarks
+     * The IP addresses in the whitelist.
+     */
+    whiteIpList?: string[];
+    /**
+     * @remarks
+     * Specifies whether to add back-to-origin CIDR blocks of Anti-DDoS Proxy to the whitelist.
+     *
+     * @example
+     * false
+     */
+    whitenGfbrNets?: boolean;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+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.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * 11
+     */
+    actionType?: number;
+    /**
+     * @remarks
+     * The policy content.
+     */
+    content?: ModifyPolicyRequestContent;
+    /**
+     * @remarks
+     * The ID of the policy.
+     *
+     * This parameter is required.
+     *
+     * @example
+     * c52c2fa6-fdac-40c4-8753-be7c********
+     */
+    id?: string;
+    /**
+     * @remarks
+     * The name of the policy.
+     *
+     * @example
+     * demo**
+     */
+    name?: string;
+    portVersion?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}