更新时间:2022-03-28 GMT+08:00
分享

更新SNAT规则

功能介绍

更新指定的SNAT规则。

接口约束

  • 更新弹性公网IP的id时,要求SNAT规则状态status = ACTIVE,要求网关管理员状态admin_state_up = True。
  • 更新描述时,要求SNAT规则状态status = ACTIVE,要求网关管理员状态admin_state_up = True。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v2/{project_id}/snat_rules/{snat_rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

最小长度:1

最大长度:36

获取方法详见获取项目ID

snat_rule_id

String

SNAT规则的ID。

长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

snat_rule

UpdateNatGatewaySnatRuleOption object

更新SNAT规则的请求体。

表4 UpdateNatGatewaySnatRuleOption

参数

是否必选

参数类型

描述

nat_gateway_id

String

公网NAT网关的id。

public_ip_address

String

功能说明:弹性公网IP,多个弹性公网IP使用逗号分隔。取值范围:最大长度1024字节。约束:弹性公网IP的id个数不能超过20个

description

String

SNAT规则的描述,长度限制为255。

最大长度:255

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

snat_rule

NatGatewaySnatRuleResponseBody object

SNAT规则的响应体。

表6 NatGatewaySnatRuleResponseBody

参数

参数类型

描述

id

String

SNAT规则的ID。

长度:36

tenant_id

String

项目的ID。

nat_gateway_id

String

公网NAT网关实例的ID。

长度:36

cidr

String

cidr,可以是网段或者主机格式,与network_id参数二选一。source_type=0时,cidr必须是vpc 子网网段的子集(不能相等); source_type=1时,cidr必须指定专线侧网段。

最小长度:9

最大长度:39

source_type

Integer

  • 0:VPC侧,可以指定network_id 或者cidr
  • 1:专线侧,只能指定cidr

缺省值:0

floating_ip_id

String

功能说明:弹性公网IP的id,多个弹性公网IP的id使用逗号分隔。取值范围:最大长度4096字节。

description

String

SNAT规则的描述,长度限制为255。

最大长度:255

status

String

功能说明:SNAT规则的状态。

枚举值:

  • ACTIVE
  • PENDING_CREATE
  • PENDING_UPDATE
  • PENDING_DELETE
  • EIP_FREEZED
  • INACTIVE

created_at

String

SNAT规则的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。最小长度:1

最大长度:36

network_id

String

规则使用的网络id。与cidr参数二选一。

长度:36

admin_state_up

Boolean

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

  • "true":解冻
  • "false":冻结

floating_ip_address

String

功能说明:弹性公网IP,多个弹性公网IP使用逗号分隔。取值范围:最大长度1024字节。

freezed_ip_address

String

功能说明:冻结的弹性公网IP,多个冻结的弹性公网IP使用逗号分隔。取值范围:最大长度1024字节。

请求示例

更新SNAT规则。

PUT https://{Endpoint}/v2/27e25061336f4af590faeabeb7fcd9a3/snat_rules/5b95c675-69c2-4656-ba06-58ff72e1d338 

{
  "snat_rule" : {
    "nat_gateway_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
    "description" : "my_snat_rule_update",
    "public_ip_address" : "10.15.10.11,10.15.10.12"
  }
}

响应示例

状态码: 200

PUT操作正常返回。

{
  "snat_rule" : {
    "floating_ip_id" : " bdc10a4c-d81a-41ec-adf7-de857f7c812a,7a094014-9657-463f-972b-e84d56b931a0",
    "status" : "PENDING_CREATE",
    "nat_gateway_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
    "admin_state_up" : true,
    "network_id" : "eaad9cd6-2372-4be1-9535-9bd37210ae7b",
    "source_type" : 0,
    "tenant_id" : "27e25061336f4af590faeabeb7fcd9a3",
    "created_at" : "2017-11-18 07:54:21.665430",
    "id" : "5b95c675-69c2-4656-ba06-58ff72e1d338",
    "pulic_ip_address" : "10.15.10.11,10.15.10.12",
    "description" : "my_snat_rule_update"
  }
}

状态码

状态码

描述

200

PUT操作正常返回。

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读