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

Querying Details of an SNAT Rule

Function

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

Constraints

null

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/snat_rules/{snat_rule_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Minimum: 1

Maximum: 36

snat_rule_id

Yes

String

Specifies the SNAT rule ID.

Minimum: 36

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token.

Minimum: 1

Maximum: 10240

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

snat_rule

NatGatewaySnatRuleResponseBody object

Specifies the response body for the SNAT rule.

Table 4 NatGatewaySnatRuleResponseBody

Parameter

Type

Description

id

String

Specifies the SNAT rule ID.

Minimum: 36

Maximum: 36

tenant_id

String

Specifies the project ID.

Minimum: 1

Maximum: 36

nat_gateway_id

String

Specifies the public NAT gateway ID.

Minimum: 36

Maximum: 36

cidr

String

Specifies a CIDR block or a host IP address. Configure either cidr or network_id. If you set source_type to 0, set cidr to a subset of the VPC subnet. If you set source_type to 1, set cidr to a CIDR block of your on-premises servers connected to the VPC through Direct Connect or Cloud Connect.

Minimum: 9

Maximum: 18

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, default value 0 (VPC) is used.

Minimum: 0

Maximum: 1

Default: 0

floating_ip_id

String

Specifies the EIP ID. Use commas (,) to separate multiple EIP IDs.

description

String

Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>).

Minimum: 0

Maximum: 255

status

String

Specifies the SNAT rule status. The value can be: ACTIVE: The SNAT rule is available. PENDING_CREATE: The SNAT rule is being created. PENDING_UPDATE: The SNAT rule is being updated. PENDING_DELETE: The SNAT rule is being deleted. EIP_FREEZED: The EIP is frozen. INACTIVE: The SNAT rule is unavailable.

Enumeration values:

  • ACTIVE

  • PENDING_CREATE

  • PENDING_UPDATE

  • PENDING_DELETE

  • EIP_FREEZED

  • INACTIVE

created_at

String

Specifies when the SNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format.

Minimum: 1

Maximum: 36

network_id

String

Specifies the network ID used by the SNAT rule. Configure either network_id or cidr.

Minimum: 36

Maximum: 36

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.

floating_ip_address

String

Specifies the EIP. Use commas (,) to separate multiple EIPs.

freezed_ip_address

String

Specifies the frozen EIP. Use commas (,) to separate frozen EIPs.

global_eip_id

String

Specifies the global EIP ID.

global_eip_address

String

Specifies the global EIP address.

Example Requests

GET https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/snat_rules/5b95c675-69c2-4656-ba06-58ff72e1d33

Example Responses

Status code: 200

SNAT rule details queried.

{
  "snat_rule" : {
    "floating_ip_id" : "bdc10a4c-d81a-41ec-adf7-de857f7c812a",
    "status" : "ACTIVE",
    "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
    "admin_state_up" : true,
    "network_id" : "eaad9cd6-2372-4be1-9535-9bd37210ae7b",
    "source_type" : 0,
    "tenant_id" : "d199ba7e0ba64899b2e81518104b1526",
    "created_at" : "2017-11-18 07:54:21.665430",
    "id" : "5b95c675-69c2-4656-ba06-58ff72e1d338",
    "floating_ip_address" : "5.21.11.226",
    "freezed_ip_address" : "",
    "description" : "my snat rule 01"
  }
}

Status Codes

Status Code

Description

200

SNAT rule details queried.

Error Codes

See Error Codes.