检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 通过使用NAT网关服务所提供的接口,您可以完整的使用NAT网关服务的所有功能。 公网NAT网关 表1 公网NAT网关接口类型 类型 说明 公网NAT网关 支持对公网NAT网关进行创建、查询、更新、删除等操作,包括创建公网NAT网关、查询公网NAT网关列表、查询指定的公
历史API API v2.0
如何调用API 构造请求 认证鉴权 返回结果
API v2.0 公网NAT网关 SNAT规则 DNAT规则 父主题: 历史API
API版本选择建议 NAT网关支持v2.0和v2两个版本的API接口。v2版本接口为较新的版本,产品将持续对v2版本的接口进行优化和功能加强,推荐您使用v2版本API接口。 父主题: 使用前必读
API(公网NAT网关) 公网NAT网关 DNAT规则 SNAT规则 公网NAT网关标签
API(私网NAT网关) 私网NAT网关 DNAT规则 SNAT规则 中转IP 私网NAT网关标签管理 中转IP标签管理
虚拟机或者裸机对外提供服务的协议端口号。 floating_ip_id String 弹性公网IP的id。 floating_ip_address String 弹性公网的IP地址。 external_service_port Integer Floatingip对外提供服务的端口号。 protocol
请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。
表1 参数说明 参数 是否必选 参数类型 描述 nat_gateway_id 是 String 所属公网NAT网关的id。 请求消息 无 响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 nat_gateway Object nat_gateway对象。详见表3。
请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中userna
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop
id} 表1 参数说明 参数 是否必选 参数类型 描述 dnat_rule_id 是 String 所属DNAT规则的id。 请求消息 无 响应消息 无 示例 请求样例 DELETE https://{Endpoint}/v2.0/dnat_rules/a78fb3eb-1654
SNAT规则 创建SNAT规则 查询SNAT规则列表 查询指定的SNAT规则详情 删除SNAT规则 父主题: API v2.0
DNAT规则 创建DNAT规则 查询DNAT规则列表 查询指定的DNAT规则详情 删除DNAT规则 父主题: API v2.0
“2”:中型,SNAT最大连接数50000 “3”:大型,SNAT最大连接数200000 “4”:超大型,SNAT最大连接数1000000 响应消息 响应消息如表4所示。 表4 响应参数 参数 参数类型 描述 nat_gateway Object nat_gateway对象。详见表5。 表5
表1 参数说明 参数 是否必选 参数类型 描述 nat_gateway_id 是 String 所属公网NAT网关的id。 请求消息 无 响应消息 无 示例 请求样例 DELETE https://{Endpoint}/v2.0/nat_gateways/a78fb3eb-16
id} 表1 参数说明 参数 是否必选 参数类型 描述 snat_rule_id 是 String 所属SNAT规则的id。 请求消息 无 响应消息 无 示例 请求样例 DELETE https://{Endpoint}/v2.0/snat_rules/a78fb3eb-1654
虚拟机或者裸机的Port ID,与private_ip参数二选一。 获取虚拟机Port ID的方法请参考查询云服务器网卡信息,获取裸机Port ID的方法请参考查询裸金属服务器IP地址。 private_ip 否 String 用户私有IP地址,例如专线连接的私有云地址,与port_id参数二选一。
id} 表1 参数说明 参数 参数类型 是否必选 描述 dnat_rule_id String 是 所属DNAT规则的id。 请求消息 无 响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 dnat_rule Object dnat_rule对象。详见表3。 表3