List Acl Rule Tags

Function

This API is used to list acl rule tags.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/cfw-acl/tags

**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	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.
fw_instance_id	Yes	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.
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.
limit	Yes	Integer	Number of records displayed on each page, in the range 1-1024

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	HttpGetAclTagResponseData object

**Table 5** HttpGetAclTagResponseData
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, in the range 1-1024
total	Integer	total
records	Array of TagsVO objects	tag vos

**Table 6** TagsVO
Parameter	Type	Description
tag_id	String	tag id
tag_key	String	tag key
tag_value	String	tag value

Example Requests

Query the existing ACL tags of the firewall whose ID is 546af3f8-88e9-47f2-a205-2346d7090925 in the project whose ID is 14181c1245cf4fd786824efe1e2b9388.

https://{Endpoint}/v2/14181c1245cf4fd786824efe1e2b9388/cfw-acl/tags?limit=1000&offset=0&fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default

Example Responses

Status code: 200

Get acl tag response

{
  "data" : {
    "limit" : 1000,
    "offset" : 0,
    "records" : [ {
      "tag_id" : "98fdf013-e7ad-4581-9c71-6de04c76a18f",
      "tag_key" : "1",
      "tag_value" : "1"
    }, {
      "tag_id" : "36e6fbfe-7fcd-48be-872b-4f6074e1e4e8",
      "tag_key" : "1",
      "tag_value" : "2"
    }, {
      "tag_id" : "0bf41046-6587-42f2-8399-a6864022b504",
      "tag_key" : "test",
      "tag_value" : "test"
    } ],
    "total" : 3
  }
}