ddos template sip¶
SIP template Configuration
sip Specification¶
Parameter Value Type Collection Object Key(s) sip-tmpl-name Collection Name sip-list Collection URI /axapi/v3/ddos/template/sip Element Name sip Element URI /axapi/v3/ddos/template/sip/{sip-tmpl-name} Element Attributes sip_attributes Partition Visibility shared Schema sip schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/ddos/template/sip | ||
Create List | POST | /axapi/v3/ddos/template/sip | ||
Get Object | GET | /axapi/v3/ddos/template/sip/{sip-tmpl-name} | ||
Get List | GET | /axapi/v3/ddos/template/sip | ||
Modify Object | POST | /axapi/v3/ddos/template/sip/{sip-tmpl-name} | ||
Replace Object | PUT | /axapi/v3/ddos/template/sip/{sip-tmpl-name} | ||
Replace List | PUT | /axapi/v3/ddos/template/sip | ||
Delete Object | DELETE | /axapi/v3/ddos/template/sip/{sip-tmpl-name} |
sip-list¶
sip-list is JSON List of sip attributes
sip-list : [
]
sip attributes¶
action
Description ‘drop’: Drop packets for sip connection; ‘reset’: Send RST for sip-tcp connection;
Type: string
Supported Values: drop, reset
Default: drop
dst
Description: dst is a JSON Block. Please see below for dst
Type: Object
filter-header-list
Type: List
Reference Object: /axapi/v3/ddos/template/sip/{sip-tmpl-name}/filter-header/{sip-filter-header-seq}
idle-timeout
Description Set the the idle timeout value for sip-tcp connections
Type: number
Range: 1-63
ignore-zero-payload
Description Don’t reset idle timer on packets with zero payload length from clients
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
malformed-sip
Description: malformed-sip is a JSON Block. Please see below for malformed-sip
Type: Object
Reference Object: /axapi/v3/ddos/template/sip/{sip-tmpl-name}/malformed-sip
multi-pu-threshold-distribution
Description: multi-pu-threshold-distribution is a JSON Block. Please see below for multi-pu-threshold-distribution
Type: Object
sip-tmpl-name
Description DDOS SIP Template Name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
src
Description: src is a JSON Block. Please see below for src
Type: Object
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
src¶
Specification Value Type object sip-request-rate-limit
Description: sip-request-rate-limit is a JSON Block. Please see below for src_sip-request-rate-limit
Type: Object
src_sip-request-rate-limit¶
Specification Value Type object method
Description: method is a JSON Block. Please see below for src_sip-request-rate-limit_method
Type: Object
src_sip-request-rate-limit_method¶
Specification Value Type object bye-cfg
Description: bye-cfg is a JSON Block. Please see below for src_sip-request-rate-limit_method_bye-cfg
Type: Object
invite-cfg
Description: invite-cfg is a JSON Block. Please see below for src_sip-request-rate-limit_method_invite-cfg
Type: Object
message-cfg
Description: message-cfg is a JSON Block. Please see below for src_sip-request-rate-limit_method_message-cfg
Type: Object
notify-cfg
Description: notify-cfg is a JSON Block. Please see below for src_sip-request-rate-limit_method_notify-cfg
Type: Object
options-cfg
Description: options-cfg is a JSON Block. Please see below for src_sip-request-rate-limit_method_options-cfg
Type: Object
refer-cfg
Description: refer-cfg is a JSON Block. Please see below for src_sip-request-rate-limit_method_refer-cfg
Type: Object
register-cfg
Description: register-cfg is a JSON Block. Please see below for src_sip-request-rate-limit_method_register-cfg
Type: Object
subscribe-cfg
Description: subscribe-cfg is a JSON Block. Please see below for src_sip-request-rate-limit_method_subscribe-cfg
Type: Object
update-cfg
Description: update-cfg is a JSON Block. Please see below for src_sip-request-rate-limit_method_update-cfg
Type: Object
src_sip-request-rate-limit_method_options-cfg¶
Specification Value Type object src-sip-options-cfg-flag
Description OPTIONS method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-sip-options-rate
Description
Type: number
Range: 1-16000000
src_sip-request-rate-limit_method_refer-cfg¶
Specification Value Type object src-sip-refer-cfg-flag
Description REFER method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-sip-refer-rate
Description
Type: number
Range: 1-16000000
src_sip-request-rate-limit_method_bye-cfg¶
Specification Value Type object src-sip-bye-cfg-flag
Description BYE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-sip-bye-rate
Description
Type: number
Range: 1-16000000
src_sip-request-rate-limit_method_subscribe-cfg¶
Specification Value Type object src-sip-subscribe-cfg-flag
Description SUBSCRIBE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-sip-subscribe-rate
Description
Type: number
Range: 1-16000000
src_sip-request-rate-limit_method_register-cfg¶
Specification Value Type object src-sip-register-cfg-flag
Description REGISTER method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-sip-register-rate
Description
Type: number
Range: 1-16000000
src_sip-request-rate-limit_method_invite-cfg¶
Specification Value Type object src-sip-invite-cfg-flag
Description INVITE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-sip-invite-rate
Description
Type: number
Range: 1-16000000
src_sip-request-rate-limit_method_message-cfg¶
Specification Value Type object src-sip-message-cfg-flag
Description MESSAGE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-sip-message-rate
Description
Type: number
Range: 1-16000000
src_sip-request-rate-limit_method_update-cfg¶
Specification Value Type object src-sip-update-cfg-flag
Description UPDATE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-sip-update-rate
Description
Type: number
Range: 1-16000000
src_sip-request-rate-limit_method_notify-cfg¶
Specification Value Type object src-sip-notify-cfg-flag
Description NOTIFY method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
src-sip-notify-rate
Description
Type: number
Range: 1-16000000
dst¶
Specification Value Type object sip-request-rate-limit
Description: sip-request-rate-limit is a JSON Block. Please see below for dst_sip-request-rate-limit
Type: Object
dst_sip-request-rate-limit¶
Specification Value Type object method
Description: method is a JSON Block. Please see below for dst_sip-request-rate-limit_method
Type: Object
dst_sip-request-rate-limit_method¶
Specification Value Type object bye-cfg
Description: bye-cfg is a JSON Block. Please see below for dst_sip-request-rate-limit_method_bye-cfg
Type: Object
invite-cfg
Description: invite-cfg is a JSON Block. Please see below for dst_sip-request-rate-limit_method_invite-cfg
Type: Object
message-cfg
Description: message-cfg is a JSON Block. Please see below for dst_sip-request-rate-limit_method_message-cfg
Type: Object
notify-cfg
Description: notify-cfg is a JSON Block. Please see below for dst_sip-request-rate-limit_method_notify-cfg
Type: Object
options-cfg
Description: options-cfg is a JSON Block. Please see below for dst_sip-request-rate-limit_method_options-cfg
Type: Object
refer-cfg
Description: refer-cfg is a JSON Block. Please see below for dst_sip-request-rate-limit_method_refer-cfg
Type: Object
register-cfg
Description: register-cfg is a JSON Block. Please see below for dst_sip-request-rate-limit_method_register-cfg
Type: Object
subscribe-cfg
Description: subscribe-cfg is a JSON Block. Please see below for dst_sip-request-rate-limit_method_subscribe-cfg
Type: Object
update-cfg
Description: update-cfg is a JSON Block. Please see below for dst_sip-request-rate-limit_method_update-cfg
Type: Object
dst_sip-request-rate-limit_method_options-cfg¶
Specification Value Type object dst-sip-options-cfg-flag
Description OPTIONS method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-options-rate
Description
Type: number
Range: 1-16000000
dst_sip-request-rate-limit_method_refer-cfg¶
Specification Value Type object dst-sip-refer-cfg-flag
Description REFER method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-refer-rate
Description
Type: number
Range: 1-16000000
dst_sip-request-rate-limit_method_bye-cfg¶
Specification Value Type object dst-sip-bye-cfg-flag
Description BYE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-bye-rate
Description
Type: number
Range: 1-16000000
dst_sip-request-rate-limit_method_subscribe-cfg¶
Specification Value Type object dst-sip-subscribe-cfg-flag
Description SUBSCRIBE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-subscribe-rate
Description
Type: number
Range: 1-16000000
dst_sip-request-rate-limit_method_register-cfg¶
Specification Value Type object dst-sip-register-cfg-flag
Description REGISTER method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-register-rate
Description
Type: number
Range: 1-16000000
dst_sip-request-rate-limit_method_invite-cfg¶
Specification Value Type object dst-sip-invite-cfg-flag
Description INVITE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-invite-rate
Description
Type: number
Range: 1-16000000
dst_sip-request-rate-limit_method_message-cfg¶
Specification Value Type object dst-sip-message-cfg-flag
Description MESSAGE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-message-rate
Description
Type: number
Range: 1-16000000
dst_sip-request-rate-limit_method_update-cfg¶
Specification Value Type object dst-sip-update-cfg-flag
Description UPDATE method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-update-rate
Description
Type: number
Range: 1-16000000
dst_sip-request-rate-limit_method_notify-cfg¶
Specification Value Type object dst-sip-notify-cfg-flag
Description NOTIFY method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-notify-rate
Description
Type: number
Range: 1-16000000
multi-pu-threshold-distribution¶
Specification Value Type object multi-pu-threshold-distribution-disable
Description ‘disable’: Destination side rate limit only. Default: Enable;
Type: string
Supported Values: disable
Mutual Exclusion: multi-pu-threshold-distribution-disable and multi-pu-threshold-distribution-value are mutually exclusive
multi-pu-threshold-distribution-value
Description Destination side rate limit only. Default: 0
Type: number
Range: 1-16000000
Mutual Exclusion: multi-pu-threshold-distribution-value and multi-pu-threshold-distribution-disable are mutually exclusive
malformed-sip¶
Specification Value Type object malformed-sip-call-id-max-length
Description Set the maximum call-id length. Default value is 32511
Type: number
Range: 1-32511
Default: 32511
malformed-sip-check
Description ‘enable-check’: Enable malformed SIP parameters;
Type: string
Supported Values: enable-check
malformed-sip-max-header-name-length
Description Set the maximum header name length. Default value is 63
Type: number
Range: 1-63
Default: 63
malformed-sip-max-header-value-length
Description Set the maximum header value length. Default value is 32511
Type: number
Range: 1-32511
Default: 32511
malformed-sip-max-line-size
Description Set the maximum line size. Default value is 32511
Type: number
Range: 1-32511
Default: 32511
malformed-sip-max-uri-length
Description Set the maximum uri size. Default value is 32511
Type: number
Range: 1-32511
Default: 32511
malformed-sip-sdp-max-length
Description Set the maxinum SDP content length. Default value is 32511
Type: number
Range: 1-32511
Default: 32511
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
filter-header-list¶
Specification Value Type list Block object keys sip-filter-header-blacklist
Description Also blacklist the source when action is taken
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sip-filter-header-count-only
Description Take no action and continue processing the next filter
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sip-filter-header-regex
Description Regex Expression
Type: string
Format: string-rlx
Maximum Length: 1275 characters
Maximum Length: 1 characters
sip-filter-header-seq
Description Sequence number
Type: number
Range: 1-5
sip-filter-header-unmatched
Description action taken when it does not match
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sip-filter-header-whitelist
Description Whitelist the source after filter passes, packets are dropped until then
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters