Help Center/ Anti-DDoS/ API Reference/ API/ DDoS Protection Management/ Querying the Defense Status of a Specified EIP
Updated on 2025-10-09 GMT+08:00
View PDF

Querying the Defense Status of a Specified EIP

Function

This API is used to query the defense status of a specified EIP.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/antiddos/{floating_ip_id}/status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

floating_ip_id

Yes

String

ID corresponding to the EIP of a user.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

ip

No

String

EIP of a user.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

Content-Type request header.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Protection status. The options are as follows:

  • normal: normal

  • configging: configuration in progress

  • notConfig: not configured

  • packetcleaning: cleaning

  • packetdropping: blackhole

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "status" : "normal"
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.