更新时间:2024-12-20 GMT+08:00
分享

API概览

通过使用NAT网关服务所提供的接口,您可以完整地使用NAT网关服务的所有功能。

API版本选择建议

NAT网关支持v2.0和v2两个版本的API接口。v2版本接口为较新的版本,产品将持续对v2版本的接口进行优化和功能加强,推荐您使用v2版本API接口。

公网NAT网关

表1 公网NAT网关接口类型

类型

说明

公网NAT网关

支持对公网NAT网关进行创建、查询、更新、删除等操作,包括创建公网NAT网关、查询公网NAT网关列表、查询指定的公网NAT网关详情、更新公网NAT网关、删除公网NAT网关等接口。

SNAT规则

支持创建、查询、更新、删除SNAT规则,包括创建SNAT规则、查询SNAT规则列表、查询指定的SNAT规则详情、更新SNAT规则、删除SNAT规则等接口。

DNAT规则

支持创建、查询、更新、删除DNAT规则,包括创建DNAT规则、批量创建DNAT规则、查询DNAT规则列表、查询指定的DNAT规则详情、更新DNAT规则、删除DNAT规则等接口。

公网NAT网关标签

公网NAT网关的标签可以对公网NAT网关进行自定义标记,通过标签,用户可以对公网NAT网关进行管理,包括查询、添加、删除标签等操作。

表2 公网NAT网关接口说明

类型

API

说明

公网NAT网关

创建公网NAT网关

创建公网NAT网关实例。

查询公网NAT网关列表

查询公网NAT网关列表。

查询指定的公网NAT网关详情

查询指定的公网NAT网关详情。

更新公网NAT网关

更新公网NAT网关。

删除公网NAT网关

删除公网NAT网关。

DNAT规则

创建DNAT规则

创建DNAT规则。

批量创建DNAT规则

批量创建DNAT规则。

查询DNAT规则列表

查询DNAT规则列表。

查询指定的DNAT规则详情

查询指定的DNAT规则详情。

更新DNAT规则

更新DNAT规则。

删除DNAT规则

删除DNAT规则。

SNAT规则

创建SNAT规则

创建SNAT规则。

查询SNAT规则列表

查询SNAT规则列表。

查询指定的SNAT规则详情

查询指定的SNAT规则详情。

更新SNAT规则

更新SNAT规则。

删除SNAT规则

删除SNAT规则。

公网NAT网关标签

查询公网NAT网关资源实例

使用标签过滤公网NAT网关资源实例。

批量添加/删除公网NAT网关资源标签

为指定公网NAT网关实例批量添加或删除标签。

添加公网NAT网关资源标签

添加公网NAT网关资源标签。

删除公网NAT网关资源标签

删除公网NAT网关资源标签。

查询公网NAT网关资源标签

查询指定公网NAT网关实例的标签信息。

查询公网NAT网关项目标签

查询租户在指定Region和公网NAT网关实例类型的所有标签集合。

私网NAT网关

表3 私网NAT网关接口类型

类型

说明

私网NAT网关

支持对私网NAT网关进行查询、更新、删除、创建等操作,包括查询私网NAT网关列表、更新私网NAT网关、删除私网NAT网关、创建私网NAT网关、查询指定的私网NAT网关详情接口。

DNAT规则

支持查询、更新、创建、删除DNAT规则,包括查询DNAT规则列表、更新DNAT规则、创建DNAT规则、删除DNAT规则、查询指定的DNAT规则详情接口。

SNAT规则

支持查询、更新、创建、删除SNAT规则,包括查询SNAT规则列表、查询指定的SNAT规则详情、更新SNAT规则、创建SNAT规则、删除SNAT规则接口。

中转IP

支持查询、删除、创建中转IP,包括查询中转IP列表、删除中转IP、创建中转IP、查询指定的中转IP详情接口。

私网NAT网关标签管理

私网NAT网关的标签可以对NAT网关进行自定义标记,通过标签,用户可以对私网NAT网关进行管理,包括查询、添加、删除标签等操作。

中转IP标签管理

中转IP的标签可以对中转IP进行自定义标记,通过标签,用户可以对中转IP进行管理,包括查询、添加、删除标签等操作。

表4 私网NAT网关接口说明

类型

API

说明

私网NAT网关

查询私网NAT网关列表

查询私网NAT网关列表。

更新私网NAT网关

更新私网NAT网关。

删除私网NAT网关

删除私网NAT网关。

创建私网NAT网关

创建私网NAT网关实例。

查询指定的私网NAT网关详情

查询指定的私网NAT网关详情。

DNAT规则

查询DNAT规则列表

查询DNAT规则列表。

更新DNAT规则

更新DNAT规则。

创建DNAT规则

创建DNAT规则。

删除DNAT规则

删除DNAT规则。

查询指定的DNAT规则详情

查询指定的DNAT规则详情。

SNAT规则

查询SNAT规则列表

查询SNAT规则列表。

查询指定的SNAT规则详情

查询指定的SNAT规则详情。

更新SNAT规则

更新SNAT规则。

创建SNAT规则

创建SNAT规则。

删除SNAT规则

删除SNAT规则。

中转IP

查询中转IP列表

查询中转IP列表。

删除中转IP

删除中转IP。

创建中转IP

创建中转IP。

查询指定的中转IP详情

查询指定的中转IP详情。

私网NAT网关标签管理

查询私网NAT网关实例

使用标签过滤私网NAT网关实例。

查询私网NAT网关项目标签

查询租户在指定Project的所有私网NAT网关标签集合。

查询私网NAT网关标签

查询指定私网NAT网关实例的标签信息。

添加私网NAT网关标签

添加私网NAT网关资源标签。

批量添加删除私网NAT网关标签

为指定私网NAT网关实例批量添加或删除标签。

删除私网NAT网关标签

删除私网NAT网关资源标签。

中转IP标签管理

查询中转IP实例

使用标签过滤中转IP实例。

查询中转IP项目标签

查询租户在指定Project的所有中转IP标签集合。

查询中转IP标签

查询指定中转IP实例的标签信息。

添加中转IP标签

添加中转IP标签

批量添加删除中转IP标签

为指定中转IP实例批量添加或删除标签

删除中转IP标签

删除中转IP标签

API v2.0

表5 NAT网关v2.0接口类型

类型

说明

公网NAT网关

支持对公网NAT网关进行创建、查询、更新、删除等操作,包括创建公网NAT网关、查询公网NAT网关列表、查询公网NAT网关、更新公网NAT网关、删除公网NAT网关等接口。

SNAT规则

支持创建、查询、删除SNAT规则,包括创建SNAT规则、查询SNAT规则列表、查询SNAT规则、删除SNAT规则等接口。

DNAT规则

支持创建、查询、删除DNAT规则,包括创建DNAT规则、查询DNAT规则列表、查询DNAT规则、删除DNAT规则等接口。

表6 NAT网关v2.0接口说明

类型

API

说明

公网NAT网关

创建公网NAT网关

创建公网NAT网关实例。

查询公网NAT网关列表

查询公网NAT网关列表。

查询指定的公网NAT网关详情

查询指定的公网NAT网关详情。

更新公网NAT网关

更新公网NAT网关。

删除公网NAT网关

删除公网NAT网关。

SNAT规则

创建SNAT规则

创建SNAT规则。

查询SNAT规则列表

查询SNAT规则列表。

查询指定的SNAT规则详情

查询指定的SNAT规则详情。

删除SNAT规则

删除SNAT规则。

DNAT规则

创建DNAT规则

创建DNAT规则

查询DNAT规则列表

查询DNAT规则列表。

查询指定的DNAT规则详情

查询指定的DNAT规则详情。

删除DNAT规则

删除DNAT规则。

相关文档