Help Center/ Host Security Service/ API Reference/ API Description/ Event Management/ Querying the List of Blocked IP Addresses
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying the List of Blocked IP Addresses

Function

This API is used to query the list of blocked IP addresses.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/event/blocked-ip

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

ID of the enterprise project that a server belongs.

An enterprise project can be configured only after the enterprise project function is enabled.

Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission.

last_days

No

Integer

Number of days to be queried. This parameter is manually exclusive with begin_time and end_time.

host_name

No

String

Server name

src_ip

No

String

Attack source IP address

intercept_status

No

String

Definition

Blocking status.

Constraints

N/A

Range

  • intercepted: blocked

  • canceled: unblocked

  • cancelling: waiting to be unblocked

Default Value

N/A

offset

No

Integer

Offset, which specifies the start position of the record to be returned.

limit

No

Integer

Number of records displayed on each page.

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 a token.

region

No

String

Region ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Definition

Total number.

Range

The value range is 0 to 2,147,483,647.

data_list

Array of BlockedIpResponseInfo objects

Blocked IP address details
Table 5 BlockedIpResponseInfo

Parameter

Type

Description

host_id

String

Definition

Unique ID of a server (host).

Range

The value can contain 1 to 64 characters.

host_name

String

Definition

Server name.

Range

The value can contain 1 to 256 characters.

src_ip

String

Attack source IP address

login_type

String

Definition

Sign-in method

Constraints

N/A

Range

  • mysql

  • rdp

  • ssh

  • vsftp

Default Value

N/A

intercept_num

Integer

Blocks

intercept_status

String

Definition

Blocking status.

Constraints

N/A

Range

  • intercepted: blocked

  • canceled: unblocked

  • cancelling: waiting to be unblocked

Default Value

N/A

block_time

Long

Interception start time, in milliseconds.

latest_time

Long

Latest interception time, in milliseconds.

Example Requests

Query the first 10 blocked IP addresses.

GET https://{endpoint}/v5/{project_id}/event/blocked-ip?limit=10&offset=0&enterprise_project_id=xxx

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "block_time" : 1698715135407,
    "host_id" : "1c62fe52-0c84-4ee4-8dba-d892c5ad0ab0",
    "host_name" : "dfx-a00607964-0011",
    "intercept_num" : 230,
    "intercept_status" : "canceled",
    "latest_time" : 1698715296786,
    "login_type" : "ssh",
    "src_ip" : "100.85.239.180"
  } ],
  "total_num" : 1
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Event Management