Help Center/ NAT Gateway/ API Reference/ Private Nat API/ Transit IP Address Tags/ Deleting Tags from a Transit IP Address
Updated on 2023-04-19 GMT+08:00
View PDF

Deleting Tags from a Transit IP Address

Function

  • This API is idempotent.

  • When a tag is deleted, the tag character set is not verified. Before calling this API, encode the API URL. If the key of the tag to be deleted does not exist, 404 is displayed. The tag key cannot be left blank or be an empty string.

Debugging

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

URI

DELETE /v3/{project_id}/transit-ips/{resource_id}/tags/{key}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

key

Yes

String

Specifies the tag key.

Minimum: 1

Maximum: 128

project_id

Yes

String

Specifies the project ID.

Minimum: 1

Maximum: 32

resource_id

Yes

String

Specifies the ID of the transit IP address.

Minimum: 36

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

Minimum: 1

Maximum: 10240

Response Parameters

None

Example Requests

This API is used to delete tags from a transit IP address.

DELETE  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/key1

Example Responses

None

Status Codes

Status Code

Description

204

Tags deleted.

Error Codes

See Error Codes.

Parent topic: Transit IP Address Tags