Batch Adding Tags to or Deleting Tags from a Private NAT Gateway
Function
This API is used to batch add tags to or delete tags from a private NAT gateway.
TMS uses this API to batch manage tags of a private NAT gateway.
A private NAT gateway can have up to 10 tags.
Constraints
This API is idempotent.
If the request body contains duplicate keys, an error is reported.
During tag creation, duplicate keys are not allowed. If a key already exists in the database, its value will be overwritten by the new duplicate key.
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.
The tags structure cannot be missing during deletion. The 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
POST /v3/{project_id}/private-nat-gateways/{resource_id}/tags/action
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 1 Maximum: 32 |
resource_id |
Yes |
String |
Specifies the private NAT gateway ID. Minimum: 36 Maximum: 36 |
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
Yes |
String |
Specifies the operation to perform. The value can be: create delete Enumeration values:
|
tags |
Yes |
Array of Tag objects |
Specifies the tags. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Specifies any tag that is not included. Each tag can contain a maximum of 10 keys, and each key can contain a maximum of 10 values. The structure body cannot be missing, and the key cannot be left blank or set to an empty string. Keys must be unique and values of a key must be unique. Resources not identified by different keys are in OR relationship, and values in one tag are in OR relationship. If no filtering condition is specified, full data is returned. Minimum: 1 Maximum: 128 |
value |
Yes |
String |
Specifies the request ID. Minimum: 0 Maximum: 255 |
Response Parameters
None
Example Requests
Batch adding tags to a private NAT gateway
POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
Batch deleting tags from a private NAT gateway
POST https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat-gateways/3320166e-b937-40cc-a35c-02cd3f2b3ee2/tags/action { "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.