ddos detection agent

Configure DDoS detection agent

agent Specification

Parameter	Value
Type	Collection
Object Key(s)	agent-name
Collection Name	agent-list
Collection URI	/axapi/v3/ddos/detection/agent
Element Name	agent
Element URI	/axapi/v3/ddos/detection/agent/{agent-name}
Element Attributes	agent_attributes
Partition Visibility	shared
Statistics Data URI	/axapi/v3/ddos/detection/agent/{agent-name}/stats
Schema	agent schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/ddos/detection/agent	agent attributes	example close
POST /axapi/v3/ddos/detection/agent/ Payload: { "agent": { "agent-name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/ddos/detection/agent	agent attributes
Get Object	GET	/axapi/v3/ddos/detection/agent/{agent-name}	agent attributes	example close
GET /axapi/v3/ddos/detection/agent/a Reponse: { "agent": { "agent-name": "a", "uuid": "351c6394-6213-11ef-9141-001fa0077810", "user-tag": "a", "a10-url": "/axapi/v3/ddos/detection/agent/a" } }
Get List	GET	/axapi/v3/ddos/detection/agent	agent-list
Modify Object	POST	/axapi/v3/ddos/detection/agent/{agent-name}	agent attributes
Replace Object	PUT	/axapi/v3/ddos/detection/agent/{agent-name}	agent attributes	example close
PUT /axapi/v3/ddos/detection/agent/a Payload: { "agent": { "agent-name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/ddos/detection/agent	agent-list
Delete Object	DELETE	/axapi/v3/ddos/detection/agent/{agent-name}	agent attributes	example close
DELETE /axapi/v3/ddos/detection/agent/a Reponse: { "response": { "status": "OK" } }

agent-list

agent-list is JSON List of agent attributes

agent-list : [

{ agent attributes },

{ agent attributes },

…

]

agent attributes

agent-name

Description Specify name for the agent

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

agent-v4-addr

Description Configure agent’s IPv4 address

Type: string

Format: ipv4-address

agent-v6-addr

Description Configure agent’s IPv6 address

Type: string

Format: ipv6-address

netflow

Description: netflow is a JSON Block. Please see below for netflow

Type: Object

Reference Object: /axapi/v3/ddos/detection/agent/{agent-name}/netflow

sflow

Description: sflow is a JSON Block. Please see below for sflow

Type: Object

Reference Object: /axapi/v3/ddos/detection/agent/{agent-name}/sflow

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

sflow

Specification	Value
Type	object

sflow-pkt-samples-collection

Description ‘enable’: Enable sflow packet samples collection(default); ‘disable’: Disable sflow packet samples collection;

Type: string

Supported Values: enable, disable

Default: enable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

netflow

Specification	Value
Type	object

netflow-samples-collection

Description ‘enable’: Enable Netflow flow samples collection(default); ‘disable’: Disable Netflow flow samples collection;

Type: string

Supported Values: enable, disable

Default: enable

netflow-sampling-rate

Description Configure agent’s netflow sampling rate

Type: number

Range: 1-65535

Default: 1

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters