Help Center/ Cloud Firewall/ API Reference/ API/ IPS Management/ Querying Frequency IPS Rule Information
Updated on 2025-08-11 GMT+08:00

Querying Frequency IPS Rule Information

Function

This API is used to query frequency IPS rule information.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/advanced-ips-rules

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by calling an API or from the console. You can obtain it by referring to Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

object_id

Yes

String

Protected object ID, which is used to distinguish between Internet border protection and VPC border protection after a cloud firewall is created. You can obtain the ID by calling the API for querying firewall instances. In the return value, find the ID in data.records.protect_objects.object_id (The period [.] is used to separate different levels of objects). If type is 0, object_id is the ID of a protected object on the Internet border. If type is 1, object_id is the ID of a protected object on the VPC border. Here, a protected object ID whose type is 1 is used. You can obtain the value of type from data.records.protect_objects.type (The period [.] is used to separate different levels of objects).

enterprise_project_id

No

String

Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by referring to Obtaining a User Token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

AdvancedIpsRuleListVo object

Return value for querying the frequency-based IPS rule list.

Table 5 AdvancedIpsRuleListVo

Parameter

Type

Description

advanced_ips_rules

Array of AdvancedIpsRuleVo objects

Frequency-based IPS rule list.

total

Integer

Total number of frequency-based IPS rules.

Table 6 AdvancedIpsRuleVo

Parameter

Type

Description

action

Integer

Action: 0 (only record logs), 1 (block sessions), or 2 (block IP addresses).

ips_rule_id

String

Frequency-based IPS rule ID.

ips_rule_type

Integer

IPS rule type: 0 (sensitive directory scan), or 1 (reverse shell).

param

String

JSON string used to define a frequency-based IPS rule.

status

Integer

Frequency-based IPS rule status: 0 (disabled), 1 (enabled).

Example Requests

Query the frequency IPS rule information of the project whose ID is 408972e72dcd4c1a9b033e955802a36b. The firewall ID is e743cfaf-8164-4807-aa13-d893d83313cf, the enterprise project ID is fb55459c-41b3-47fc-885d-540946fddda4, and the target object ID is 1b90f031-0c7b-4f25-95e2-b6d9940d269e.

https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/advanced-ips-rules?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4&object_id=1b90f031-0c7b-4f25-95e2-b6d9940d269e

Example Responses

Status code: 200

Return value for querying a frequency-based IPS rule.

{
  "data" : {
    "advanced_ips_rules" : [ {
      "action" : 0,
      "ips_rule_id" : "7d453586-524f-4a1d-a827-34d80389378f",
      "ips_rule_type" : 0,
      "param" : "{\"mode\":0}",
      "status" : 1
    }, {
      "action" : 0,
      "ips_rule_id" : "ed184f33-b4e2-4c42-9562-313563e60b7c",
      "ips_rule_type" : 1,
      "param" : "{\"threshold\":10}",
      "status" : 1
    } ],
    "total" : 2
  }
}

Status Codes

Status Code

Description

200

Return value for querying a frequency-based IPS rule.

401

Unauthorized: Request error.

403

Forbidden: Access forbidden.

404

Not Found: Web page not found.

Error Codes

See Error Codes.