检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 通过使用NAT网关服务所提供的接口,您可以完整地使用NAT网关服务的所有功能。 API版本选择建议 NAT网关支持v2.0和v2两个版本的API接口。v2版本接口为较新的版本,产品将持续对v2版本的接口进行优化和功能加强,推荐您使用v2版本API接口。 公网NAT网关
历史API API v2.0
如何调用API 构造请求 认证鉴权 返回结果
API v2.0 公网NAT网关 SNAT规则 DNAT规则 父主题: 历史API
描述 X-Auth-Token 是 String 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数
DNAT规则的描述。长度范围小于等于255个字符,不能包含“<”和“>”。 transit_ip_id 是 String 中转IP的ID。 network_interface_id 否 String 网络接口ID,支持计算、ELBV2、ELBV3、VIP等实例的网络接口。说明:该字段和private_ip_address字段必须二选一,否则会出现错误。
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
API(公网NAT网关) 公网NAT网关标签v3 公网NAT网关 DNAT规则 SNAT规则
描述 X-Auth-Token 是 String 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数
权限和授权项 权限及授权项说明 公网NAT网关 公网NAT网关SNAT规则 公网NAT网关DNAT规则
查询DNAT规则列表 功能介绍 查询DNAT规则列表。 URI GET /v2.0/dnat_rules 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求样例。 表1 参数说明 参数 参数类型 描述 id String DNAT规则的id。
描述 X-Auth-Token 是 String 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数
API(私网NAT网关) 私网NAT网关 DNAT规则 SNAT规则 中转IP 私网NAT网关标签管理 中转IP标签管理
创建公网NAT网关 功能介绍 创建公网NAT网关实例。 URI POST /v2.0/nat_gateways 请求消息 请求参数如表1所示。 表1 请求参数 参数 是否必选 参数类型 描述 nat_gateway 是 Object 公网NAT网关对象。详见表2。 表2 nat_gateway字段说明
公网NAT网关 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建公网NAT网关 POST /v2/{project_id}/nat_gateways nat:natGateways:create √
描述 X-Auth-Token 是 String 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数
账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要
查询指定的公网NAT网关详情 功能介绍 查询指定的公网NAT网关详情。 URI GET /v2.0/nat_gateways/{nat_gateway_id} 表1 参数说明 参数 是否必选 参数类型 描述 nat_gateway_id 是 String 所属公网NAT网关的id。
对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体(可选) 该
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop