Batch Adding or Deleting Tags to or from a Public NAT Gateway
Function
This API is used to batch add or delete tags to or from a public NAT gateway.
Tag Management Service (TMS) needs to use this API to manage tags of resources in batches.
A resource can have up to 20 tags.
Constraints
-
-
If there are duplicate keys in the request body when you add tags, an error is reported.
-
If a tag to be added has the same key as an existing tag, the tag will be added and overwrite the existing one.
-
During tag deletion, if some tags to be deleted do not exist, the operation is considered to be successful by default. The character set of the tags will not be verified. A key can contain up to 128 Unicode characters, and a value can contain up to 255 Unicode characters. In addition, the tags structure cannot be missing, and key cannot be left blank or be an empty string.
-
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
URI
POST /v3/{project_id}/nat_gateways/{nat_gateway_id}/tags/action
|
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
|
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 value. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
tags |
Yes |
Array of PublicTags objects |
Specifies the tag list. For details, see the Tags field description. |
|
action |
Yes |
String |
Specifies the operation to perform. The value can be: |
|
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 non-printable ASCII characters (0–31) or the following special characters: =*<>,|/ |
|
value |
Yes |
String |
Specifies the value. Each value can contain up to 255 Unicode characters. If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key. value can be an empty string. A value cannot contain non-printable ASCII characters (0–31) or the following special characters: =*<>,|/ |
Response Parameters
Status code: 204
Tags added or deleted.
None
Example Requests
-
Adding tags to a public NAT gateway (Setting action to create and adding the following two tags: key1,value1 and key2,value2)
POST https://{NAT_endpoint}/v3/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags/action { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] } -
Deleting tags from a public NAT gateway (Setting action to delete and deleting the following two tags: key1,value1 and key2,value2)
{ "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
204 |
Tags added or deleted. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.