文档首页/ NAT网关 NAT/ API参考（安卡拉区域）/ API（公网NAT网关）/ 公网NAT网关/ 更新公网NAT网关
更新时间：2024-04-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新公网NAT网关

功能介绍

更新公网NAT网关实例。

接口约束

在admin_state_up = True & status = ACTIVE 时允许更新，支持更新名称、描述、规格。"

调用方法

请参见如何调用API。

URI

PUT /v2/{project_id}/nat_gateways/{nat_gateway_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

最小长度：1

最大长度：36

nat_gateway_id

是

String

公网NAT网关实例的ID。

最小长度：36

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度：1

最大长度：10240
表3 请求Body参数

参数

是否必选

参数类型

描述

nat_gateway

是

UpdateNatGatewayOption object

更新公网NAT网关实例的请求体。
表4 UpdateNatGatewayOption

参数

是否必选

参数类型

描述

name

否

String

公网NAT网关实例的名字，长度限制为64。 公网NAT网关实例的名字仅支持数字、字母、_（下划线）、-（中划线）、中文。

最小长度：1

最大长度：64

description

否

String

公网NAT网关的描述，长度范围小于等于255个字符，不能包含“<”和“>”。

最小长度：0

最大长度：255

spec

否

String

公网NAT网关的规格。 取值为： "1"：小型，SNAT最大连接数10000 "2"：中型，SNAT最大连接数50000 "3"：大型，SNAT最大连接数200000 "4"：超大型，SNAT最大连接数1000000

枚举值：

  • 1

  • 2

  • 3

  • 4

session_conf

否

SessionConfiguration object

公网NAT网关会话参数配置。
表5 SessionConfiguration

参数

是否必选

参数类型

描述

tcp_session_expire_time

否

Integer

TCP会话过期时间。

最小值：40

最大值：7200

udp_session_expire_time

否

Integer

UDP会话过期时间。

最小值：40

最大值：7200

icmp_session_expire_time

否

Integer

ICMP会话过期时间。

最小值：10

最大值：7200

tcp_time_wait_time

否

Integer

TCP连接关闭时TIME_WAIT状态持续时间。

最小值：0

最大值：1800

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

nat_gateway

NatGatewayResponseBody object

公网NAT网关实例的响应体。
表7 NatGatewayResponseBody

参数

参数类型

描述

id

String

公网NAT网关实例的ID。

最小长度：36

最大长度：36

tenant_id

String

项目的ID。

最小长度：1

最大长度：36

name

String

公网NAT网关实例的名字，长度限制为64。

最小长度：1

最大长度：64

description

String

公网NAT网关实例的描述，长度范围小于等于255个字符，不能包含“<”和“>”。

最小长度：0

最大长度：255

spec

String

公网NAT网关的规格。 取值为： “1”：小型，SNAT最大连接数10000 “2”：中型，SNAT最大连接数50000 “3”：大型，SNAT最大连接数200000 “4”：超大型，SNAT最大连接数1000000

枚举值：

  • 1

  • 2

  • 3

  • 4

status

String

公网NAT网关实例的状态。 取值为： "ACTIVE": 可用 "PENDING_CREATE"：创建中 "PENDING_UPDATE"：更新中 "PENDING_DELETE"：删除中 "INACTIVE"：不可用

枚举值：

  • ACTIVE

  • PENDING_CREATE

  • PENDING_UPDATE

  • PENDING_DELETE

  • INACTIVE

admin_state_up

Boolean

解冻/冻结状态。 取值范围：

  • "true"：解冻

  • "false"：冻结

created_at

String

公网NAT网关实例的创建时间，格式是yyyy-mm-dd hh:mm:ss.SSSSSS。

最小长度：1

最大长度：36

router_id

String

VPC的id。

最小长度：36

最大长度：36

internal_network_id

String

公网NAT网关下行口（DVR的下一跳）所属的network id。

最小长度：36

最大长度：36

enterprise_project_id

String

企业项目ID。 创建公网NAT网关实例时，关联的企业项目ID。

最小长度：1

最大长度：36

session_conf

SessionConfiguration object

公网NAT网关会话参数配置。

ngport_ip_address

String

公网NAT网关私有IP地址，由VPC中子网分配。

最小长度：7

最大长度：15

billing_info

String

订单信息。此字段只有在订购包周期资源时才会有订单信息，而在订购按需资源时则为空。

dnat_rules_limit

Long

公网NAT网关下DNAT规则数量限制，默认为200。

最小值：1

最大值：100000

snat_rule_public_ip_limit

Integer

公网NAT网关下SNAT规则EIP池中EIP数量限制，默认为20。

最小值：1

最大值：100
表8 SessionConfiguration

参数

参数类型

描述

tcp_session_expire_time

Integer

TCP会话过期时间。

最小值：40

最大值：7200

udp_session_expire_time

Integer

UDP会话过期时间。

最小值：40

最大值：7200

icmp_session_expire_time

Integer

ICMP会话过期时间。

最小值：10

最大值：7200

tcp_time_wait_time

Integer

TCP连接关闭时TIME_WAIT状态持续时间。

最小值：0

最大值：1800

请求示例

PUT https://{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-22 08:47:13.238743",
    "internal_network_id" : "89d66639-aacb-4929-969d-07080b0f9fd9",
    "router_id" : "d84f345c-80a1-4fa2-a39c-d0d397c3f09a",
    "admin_state_up" : true,
    "billing_info" : "",
    "dnat_rules_limit" : 200,
    "snat_rule_public_ip_limit" : 20,
    "ngport_ip_address" : "192.168.0.138"
  }
}

状态码

状态码

描述

200

更新公网NAT网关实例成功。

错误码

请参见错误码。

父主题： 公网NAT网关