API Overview

NAT Gateway APIs allow you to use all NAT Gateway functions.

Note

If null will be returned for a request parameter, this parameter will not be returned in the response body.

API v2.0 for Public NAT Gateways

Table 1 NAT gateway API v2.0

Type

Description

NAT Gateway Service

Create, query, update, and delete NAT gateways, including creating a NAT gateway, querying NAT gateways, querying details of a NAT gateway, updating a NAT gateway, and deleting a NAT gateway.

SNAT Rules

Create, query, and delete SNAT rules, including creating an SNAT rule, querying SNAT rules, querying details of an SNAT rule, and deleting an SNAT rule.

DNAT Rules

Create, query, and delete DNAT rules, including creating a DNAT rule, querying DNAT rules, querying details of a DNAT rule, and deleting a DNAT rule.

Tags

Tag NAT gateways. Tags help you manage the NAT gateways. You can query, add, and delete tags of NAT gateways.

API Version

Query all API versions or an API version.

Table 2 NAT gateway API (v2.0) description

Type

API

Description

NAT Gateway Service

Creating a NAT Gateway

This API is used to create a NAT gateway.

Querying NAT Gateways

This API is used to query NAT gateways.

Querying Details of a NAT Gateway

This API is used to query details of a NAT gateway.

Updating a NAT Gateway

This API is used to update a NAT gateway.

Deleting a NAT Gateway

This API is used to delete a NAT gateway.

SNAT Rules

Creating an SNAT Rule

This API is used to create an SNAT rule.

Querying SNAT Rules

This API is used to query SNAT rules.

Querying Details of an SNAT Rule

This API is used to query details of an SNAT rule.

Deleting an SNAT Rule

This API is used to delete an SNAT rule.

DNAT Rules

Creating a DNAT Rule

This API is used to create a DNAT rule.

Querying DNAT Rules

This API is used to query DNAT rules.

Querying Details of a DNAT Rule

This API is used to query details of a DNAT rule.

Deleting a DNAT Rule

This API is used to delete a DNAT rule.

Tags

Querying NAT Gateways by Tag

This API is used to query NAT gateways by tag.

Adding or Deleting NAT Gateway Tags in Batches

This API is used to add or delete tags to or from a NAT gateway.

Adding a NAT Gateway Tag

This API is used to add a tag to a NAT gateway.

Deleting a NAT Gateway Tag

This API is used to delete a NAT gateway tag.

Querying NAT Gateway Tags

This API is used to query tags of a NAT gateway.

Querying Tags in a Project

This API is used to query all NAT gateway tags in a project.

API Version

Querying All API Versions

This API is used to query all API versions of NAT Gateway.

Querying an API Version

This API is used to query an API version of NAT Gateway.

API v3.0 for Private NAT Gateways

Table 3 Private NAT gateway APIs

Type

Description

Private NAT gateways

Create, query, update, and delete private NAT gateways, including creating a private NAT gateway, querying private NAT gateways, updating a private NAT gateway, deleting a private NAT gateway, and querying details of a private NAT gateway.

DNAT rules

Create, query, update, and delete DNAT rules, including creating a DNAT rule, querying DNAT rules, updating a DNAT rule, deleting a DNAT rule, and querying details of a DNAT rule.

SNAT rules

Create, query, update, and delete SNAT rules, including creating an SNAT rule, querying SNAT rules, updating an SNAT rule, deleting an SNAT rule, and querying details of an SNAT rule.

Transit IP addresses

Assign, query, and release transit IP addresses, including assigning a transit IP address, querying transit IP addresses, releasing a transit IP address, and querying details of a transit IP address.

Private NAT gateway tags

Tag private NAT gateways. Tags help you manage private NAT gateways. You can query, add, and delete tags of private NAT gateways.

Transit IP address tags

Tag transit IP addresses. Tags help you manage transit IP addresses. You can query, add, and delete tags of transit IP addresses.

Table 4 Descriptions of private NAT gateway APIs

Type

Description

Private NAT gateways

This API is used to query private NAT gateways.

This API is used to update a private NAT gateway.

This API is used to delete a private NAT gateway.

This API is used to create a private NAT gateway.

This API is used to query details of a private NAT gateway.

DNAT rules

This API is used to query DNAT rules.

This API is used to update a DNAT rule.

This API is used to create a DNAT rule.

This API is used to delete a DNAT rule.

This API is used to query details of a DNAT rule.

SNAT rules

This API is used to query SNAT rules.

This API is used to query details of an SNAT rule.

This API is used to update an SNAT rule.

This API is used to create an SNAT rule.

This API is used to delete an SNAT rule.

Transit IP addresses

This API is used to query transit IP addresses.

This API is used to release a transit IP address.

This API is used to assign a transit IP address.

This API is used to query details of a transit IP address.

Private NAT gateway tags

This API is used to query private NAT gateways by tag.

This API is used to query tags of all private NAT gateways owned by a tenant in a project.

This API is used to query tags of a private NAT gateway.

This API is used to add a tag to a private NAT gateway.

This API is used to add or delete tags to or from a private NAT gateway.

This API is used to delete a private NAT gateway tag.

Transit IP address tags

This API is used to query transit IP addresses by tag.

This API is used to query tags of all transit IP addresses owned by a tenant in a project.

This API is used to query tags of a transit IP address.

This API is used to add a tag to a transit IP address.

This API is used to add or delete tags to or from a transit IP address.

This API is used to delete a tag from a transit IP address.