Updated on 2024-04-19 GMT+08:00

Adding a Tag to a Public NAT Gateway

Function

  • This API is used to add a tag to a public NAT gateway. A resource can have up to 10 tags.

Constraints

  • You need to add the VPC domain name when calling the API for managing public NAT gateway tags.

  • This API is idempotent.

    • If a tag to be added has the same key as an existing tag, the tag will be added and overwrite the existing one.

  • Ensure that a NAT gateway is available.

Calling Method

For details, see Calling APIs.

URI

POST /v2.0/{project_id}/nat_gateways/{nat_gateway_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

nat_gateway_id

Yes

String

Specifies the public NAT gateway ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tag

Yes

TagBody object

Specifies the tag list. For details, see the TagBody field description.

Table 4 TagBody

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key. A key can contain up to 128 Unicode characters. key cannot be left blank. A key cannot contain ASCII characters (0–31 decimal) nor the following characters:=*<>,|/

value

Yes

String

Specifies the tag value. Each value can contain up to 255 Unicode characters and can be an empty string. A value cannot contain ASCII characters (0–31 decimal) nor the following characters:=*<>,|/

Response Parameters

None

Example Requests

Adding a tag to a public NAT gateway (Setting key to key1 and value to value1)

POST  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags

{
  "tag" : {
    "key" : "key1",
    "value" : "value1"
  }
}

Example Responses

None

Status Codes

Status Code

Description

204

Tag added.

Error Codes

See Error Codes.