Querying SNAT Rules

Function

This API is used to query SNAT rules.

Constraints

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

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/snat_rules

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. Minimum: 1 Maximum: 36

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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.
cidr	No	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.
limit	No	Integer	Specifies the number of records displayed on each page. Value range: 0 to 2000 Default value: 2000 Minimum: 1 Maximum: 2000 Default: 2000
floating_ip_address	No	Array	Specifies the EIP. Array Length: 1 - 20
floating_ip_id	No	Array	Specifies the EIP ID. Array Length: 1 - 20
id	No	String	Specifies the SNAT rule ID. Minimum: 1 Maximum: 36
description	No	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
created_at	No	String	Specifies when the SNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format. Minimum: 1 Maximum: 36
nat_gateway_id	No	Array	Specifies the public NAT gateway ID. Array Length: 1 - 10
network_id	No	String	Specifies the network ID used by the SNAT rule. Configure either network_id or cidr. Minimum: 36 Maximum: 36
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, default value 0 (VPC) is used. Minimum: 0 Maximum: 1 Default: 0
status	No	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
marker	No	String	Specifies the ID of the resource from which a pagination query starts, indicating that the query starts from the next record of the specified resource. If parameters marker and limit are not specified, all resource records (2,000 by default) on the first page will be returned. If marker is not specified and limit is set to 10, the first to tenth resource records will be returned. If marker is set to the resource ID of the tenth record and limit is set to 10, the 11th to 20th resource records will be returned. If marker is set to the resource ID of the tenth record and limit is not specified, the eleventh and subsequent resource records (2,000 by default) will be returned. Minimum: 36 Maximum: 36

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
snat_rules	Array of NatGatewaySnatRuleResponseBody objects	Specifies the response body for querying SNAT rules. Array Length: 2000 - 0

**Table 5** 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?limit=2

Example Responses

Status code: 200

SNAT rules queried.

{
  "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",
    "source_type" : 0,
    "tenant_id" : "d199ba7e0ba64899b2e81518104b1526",
    "created_at" : "2017-11-15 15:44:42.595173",
    "id" : "79195d50-0271-41f1-bded-4c089b2502ff",
    "floating_ip_address" : "5.21.11.242",
    "freezed_ip_address" : "",
    "description" : "my snat rule 01"
  }, {
    "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",
    "source_type" : 0,
    "tenant_id" : "d199ba7e0ba64899b2e81518104b1526",
    "created_at" : "2017-11-17 07:43:44.830845",
    "id" : "4a1a10d7-0d9f-4846-8cda-24cffeffef5c",
    "floating_ip_address" : "5.21.11.142,5.21.11.143",
    "freezed_ip_address" : "5.21.11.142",
    "description" : "my snat rule 01"
  } ]
}