更新公网NAT网关
功能介绍
更新公网NAT网关实例。
接口约束
在admin_state_up = True & status = ACTIVE 时允许更新,支持更新名称、描述、规格。"
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/nat_gateways/{nat_gateway_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID。 |
nat_gateway_id |
是 |
String |
公网NAT网关实例的ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
nat_gateway |
是 |
UpdateNatGatewayOption object |
更新公网NAT请求体 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
公网NAT网关实例的名字,长度限制为64。 公网NAT网关实例的名字仅支持数字、字母、_(下划线)、-(中划线)、中文。 |
description |
否 |
String |
公网NAT网关的描述,长度范围小于等于255个字符,不能包含“<”和“>”。 |
spec |
否 |
String |
公网NAT网关的规格。 取值为: “1”:小型,SNAT最大连接数10000 “2”:中型,SNAT最大连接数50000 “3”:大型,SNAT最大连接数200000 “4”:超大型,SNAT最大连接数1000000 |
session_conf |
否 |
SessionConfiguration object |
公网NAT网关会话参数配置。 |
prepaid_options |
否 |
prepaid_options object |
支付属性 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
nat_gateway |
NatGatewayResponseBody object |
公网NAT网关实例的响应体。 |
order_id |
String |
订单ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
公网NAT网关实例的ID。 |
tenant_id |
String |
项目的ID。 |
name |
String |
公网NAT网关实例的名字,长度限制为64。 |
description |
String |
公网NAT网关实例的描述,长度范围小于等于255个字符,不能包含“<”和“>”。 |
spec |
String |
公网NAT网关的规格。 取值为: “1”:小型,SNAT最大连接数10000 “2”:中型,SNAT最大连接数50000 “3”:大型,SNAT最大连接数200000 “4”:超大型,SNAT最大连接数1000000 |
status |
String |
公网NAT网关实例的状态。 取值为: ACTIVE: 可用 PENDING_CREATE: 创建中 PENDING_UPDATE: 更新中 PENDING_DELETE: 删除中 INACTIVE: 不可用 |
admin_state_up |
Boolean |
解冻/冻结状态。 取值范围:
|
created_at |
String |
公网NAT网关实例的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。 |
router_id |
String |
VPC的id。 |
internal_network_id |
String |
公网NAT网关下行口(DVR的下一跳)所属的network id。 |
enterprise_project_id |
String |
企业项目ID。 创建公网NAT网关实例时,关联的企业项目ID。 |
session_conf |
SessionConfiguration object |
公网NAT网关会话参数配置。 |
ngport_ip_address |
String |
公网NAT网关私有IP地址,由VPC中子网分配。 |
billing_info |
String |
订单信息。此字段只有在订购包周期资源时才会有订单信息,而在订购按需资源时则为空。 |
dnat_rules_limit |
Long |
公网NAT网关下DNAT规则数量限制,默认为200。 |
snat_rule_public_ip_limit |
Integer |
公网NAT网关下SNAT规则EIP池中EIP数量限制,默认为20。 |
pps_max |
Integer |
网关每秒能够接收或发送的数据包数量,代表网络设备的流量处理能力。 |
bps_max |
Integer |
网关每秒能够接收或发送的带宽大小,代表网络设备的流量处理能力。单位M |
请求示例
PUT https://{NAT_endpoint}/v2/70505c941b9b4dfd82fd351932328a2f/nat_gateways/14338426-6afe-4019-996b-3a9525296e11 { "nat_gateway" : { "name" : "new_name", "description" : "new description", "spec" : "1" } }
响应示例
状态码: 200
更新公网NAT网关实例成功。
{ "nat_gateway" : { "id" : "14338426-6afe-4019-996b-3a9525296e11", "name" : "new_name", "description" : "new description", "spec" : "1", "tenant_id" : "70505c941b9b4dfd82fd351932328a2f", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "status" : "ACTIVE", "created_at" : "2019-04-22T08:47:13", "internal_network_id" : "89d66639-aacb-4929-969d-07080b0f9fd9", "router_id" : "d84f345c-80a1-4fa2-a39c-d0d397c3f09a", "admin_state_up" : true, "billing_info" : null, "dnat_rules_limit" : 200, "snat_rule_public_ip_limit" : 20, "ngport_ip_address" : "192.168.0.138", "session_conf" : { "tcp_session_expire_time" : 900, "udp_session_expire_time" : 300, "icmp_session_expire_time" : 10, "tcp_time_wait_time" : 5 } } }
SDK代码示例
SDK代码示例如下。
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 55 |
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 UpdateNatGatewaySolution { 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(); UpdateNatGatewayRequest request = new UpdateNatGatewayRequest(); request.withNatGatewayId("{nat_gateway_id}"); UpdateNatGatewayRequestBody body = new UpdateNatGatewayRequestBody(); UpdateNatGatewayOption natGatewaybody = new UpdateNatGatewayOption(); natGatewaybody.withName("new_name") .withDescription("new description") .withSpec(UpdateNatGatewayOption.SpecEnum.fromValue("1")); body.withNatGateway(natGatewaybody); request.withBody(body); try { UpdateNatGatewayResponse response = client.updateNatGateway(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()); } } } |
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 |
# 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 = UpdateNatGatewayRequest() request.nat_gateway_id = "{nat_gateway_id}" natGatewaybody = UpdateNatGatewayOption( name="new_name", description="new description", spec="1" ) request.body = UpdateNatGatewayRequestBody( nat_gateway=natGatewaybody ) response = client.update_nat_gateway(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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.UpdateNatGatewayRequest{} request.NatGatewayId = "{nat_gateway_id}" nameNatGateway:= "new_name" descriptionNatGateway:= "new description" specNatGateway:= model.GetUpdateNatGatewayOptionSpecEnum().E_1 natGatewaybody := &model.UpdateNatGatewayOption{ Name: &nameNatGateway, Description: &descriptionNatGateway, Spec: &specNatGateway, } request.Body = &model.UpdateNatGatewayRequestBody{ NatGateway: natGatewaybody, } response, err := client.UpdateNatGateway(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
更新公网NAT网关实例成功。 |
错误码
请参见错误码。