Help Center/ NAT Gateway/ API Reference/ API Overview
Updated on 2026-03-19 GMT+08:00
View PDF

API Overview

You can use all NAT Gateway functions through NAT Gateway APIs.

Public NAT Gateways

Table 1 Public NAT gateway APIs

Type

Allow You To

Public NAT gateways

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

SNAT rules

Create, query, update, and delete SNAT rules, including creating an SNAT rule, querying SNAT rules, querying details of an 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 of a DNAT rule, updating a DNAT rule, and deleting a DNAT rule.
Table 2 Public NAT gateway APIs

Type

API

Allow You To

Public NAT gateways

Creating a Public NAT Gateway

Create a public NAT gateway.

Querying Public NAT Gateways

Query public NAT gateways.

Querying Details of a Public NAT Gateway

Query details of a public NAT gateway.

Updating a Public NAT Gateway

Update a public NAT gateway.

Deleting a Public NAT Gateway

Delete a public NAT gateway.

DNAT rules

Creating a DNAT Rule

Create a DNAT rule.

Creating DNAT Rules in Batches

Create DNAT rules in batches.

Querying DNAT Rules

Query DNAT rules.

Querying Details of a DNAT Rule

Query details of a DNAT rule.

Updating a DNAT Rule

Update a DNAT rule.

Deleting a DNAT Rule

Delete a DNAT rule.

SNAT rules

Creating an SNAT Rule

Create an SNAT rule.

Querying SNAT Rules

Query SNAT rules.

Querying Details of an SNAT Rule

Query details of an SNAT rule.

Updating an SNAT Rule

Update an SNAT rule.

Deleting an SNAT Rule

Delete an SNAT rule.

Private NAT Gateways

Table 3 Private NAT gateway APIs

Type

Allow You To

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 Private NAT gateway APIs

Type

API

Allow You To

Private NAT gateways

Querying Private NAT Gateways

Query private NAT gateways.

Updating a Private NAT Gateway

Update a private NAT gateway.

Deleting a Private NAT Gateway

Delete a private NAT gateway.

Creating a Private NAT Gateway

Create a private NAT gateway.

Querying Details of a Private NAT Gateway

Query details of a private NAT gateway.

DNAT rules

Querying DNAT Rules

Query DNAT rules.

Updating a DNAT Rule

Update a DNAT rule.

Creating a DNAT Rule

Create a DNAT rule.

Deleting a DNAT Rule

Delete a DNAT rule.

Querying Details of a DNAT Rule

Query details of a DNAT rule.

SNAT rules

Querying SNAT Rules

Query SNAT rules.

Querying Details of an SNAT Rule

Query details of an SNAT rule.

Updating an SNAT Rule

Update an SNAT rule.

Creating an SNAT Rule

Create an SNAT rule.

Deleting an SNAT Rule

Delete an SNAT rule.

Transit IP addresses

Querying Transit IP Addresses

Query transit IP addresses.

Releasing a Transit IP Address

Release a transit IP address.

Assigning a Transit IP Address

Assign a transit IP address.

Querying Details of a Transit IP Address

Query details of a transit IP address.

Private NAT gateway tags

Querying Private NAT Gateways by Tag

Query private NAT gateways by tag.

Querying Tags of All Private NAT Gateways in a Project

Query tags of all private NAT gateways owned by a tenant in a project.

Querying Tags of a Private NAT Gateway

Query tags of a private NAT gateway.

Adding a Tag to a Private NAT Gateway

Add a tag to a private NAT gateway.

Batch Adding or Deleting Tags to or from a Private NAT Gateway

Batch add or delete tags to or from a private NAT gateway.

Deleting a Tag from a Private NAT Gateway

Delete a tag from a private NAT gateway.

Transit IP address tags

Querying Transit IP Addresses by Tag

Query transit IP addresses by tag.

Querying Tags of All Transit IP Addresses in a Project

Query tags of all transit IP addresses owned by a tenant in a project.

Querying Tags of a Transit IP Address

Query tags of a transit IP address.

Adding a Tag to a Transit IP Address

Add a tag to a transit IP address.

Batch Adding or Deleting Tags to or from a Transit IP Address

Batch add or delete tags to or from a transit IP address.

Deleting a Tag from a Transit IP Address

Delete a tag from a transit IP address.