# 更新私网NAT网关 - UpdatePrivateNat #### 功能介绍 更新私网NAT网关实例。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-natgateway/nat_api_0053.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-natgateway/nat_api_0063.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | nat:privateNatGateways:update | Write | privateGateway \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - | - | #### URI PUT /v3/{project_id}/private-nat/gateways/{gateway_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目的ID。 | | gateway_id | 是 | String | 私网NAT网关实例的ID。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | gateway | 是 | [UpdatePrivateNatOption] object | 更新私网NAT网关实例的请求体。 | 表4UpdatePrivateNatOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 私网NAT网关实例的名字。 私网NAT网关实例的名字仅支持数字、字母、_（下划线）、-（中划线）、中文。 | | description | 否 | String | 私网NAT网关的描述。长度范围小于等于255个字符，不能包含"\<"和"\>"。 | | spec | 否 | String | 私网NAT网关实例的规格。 取值为： - Small：小型 - Medium：中型 - Large：大型 - Extra-large：超大型 - Extra-xlarge：企业型 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | gateway | [PrivateNat] object | 私网NAT网关实例的响应体。 | | request_id | String | 请求ID。 | 表6PrivateNat | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 私网NAT网关实例的ID。 | | project_id | String | 项目的ID。 | | name | String | 私网NAT网关实例的名字。 | | description | String | 私网NAT网关实例的描述。长度范围小于等于255个字符，不能包含"\<"和"\>"。 | | spec | String | 私网NAT网关实例的规格。 取值为： - Small：小型 - Medium：中型 - Large：大型 - Extra-large：超大型 - Extra-xlarge：企业型 | | status | String | 私网NAT网关实例的状态。 取值为： - ACTIVE：正常运行 - FROZEN：冻结 - INACTIVE：不可用 | | created_at | String | 私网NAT网关实例的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 | | updated_at | String | 私网NAT网关实例的更新时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 | | downlink_vpcs | Array of [DownlinkVpc] objects | 私网NAT网关实例所属的VPC实例。 | | tags | Array of [Tag] objects | 标签列表。 | | enterprise_project_id | String | 企业项目ID。 创建私网NAT网关实例时，关联的企业项目ID。 | | rule_max | Integer | 最大规则数。 | | transit_ip_pool_size_max | Integer | 中转ip池大小 | 表7DownlinkVpc | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vpc_id | String | 私网NAT网关实例所属VPC的ID。 | | virsubnet_id | String | 私网NAT网关实例所属子网的ID。 | | ngport_ip_address | String | 私网NAT网关的ngport_ip_address。 | 表8Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | 键。最大长度128个unicode字符。key不能为空。 | | value | String | 值。每个值最大长度255个unicode字符。 | #### 请求示例 更新私网NAT网关实例，其中，私网NAT网关实例的名字为private-nat-gateway-name，私网NAT网关的描述为private-nat-gateway-description，实例的规格为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" } } ``` #### 响应示例 **状态码：200** 更新私网NAT网关实例成功。 ``` { "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:13Z", "updated_at" : "2019-04-22T08:47:13Z", "tags" : [ { "key" : "key1", "value" : "value1" } ], "downlink_vpcs" : [ { "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2", "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70", "ngport_ip_address" : "10.0.0.17" } ], "transit_ip_pool_size_max" : 1, "rule_max" : 20 }, "request_id" : "e7e3323e95b348708d26e68a0ddece71" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java 更新私网NAT网关实例，其中，私网NAT网关实例的名字为private-nat-gateway-name，私网NAT网关的描述为private-nat-gateway-description，实例的规格为Medium。 ``` 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); NatClient client = NatClient.newBuilder() .withCredential(auth) .withRegion(NatRegion.valueOf("")) .build(); UpdatePrivateNatRequest request = new UpdatePrivateNatRequest(); request.withGatewayId("{gateway_id}"); 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()); } } } ``` #### Python 更新私网NAT网关实例，其中，私网NAT网关实例的名字为private-nat-gateway-name，私网NAT网关的描述为private-nat-gateway-description，实例的规格为Medium。 ``` # 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("")) \ .build() try: request = UpdatePrivateNatRequest() request.gateway_id = "{gateway_id}" 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) ``` #### Go 更新私网NAT网关实例，其中，私网NAT网关实例的名字为private-nat-gateway-name，私网NAT网关的描述为private-nat-gateway-description，实例的规格为Medium。 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := nat.NatClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := nat.NewNatClient(hcClient) request := &model.UpdatePrivateNatRequest{} request.GatewayId = "{gateway_id}" 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) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/NAT/sdk?api=UpdatePrivateNat)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 更新私网NAT网关实例成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-natgateway/ErrorCode.html)。