Help Center/ Anti-DDoS Service/ API Reference/ AAD APIs/ AAD Forwarding Rule Management/ Querying a Forwarding Rule
Updated on 2026-01-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying a Forwarding Rule

Function

This API is used to query forwarding rules.

Calling Method

For details, see Calling APIs.

URI

GET /v2/aad/forward-rules

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

ip

Yes

String

AAD IP address

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

token

Content-Type

Yes

String

Content-Type

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

total

protocol_rule

Array of ListRulesByIpProtocolRule objects

rule
Table 4 ListRulesByIpProtocolRule

Parameter

Type

Description

rule_id

String

Rule ID

forward_protocol

String

Forwarding protocol

forward_port

Integer

Forwarding port.

source_protocol

String

Origin protocol

source_port

Integer

Source port

lvs_rule

String

Forwarding mode

source_ip

String

Origin server IP address

status

Integer

Status. 0: processing; 1: normal; 2: abnormal

type

Integer

0: website; 1: non-website

switchs

Integer

0: enabled; 2: disabled

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Error description.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Error response

Error Codes

See Error Codes.

Parent Topic: AAD Forwarding Rule Management