Help Center/ Cloud Firewall/ API Reference/ API/ ACL Rule Management/ Querying a Protection Rule
Updated on 2023-12-06 GMT+08:00
View PDF

Querying a Protection Rule

Function

This API is used to query a protection rule.

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

URI

GET /v1/{project_id}/acl-rules

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

object_id

Yes

String

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

type

No

Integer

Specifies the rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

Enumeration values:

  • 0

  • 1

  • 2

protocol

No

Integer

Protocol type. The value is 6 for TCP, 17 for UDP, 1 for ICMP, 58 for ICMPv6, and -1 for any protocol.

Enumeration values:

  • 6

  • 17

  • 1

  • 58

ip

No

String

IP address

name

No

String

Name

direction

No

Integer

Direction. 0: inbound; 1: outbound

status

No

Integer

Indicates the rule delivery status. 0: disabled; 1: enabled.

Enumeration values:

  • 0

  • 1

action_type

No

Integer

Action. 0: allow; 1: deny

Enumeration values:

  • 0

  • 1

address_type

No

Integer

Address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain).

Enumeration values:

  • 0

  • 1

  • 2

limit

Yes

Integer

Number of records displayed on each page

offset

Yes

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

enterprise_project_id

No

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

fw_instance_id

No

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

data object

data
Table 5 data

Parameter

Type

Description

offset

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.

limit

Integer

Number of records displayed on each page

total

Integer

Total number of queried records

object_id

String

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

records

Array of records objects

records
Table 6 records

Parameter

Type

Description

rule_id

String

Rule ID

address_type

Integer

Address type. The value can be 0 (IPv4) or 1 (IPv6).

name

String

Rule name

sequence

OrderRuleAclDto object

UpdateRuleAclDto

direction

Integer

Rule direction. 0: inbound; 1: outbound

Enumeration values:

  • 0

  • 1

action_type

Integer

Action. 0: allow; 1: deny

status

Integer

Rule delivery status. 0: disabled; 1: enabled.

description

String

Description

long_connect_time_hour

Long

Persistent connection duration (hour)

long_connect_time_minute

Long

Persistent connection duration (hour)

long_connect_time_second

Long

Persistent connection duration (hour)

long_connect_time

Long

Persistent connection duration

long_connect_enable

Integer

Persistent connection support

source

RuleAddressDto object

Source address transmission object

destination

RuleAddressDto object

destination

service

RuleServiceDto object

service

type

Integer

Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule).

Enumeration values:

  • 0

  • 1

  • 2
Table 7 OrderRuleAclDto

Parameter

Type

Description

dest_rule_id

String

ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top.

top

Integer

Whether to pin on top. The options are as follows: 0: no; 1: yes.
Table 8 RuleAddressDto

Parameter

Type

Description

type

Integer

Source type. 0: manual input; 1: associated IP address group; 2: domain name

address_type

Integer

Source type. 0: IPv4; 1: IPv6

address

String

Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type.

address_set_id

String

ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type.

address_set_name

String

IP address group name

domain_address_name

String

Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type.
Table 9 RuleServiceDto

Parameter

Type

Description

type

Integer

Service input type. The value 0 indicates manual input, and the value 1 indicates automatic input.

protocol

Integer

Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added.

source_port

String

Source port

dest_port

String

Destination port

service_set_id

String

Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type.

service_set_name

String

Service group name

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code

Minimum: 8

Maximum: 36

error_msg

String

Description

Minimum: 2

Maximum: 512

Example Requests

Query the data whose project ID is 9d80d070b6d44942af73c9c3d38e0429, project ID is e12bd2cd-ebfc-4af7-ad6f-ebe6da398029, and size is 10.

https://{Endpoint}/cfw/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0

Example Responses

Status code: 200

OK

{
  "data" : {
    "limit" : 10,
    "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2",
    "offset" : 0,
    "records" : [ {
      "action_type" : 0,
      "address_type" : 0,
      "destination" : {
        "address" : "0.0.0.0/0",
        "address_type" : 0,
        "type" : 0
      },
      "direction" : 1,
      "long_connect_enable" : 0,
      "name" : "eip_ipv4_n_w_allow",
      "rule_id" : "ffe9af47-d893-483b-86e3-ee5242e8cb15",
      "service" : {
        "dest_port" : "0",
        "protocol" : -1,
        "source_port" : "0",
        "type" : 0
      },
      "source" : {
        "address_set_id" : "48bfb09b-6f3a-4371-8ddb-05d5d7148bcc",
        "address_set_name" : "ip_group",
        "address_type" : 0,
        "type" : 1
      },
      "status" : 1,
      "type" : "0"
    } ],
    "total" : 1
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.0020016",
  "error_msg" : "instance status error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: ACL Rule Management