Updating a Private NAT Gateway
Function
This API is used to update a private NAT gateway.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/private-nat/gateways/{gateway_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 1 Maximum: 36 |
gateway_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 user token. It is a response to the API used to obtain 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. Minimum: 1 Maximum: 10240 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
gateway |
Yes |
UpdatePrivateNatOption object |
Specifies the request body for updating the private NAT gateway. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Specifies the private NAT gateway name. Only digits, letters, underscores (_), and hyphens (-) are allowed. Minimum: 1 Maximum: 64 |
description |
No |
String |
Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>). Minimum: 0 Maximum: 255 |
spec |
No |
String |
Specifies the private NAT gateway type. The value can be: Small Medium Large Extra-large Enumeration values:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
gateway |
PrivateNat object |
Specifies the response body for the private NAT gateway. |
request_id |
String |
Specifies the request ID. Minimum: 1 Maximum: 36 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the private NAT gateway ID. Minimum: 36 Maximum: 36 |
project_id |
String |
Specifies the project ID. Minimum: 32 Maximum: 32 |
name |
String |
Specifies the private NAT gateway name. Minimum: 1 Maximum: 64 |
description |
String |
Provides supplementary information about the private NAT gateway. The description can contain up to 255 characters and cannot contain angle brackets (<>). Minimum: 0 Maximum: 255 |
spec |
String |
Specifies the private NAT gateway type. The value can be: Small Medium Large Extra-large Default: Small Enumeration values:
|
status |
String |
Specifies the private NAT gateway status. The value can be: ACTIVE: The private NAT gateway is running properly. FROZEN: The private NAT gateway is frozen. Enumeration values:
|
created_at |
String |
Specifies when the private NAT gateway was created. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. |
updated_at |
String |
Specifies when the private NAT gateway was updated. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. |
downlink_vpcs |
Array of DownlinkVpc objects |
Specifies the VPC where the private NAT gateway resides. Array Length: 1 - 10 |
tags |
Array of Tag objects |
Specifies the list of tags. Array Length: 1 - 10 |
enterprise_project_id |
String |
Specifies the ID of the enterprise project that is associated with the private NAT gateway when the private NAT gateway is created. Minimum: 1 Maximum: 36 |
Example Requests
Updating a private NAT gateway. (Setting name to private-nat-gateway-name, description to private-nat-gateway-description, and spec to Medium)
PUT https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways/14338426-6afe-4019-996b-3a9525296e11 { "gateway" : { "name" : "private-nat-gateway-name", "description" : "private-nat-gateway-description", "spec" : "Medium" } }
Example Responses
Status code: 200
Private NAT gateway updated.
{ "gateway" : { "id" : "14338426-6afe-4019-996b-3a9525296e11", "name" : "private-nat-gateway-name", "description" : "private-nat-gateway-description", "spec" : "Medium", "project_id" : "70505c941b9b4dfd82fd351932328a2f", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "status" : "ACTIVE", "created_at" : "2019-04-22T08:47:13", "updated_at" : "2019-04-22T08:47:13", "tags" : [ { "key" : "key1", "value" : "value1" } ], "downlink_vpcs" : [ { "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2", "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70" } ] }, "request_id" : "e7e3323e95b348708d26e68a0ddece71" }
SDK Sample Code
The SDK sample code is as follows.
Updating a private NAT gateway. (Setting name to private-nat-gateway-name, description to private-nat-gateway-description, and spec to Medium)
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 |
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 UpdatePrivateNatSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); NatClient client = NatClient.newBuilder() .withCredential(auth) .withRegion(NatRegion.valueOf("<YOUR REGION>")) .build(); UpdatePrivateNatRequest request = new UpdatePrivateNatRequest(); UpdatePrivateNatRequestBody body = new UpdatePrivateNatRequestBody(); UpdatePrivateNatOption gatewaybody = new UpdatePrivateNatOption(); gatewaybody.withName("private-nat-gateway-name") .withDescription("private-nat-gateway-description") .withSpec(UpdatePrivateNatOption.SpecEnum.fromValue("Medium")); body.withGateway(gatewaybody); request.withBody(body); try { UpdatePrivateNatResponse response = client.updatePrivateNat(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()); } } } |
Updating a private NAT gateway. (Setting name to private-nat-gateway-name, description to private-nat-gateway-description, and spec to Medium)
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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = NatClient.new_builder() \ .with_credentials(credentials) \ .with_region(NatRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdatePrivateNatRequest() gatewaybody = UpdatePrivateNatOption( name="private-nat-gateway-name", description="private-nat-gateway-description", spec="Medium" ) request.body = UpdatePrivateNatRequestBody( gateway=gatewaybody ) response = client.update_private_nat(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Updating a private NAT gateway. (Setting name to private-nat-gateway-name, description to private-nat-gateway-description, and spec to Medium)
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := nat.NewNatClient( nat.NatClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdatePrivateNatRequest{} nameGateway:= "private-nat-gateway-name" descriptionGateway:= "private-nat-gateway-description" specGateway:= model.GetUpdatePrivateNatOptionSpecEnum().MEDIUM gatewaybody := &model.UpdatePrivateNatOption{ Name: &nameGateway, Description: &descriptionGateway, Spec: &specGateway, } request.Body = &model.UpdatePrivateNatRequestBody{ Gateway: gatewaybody, } response, err := client.UpdatePrivateNat(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 |
---|---|
200 |
Private NAT gateway updated. |
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