Creating a Tag¶

Function¶

This API is used to create a tag.

URI¶

POST /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/create

**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. For details, see Obtaining a Project ID.
fw_instance_id	Yes	String	Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

Request Parameters¶

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by referring to Obtaining a User Token.
Content-Type	Yes	String	Content type. It can only be set to application/json.

**Table 3** Request body parameters¶
Parameter	Mandatory	Type	Description
tags	No	Array of CreateTag objects	Create a firewall tag list.

**Table 4** CreateTag¶
Parameter	Mandatory	Type	Description
key	No	String	Tag key.
value	No	String	Tag value.

Response Parameters¶

Status code: 200

**Table 5** Response body parameters¶
Parameter	Type	Description
`-`	String

Example Requests¶

Add a tag whose key is keytest and value is valuetest to firewall 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 in project 0b2179bbe180d3762fb0c01a2d5725c7.

https://{Endpoint}/v2/0b2179bbe180d3762fb0c01a2d5725c7/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/create

{
  "tags" : [ {
    "key" : "keytest",
    "value" : "valuetest"
  } ]
}

Example Responses¶

None

Status Codes¶

Status Code	Description
200	OK

Error Codes¶

See Error Codes.

last updated: 2025-01-21 13:19 UTC - commit: abe94c6df6d30c3b44340c2119ffd81f9990504a