检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API v2.0 公网NAT网关 SNAT规则 DNAT规则 父主题: 历史API
API概览 通过使用NAT网关服务所提供的接口,您可以完整地使用NAT网关服务的所有功能。 API版本选择建议 NAT网关支持v2.0和v2两个版本的API接口。v2版本接口为较新的版本,产品将持续对v2版本的接口进行优化和功能加强,推荐您使用v2版本API接口。 公网NAT网关
历史API API v2.0
API(公网NAT网关) 公网NAT网关标签v3 公网NAT网关 DNAT规则 SNAT规则
API(私网NAT网关) 私网NAT网关 DNAT规则 SNAT规则 中转IP 私网NAT网关标签管理 中转IP标签管理
中转IP 查询中转IP列表 删除中转IP 创建中转IP 查询指定的中转IP详情 父主题: API(私网NAT网关)
描述 X-Auth-Token 是 String 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数
如何调用API 构造请求 认证鉴权 返回结果
描述 X-Auth-Token 是 String 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 响应参数 状态码: 200
更新公网NAT网关 功能介绍 更新公网NAT网关。 admin_state_up = True & status = "ACTIVE"允许更新,支持更新名称、描述、规格 URI PUT /v2.0/nat_gateways/{nat_gateway_id} 表1 参数说明 参数 参数类型
查询DNAT规则列表 功能介绍 查询DNAT规则列表。 URI GET /v2.0/dnat_rules 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求样例。 表1 参数说明 参数 参数类型 描述 id String DNAT规则的id。
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
查询公网NAT网关列表 功能介绍 查询公网NAT网关列表。如无特殊说明,匹配规则为精确匹配。 URI GET /v2.0/nat_gateways 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求样例。 表1 参数说明 参数 是否必选
创建公网NAT网关 功能介绍 创建公网NAT网关实例。 URI POST /v2.0/nat_gateways 请求消息 请求参数如表1所示。 表1 请求参数 参数 是否必选 参数类型 描述 nat_gateway 是 Object 公网NAT网关对象。详见表2。 表2 nat_gateway字段说明
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-tok
描述 X-Auth-Token 是 String 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数
查询指定的公网NAT网关详情 功能介绍 查询指定的公网NAT网关详情。 URI GET /v2.0/nat_gateways/{nat_gateway_id} 表1 参数说明 参数 是否必选 参数类型 描述 nat_gateway_id 是 String 所属公网NAT网关的id。
创建SNAT规则 功能介绍 创建SNAT规则。 创建规则时,要求网关状态status = "ACTIVE",要求网关管理员状态admin_state_up = True。 URI POST /v2.0/snat_rules 请求消息 请求参数如表1所示。 表1 请求参数 参数 是否必选
创建DNAT规则 功能介绍 创建DNAT规则 创建规则时,要求网关状态status = "ACTIVE",要求网关管理员状态admin_state_up = True。port_id和private_ip不能同时生效。对于all port类型的规则,要求internal_service_port
查询指定的DNAT规则详情 功能介绍 查询指定的DNAT规则详情。 URI GET /v2.0/dnat_rules/{dnat_rule_id} 表1 参数说明 参数 参数类型 是否必选 描述 dnat_rule_id String 是 所属DNAT规则的id。 请求消息 无 响应消息