Updated on 2024-10-11 GMT+08:00

Adding a Tag to a Network ACL

Function

This API is used to add a tag to a specific network ACL. This is an idempotent API. If the new tag has the same key as an existing tag, the tag will be created and overwrite the existing one.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

POST /v3/{project_id}/firewalls/{firewall_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

firewall_id

Yes

String

The unique ID of a network ACL.

The value is a string in UUID format.

The network ACL with a given ID must exist.

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

tag

Yes

ResourceTag object

Request body for adding tags to a network ACL.

Table 3 ResourceTag

Parameter

Mandatory

Type

Description

key

Yes

String

  • Tag key

  • Tag keys must be unique for each resource.

Minimum: 1

Maximum: 128

value

Yes

String

  • Tag value.

Maximum: 255

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

error_msg

String

Error message.

error_code

String

Error code.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

error_msg

String

Error message.

error_code

String

Error code.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

error_msg

String

Error message.

error_code

String

Error code.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

error_msg

String

Error message.

error_code

String

Error code.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

Add a tag to a network ACL. Set the tag key to key4 and tag value to value4.

POST https://{Endpoint}/v3/{project_id}/firewalls/{firewall_id}/tags

{
  "tag" : {
    "key" : "key4",
    "value" : "value4"
  }
}

Example Responses

None

Status Codes

Status Code

Description

204

Normal request response

400

Invalid parameter

401

Authentication failure

403

Insufficient permissions

404

Not found

500

System exception

Error Codes

See Error Codes.