ddos zone-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/zone-template/sip Element Name sip Element URI /axapi/v3/ddos/zone-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/zone-template/sip | ||
Create List | POST | /axapi/v3/ddos/zone-template/sip | ||
Get Object | GET | /axapi/v3/ddos/zone-template/sip/{sip-tmpl-name} | ||
Get List | GET | /axapi/v3/ddos/zone-template/sip | ||
Modify Object | POST | /axapi/v3/ddos/zone-template/sip/{sip-tmpl-name} | ||
Replace Object | PUT | /axapi/v3/ddos/zone-template/sip/{sip-tmpl-name} | ||
Replace List | PUT | /axapi/v3/ddos/zone-template/sip | ||
Delete Object | DELETE | /axapi/v3/ddos/zone-template/sip/{sip-tmpl-name} |
sip-list¶
sip-list is JSON List of sip attributes
sip-list : [
]
sip attributes¶
dst
Description: dst is a JSON Block. Please see below for dst
Type: Object
filter-header-list
Type: List
Reference Object: /axapi/v3/ddos/zone-template/sip/{sip-tmpl-name}/filter-header/{sip-filter-name}
idle-timeout
Description: idle-timeout is a JSON Block. Please see below for idle-timeout
Type: Object
malformed-sip
Description: malformed-sip is a JSON Block. Please see below for malformed-sip
Type: Object
Reference Object: /axapi/v3/ddos/zone-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-rate-action
Description ‘drop’: Drop packets(Default); ‘ignore’: Take no action; ‘reset’: Reset (sip-tcp) client connection; ‘blacklist-src’: Blacklist-src;
Type: string
Supported Values: drop, ignore, reset, blacklist-src
Default: drop
Mutual Exclusion: src-sip-rate-action and src-sip-rate-action-list-name are mutually exclusive
src-sip-rate-action-list-name
Description Configure action-list to take
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: src-sip-rate-action-list-name and src-sip-rate-action are mutually exclusive
Reference Object: /axapi/v3/ddos/action-list
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 OPTIONS
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 REFER
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 BYE
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 SUBSCRIBE
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 REGISTER
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 INVITE
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 MESSAGE
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 UPDATE
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 NOTIFY
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 dst-sip-rate-action
Description ‘drop’: Drop packets(Default); ‘ignore’: Take no action; ‘reset’: Reset (sip-tcp) client connection; ‘blacklist-src’: Blacklist-src;
Type: string
Supported Values: drop, ignore, reset, blacklist-src
Default: drop
Mutual Exclusion: dst-sip-rate-action and dst-sip-rate-action-list-name are mutually exclusive
dst-sip-rate-action-list-name
Description Configure action-list to take
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: dst-sip-rate-action-list-name and dst-sip-rate-action are mutually exclusive
Reference Object: /axapi/v3/ddos/action-list
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 OPTIONS
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 REFER
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 BYE
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 SUBSCRIBE
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 REGISTER
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 INVITE
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 MESSAGE
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 UPDATE
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 NOTIFY
Description NOTIFY method
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dst-sip-notify-rate
Description
Type: number
Range: 1-16000000
idle-timeout¶
Specification Value Type object idle-timeout-action
Description ‘drop’: Drop packets (Default); ‘blacklist-src’: Blacklist-src; ‘reset’: Reset (sip-tcp) client connection;
Type: string
Supported Values: drop, blacklist-src, reset
Mutual Exclusion: idle-timeout-action and idle-timeout-action-list-name are mutually exclusive
idle-timeout-action-list-name
Description Configure action-list to take
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: idle-timeout-action-list-name and idle-timeout-action are mutually exclusive
Reference Object: /axapi/v3/ddos/action-list
idle-timeout-value
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
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-action
Description ‘drop’: Drop packets (Default); ‘reset’: Reset (sip-tcp) client connection; ‘blacklist-src’: Blacklist-src;
Type: string
Supported Values: drop, reset, blacklist-src
Default: drop
Mutual Exclusion: malformed-sip-action and malformed-sip-action-list-name are mutually exclusive
malformed-sip-action-list-name
Description Configure action-list to take
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: malformed-sip-action-list-name and malformed-sip-action are mutually exclusive
Reference Object: /axapi/v3/ddos/action-list
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-action
Description ‘drop’: Drop packets (Default); ‘ignore’: Take no action; ‘blacklist-src’: Blacklist-src; ‘authenticate-src’: Authenticate-src; ‘reset’: Reset client connection(for sip-tcp);
Type: string
Supported Values: drop, ignore, blacklist-src, authenticate-src, reset
Mutual Exclusion: sip-filter-action and sip-filter-action-list-name are mutually exclusive
sip-filter-action-list-name
Description Configure action-list to take
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: sip-filter-action-list-name and sip-filter-action are mutually exclusive
Reference Object: /axapi/v3/ddos/action-list
sip-filter-header-seq
Description Sequence number
Type: number
Range: 1-200
sip-filter-name
Description
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
sip-header-cfg
Description: sip-header-cfg is a JSON Block. Please see below for filter-header-list_sip-header-cfg
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
filter-header-list_sip-header-cfg¶
Specification Value Type object sip-filter-header-inverse-match
Description
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