Help Center > > API Reference> API Overview

API Overview

Updated at: May 29, 2020 GMT+08:00

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 a NAT Gateway List

This API is used to query a NAT gateway list.

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 an SNAT rule list.

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 a DNAT rule list.

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

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, and delete SNAT rules, including creating an SNAT rule, querying SNAT rules, querying details about a specified 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 about a specified 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.

Currently, this type of API is available only in the AP-Singapore region.

Table 4 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 a NAT gateway list.

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 an SNAT rule list.

Querying Details About a Specified SNAT Rule

This API is used to query details about a specified 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 a DNAT rule list.

Querying Details About a Specified DNAT Rule

This API is used to query details about a specified 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 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.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel