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
-
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 /v3/{project_id}/nat_gateways/{nat_gateway_id}/tags
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 |
---|---|---|---|
tag |
Yes |
TagBody object |
Specifies the tag list. For details, see the TagBody field description. |
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://{NAT_endpoint}/v3/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags
{
"tag" : {
"key" : "key1",
"value" : "value1"
}
}
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Adding a tag to a public NAT gateway (Setting key to key1 and value to value1)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.nat.v2.region.NatRegion;
import com.huaweicloud.sdk.nat.v2.*;
import com.huaweicloud.sdk.nat.v2.model.*;
public class CreateNatGatewayTagSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
NatClient client = NatClient.newBuilder()
.withCredential(auth)
.withRegion(NatRegion.valueOf("<YOUR REGION>"))
.build();
CreateNatGatewayTagRequest request = new CreateNatGatewayTagRequest();
request.withNatGatewayId("{nat_gateway_id}");
CreateNatTagRequestBody body = new CreateNatTagRequestBody();
TagBody tagbody = new TagBody();
tagbody.withKey("key1")
.withValue("value1");
body.withTag(tagbody);
request.withBody(body);
try {
CreateNatGatewayTagResponse response = client.createNatGatewayTag(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
Adding a tag to a public NAT gateway (Setting key to key1 and value to value1)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdknat.v2.region.nat_region import NatRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdknat.v2 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = NatClient.new_builder() \
.with_credentials(credentials) \
.with_region(NatRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateNatGatewayTagRequest()
request.nat_gateway_id = "{nat_gateway_id}"
tagbody = TagBody(
key="key1",
value="value1"
)
request.body = CreateNatTagRequestBody(
tag=tagbody
)
response = client.create_nat_gateway_tag(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
Adding a tag to a public NAT gateway (Setting key to key1 and value to value1)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := nat.NewNatClient(
nat.NatClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateNatGatewayTagRequest{}
request.NatGatewayId = "{nat_gateway_id}"
tagbody := &model.TagBody{
Key: "key1",
Value: "value1",
}
request.Body = &model.CreateNatTagRequestBody{
Tag: tagbody,
}
response, err := client.CreateNatGatewayTag(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Adding a tag to a public NAT gateway (Setting key to key1 and value to value1)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.nat.v2.region.NatRegion;
import com.huaweicloud.sdk.nat.v2.*;
import com.huaweicloud.sdk.nat.v2.model.*;
public class CreateNatGatewayTagSolution {
public static void main(String[] args) {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
String ak = System.getenv("CLOUD_SDK_AK");
String sk = System.getenv("CLOUD_SDK_SK");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
NatClient client = NatClient.newBuilder()
.withCredential(auth)
.withRegion(NatRegion.valueOf("<YOUR REGION>"))
.build();
CreateNatGatewayTagRequest request = new CreateNatGatewayTagRequest();
request.withNatGatewayId("{nat_gateway_id}");
CreateNatTagRequestBody body = new CreateNatTagRequestBody();
TagBody tagbody = new TagBody();
tagbody.withKey("key1")
.withValue("value1");
body.withTag(tagbody);
request.withBody(body);
try {
CreateNatGatewayTagResponse response = client.createNatGatewayTag(request);
System.out.println(response.toString());
} catch (ConnectionException e) {
e.printStackTrace();
} catch (RequestTimeoutException e) {
e.printStackTrace();
} catch (ServiceResponseException e) {
e.printStackTrace();
System.out.println(e.getHttpStatusCode());
System.out.println(e.getRequestId());
System.out.println(e.getErrorCode());
System.out.println(e.getErrorMsg());
}
}
}
|
Adding a tag to a public NAT gateway (Setting key to key1 and value to value1)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdknat.v2.region.nat_region import NatRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdknat.v2 import *
if __name__ == "__main__":
# The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
# In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = NatClient.new_builder() \
.with_credentials(credentials) \
.with_region(NatRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateNatGatewayTagRequest()
request.nat_gateway_id = "{nat_gateway_id}"
tagbody = TagBody(
key="key1",
value="value1"
)
request.body = CreateNatTagRequestBody(
tag=tagbody
)
response = client.create_nat_gateway_tag(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
Adding a tag to a public NAT gateway (Setting key to key1 and value to value1)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/region"
)
func main() {
// The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
// In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
ak := os.Getenv("CLOUD_SDK_AK")
sk := os.Getenv("CLOUD_SDK_SK")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := nat.NewNatClient(
nat.NatClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateNatGatewayTagRequest{}
request.NatGatewayId = "{nat_gateway_id}"
tagbody := &model.TagBody{
Key: "key1",
Value: "value1",
}
request.Body = &model.CreateNatTagRequestBody{
Tag: tagbody,
}
response, err := client.CreateNatGatewayTag(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
204 |
Tag added. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot