Updated on 2023-04-19 GMT+08:00

API Overview

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

API v2

Table 1 NAT gateway API v2

Type

Description

NAT Gateway Service

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

SNAT Rules

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

DNAT Rules

Create, query, update, and delete DNAT rules, including creating a DNAT rule, creating DNAT rules in batches, querying DNAT rules, querying details about a specified DNAT rule, updating a DNAT rule, and deleting a DNAT rule.

Table 2 NAT gateway API (v2) 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 About a Specified NAT Gateway

This API is used to query details about a specified 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 About a Specified SNAT Rule

This API is used to query details about a specified SNAT rule.

Updating an SNAT Rule

This API is used to update 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.

Creating DNAT Rules in Batches

This API is used to create DNAT rules in batches.

Querying DNAT Rules

This API is used to query DNAT rules.

Querying Details About a Specified DNAT Rule

This API is used to query details about a specified DNAT rule.

Updating a DNAT Rule

This API is used to update a DNAT rule.

Deleting a DNAT Rule

This API is used to delete a DNAT rule.

API v2.0

Table 3 NAT gateway API v2.0

Type

Description

Tags

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

Table 4 NAT gateway API (v2.0) description

Type

API

Description

Tags

Querying NAT Gateways by Tag

This API is used to filter NAT gateways by tag.

Adding or Deleting NAT Gateway Tags in Batches

This API is used to add or delete tags of a specific NAT gateway in batches.

Adding a NAT Gateway Tag

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

Deleting a NAT Gateway Tag

This API is used to delete NAT gateway tags.

Querying NAT Gateway Tags

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

Querying Tags in a Project

This API is used to query all tags of a resource type in a specified region.

Private NAT Gateways

Table 5 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 about a specified 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 about a specified 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 about a specified 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 about a specified transit IP address.

Table 6 Descriptions of private NAT gateway APIs

Type

API

Description

Private NAT Gateways

Querying Private NAT Gateways

This API is used to query private NAT gateways.

Updating a Private NAT Gateway

This API is used to update a private NAT gateway.

Deleting a Private NAT Gateway

This API is used to delete a private NAT gateway.

Creating a Private NAT Gateway

This API is used to create a private NAT gateway.

Querying Details About a Specified Private NAT Gateway

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

DNAT Rules

Querying DNAT Rules

This API is used to query DNAT rules.

Updating a DNAT Rule

This API is used to update a DNAT rule.

Creating a DNAT Rule

This API is used to create a DNAT rule.

Deleting a DNAT Rule

This API is used to delete a DNAT rule.

Querying Details About a Specified DNAT Rule

This API is used to query details about a specified DNAT rule.

SNAT Rules

Querying SNAT Rules

This API is used to query SNAT rules.

Querying Details About a Specified SNAT Rule

This API is used to query details about a specified SNAT rule.

Updating an SNAT Rule

This API is used to update an SNAT rule.

Creating an SNAT Rule

This API is used to create an SNAT rule.

Deleting an SNAT Rule

This API is used to delete an SNAT rule.

Transit IP Addresses

Querying Transit IP Addresses

This API is used to query transit IP addresses.

Releasing a Transit IP Address

This API is used to release a transit IP address.

Assigning a Transit IP Address

This API is used to assign a transit IP address.

Querying Details About a Specified Transit IP Address.

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