Help Center/ Anti-DDoS/ API Reference/ API/ Anti-DDoS Management/ Querying the List of Defense Statuses of EIPs

Updated on 2024-09-12 GMT+08:00

View PDF

Querying the List of Defense Statuses of EIPs

Function

URI

GET /v1/{project_id}/antiddos

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	poject id Minimum: 32 Maximum: 64

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
status	No	String	status
limit	No	String	Maximum number of returned results. The value ranges from 1 to 100.
offset	No	String	Offset. The value ranges from 0 to 2147483647.
ip	No	String	IP address. Both IPv4 and IPv6 addresses are supported. For example, if you enter ?ip=192.168, the defense status of EIPs corresponding to 192.168.111.1 and 10.192.168.8 is returned.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	token Minimum: 32 Maximum: 2097152
Content-Type	Yes	String	Default: application/json;charset=utf8

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	total count
ddosStatus	Array of DDosStatus objects	Anti-DDoS status

**Table 5** DDosStatus
Parameter	Type	Description
floating_ip_id	String	ID of an EIP
floating_ip_address	String	IP address. Both IPv4 and IPv6 addresses are supported. For example, if you enter ?ip=192.168, the defense status of EIPs corresponding to 192.168.111.1 and 10.192.168.8 is returned.
network_type	String	EIP type. The value can be: EIP: EIP that is bound or not bound with ECS. ELB: EIP that is bound with ELB.
status	String	Defense status
blackhole_endtime	Long	The end time of blackhole
protect_type	String	Protect type
traffic_threshold	Long	Threshold of traffic
http_threshold	Long	Threshold of http traffic

Example Requests

None

Example Responses

Status code: 200

{
  "total" : 1,
  "ddosStatus" : [ {
    "floating_ip_id" : "18e6ace5-eb36-4196-a15e-1e000c24e026",
    "floating_ip_address" : "139.9.116.167",
    "network_type" : "EIP",
    "status" : "normal",
    "blackhole_endtime" : 0,
    "protect_type" : "default",
    "traffic_threshold" : 99,
    "http_threshold" : 0
  } ]
}