Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying SNAT Rules

Function

This API is used to query SNAT rules.

URI

GET /v2.0/snat_rules

NOTE:

You can type a question mark (?) and an ampersand (&) at the end of the URI to define different search criteria. All optional parameters can be filtered. For details, see the example request.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

id

No

String

Specifies the SNAT rule ID.

limit

No

Integer

Specifies the number of records on each page.

tenant_id

No

String

Specifies the project ID.

nat_gateway_id

No

String

Specifies the public NAT gateway ID.

network_id

No

String

Specifies the network ID used by the SNAT rule.

cidr

No

String

Specifies a subset of the VPC subnet CIDR block or a CIDR block of a Direct Connect connection.

source_type

No

Integer

0: VPC. Either network_id or cidr can be specified.

1: Direct Connect/Cloud Connect. Only cidr can be specified.

If no value is entered, the default value 0 (VPC) is used.

floating_ip_id

No

String

  • Specifies the EIP ID.
  • Maximum length: 4,096 characters

floating_ip_address

No

String

  • Specifies the EIP address.
  • Maximum length: 1,024 characters

status

No

String

  • Specifies the status of the SNAT rule.
  • For details about all its values, see Table 1.

admin_state_up

No

Boolean

  • Specifies whether the SNAT rule is frozen.
  • The value can be:
    • true: The SNAT rule is unfrozen.
    • false: The SNAT rule is frozen.

created_at

No

String

Specifies when the SNAT rule was created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

Request

None

Response

Table 2 lists response parameter.

Table 2 Response parameter

Parameter

Type

Description

snat_rules

List (SNAT rules)

Specifies objects of SNAT rules. For details, see Table 3.

Table 3 Description of the snat_rule field

Parameter

Type

Description

id

String

Specifies the SNAT rule ID.

tenant_id

String

Specifies the project ID.

nat_gateway_id

String

Specifies the public NAT gateway ID.

network_id

String

Specifies the network ID used by the SNAT rule.

cidr

String

Specifies a subset of the VPC subnet CIDR block or a CIDR block of a Direct Connect connection.

source_type

Integer

0: VPC. Either network_id or cidr can be specified.

1: Direct Connect/Cloud Connect. Only cidr can be specified.

If no value is entered, the default value 0 (VPC) is used.

floating_ip_id

String

  • Specifies the EIP ID. Use commas (,) to separate EIP IDs.
  • The maximum length is 4,096 bytes.
  • The number of EIP IDs cannot exceed 20.

floating_ip_address

String

  • Specifies the EIP. Use commas (,) to separate EIPs.
  • The maximum length is 1,024 bytes.

status

String

  • Specifies the status of the SNAT rule.
  • For details about all its values, see Table 1.

admin_state_up

Boolean

  • Specifies whether the SNAT rule is frozen.
  • The value can be:
    • true: The SNAT rule is unfrozen.
    • false: The SNAT rule is frozen.

created_at

String

Specifies when the SNAT rule was created (UTC time). Its value rounds to 6 decimal places for seconds. The format is yyyy-mm-dd hh:mm:ss.

Examples

  • Example request
    GET https://{Endpoint}/v2.0/snat_rules?limit=10
  • Example response
    {
        "snat_rules": [
          {
                "floating_ip_id": "bf99c679-9f41-4dac-8513-9c9228e713e1",
                "status": "ACTIVE",
                "nat_gateway_id": "cda3a125-2406-456c-a11f-598e10578541",
                "admin_state_up": true,
                "network_id": "9a469561-daac-4c94-88f5-39366e5ea193",
                "cidr": "null",
                "source_type":0,
                "tenant_id": "abc",
                "created_at": "2017-11-15 15:44:42.595173",
                "id": "79195d50-0271-41f1-bded-4c089b2502ff",
                "floating_ip_address": "5.21.11.242"
            },
            {
                "floating_ip_id": "6e496fba-abe9-4f5e-9406-2ad8c809ac8c",
                "status": "ACTIVE",
                "nat_gateway_id": "e824f1b4-4290-4ebc-8322-cfff370dbd1e",
                "admin_state_up": true,
                "network_id": "97e89905-f9c8-4ae3-9856-392b0b2fbe7f",
                "cidr": "null",
                "source_type":0,
                "tenant_id": "abc",
                "created_at": "2017-11-17 07:43:44.830845",
                "id": "4a1a10d7-0d9f-4846-8cda-24cffeffef5c",
                "floating_ip_address": "5.21.11.142"
            }
        ]
    }

Status Codes

See Status Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback