Help Center/ Web Application Firewall/ API Reference/ APIs/ Policy and Rule Management/ Querying IP Intelligence Protection Rules by ID
Updated on 2025-08-19 GMT+08:00

Querying IP Intelligence Protection Rules by ID

Function

This API is used to query IP intelligence protection rules by ID.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/waf/policy/{policy_id}/ip-reputation/{rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

project_id

Constraints

N/A

Range

N/A

Default Value

''

policy_id

Yes

String

Definition

policyid

Constraints

N/A

Range

N/A

Default Value

''

rule_id

Yes

String

Definition

geoipRuleId

Constraints

N/A

Range

N/A

Default Value

''

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

auth token

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

N/A

Default Value

application/json;charset=utf8

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Definition

Rule ID, which uniquely identifies a rule.

Constraints

N/A

Range

N/A

Default Value

N/A

policyid

String

Definition

Protection policy ID.

Constraints

N/A

Range

N/A

Default Value

N/A

name

String

Definition

Rule name.

Constraints

N/A

Range

N/A

Default Value

N/A

timestamp

Integer

Definition

Timestamp of the last rule update (in ms)

Constraints

N/A

Range

N/A

Default Value

N/A

description

String

Definition

Rule description.

Constraints

N/A

Range

N/A

Default Value

N/A

status

Integer

Definition

Rule status. 1: enabled. 0: disabled.

Constraints

N/A

Range

N/A

Default Value

N/A

type

String

Definition

Rule type, for example, idc indicates the data center IP intelligence type.

Constraints

N/A

Range

N/A

Default Value

N/A

tags

Array of strings

Definition

List of tags associated with the rule.

Constraints

N/A

Range

N/A

Default Value

N/A

action

action object

Definition

Protective action configuration.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 action

Parameter

Type

Description

category

String

Definition

Action type, for example, log indicates that attacks are logged only.

Constraints

N/A

Range

N/A

Default Value

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 6 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 8 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

encoded_authorization_message

String

You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs.

details

Array of IAM5ErrorDetails objects

The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs.

Table 10 IAM5ErrorDetails

Parameter

Type

Description

error_code

String

Error codes of the downstream service.

error_msg

String

Error messages of the downstream service.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.