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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
admin_state_up |
No |
Boolean |
Specifies whether the SNAT rule is frozen. The value can be:
|
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 private networks connected to the VPC through Direct Connect or Cloud Connect. |
limit |
No |
Integer |
Specifies the number of records displayed on each page. Value range: 1 to 2000 Default value: 2000 |
floating_ip_address |
No |
String |
Specifies the EIP. Use commas (,) to separate multiple EIPs. The maximum length is 1,024 bytes. |
global_eip_address |
No |
String |
Specifies the global EIP. Use commas (,) to separate multiple global EIPs. The maximum length is 1,024 bytes. |
floating_ip_id |
No |
String |
Specifies the EIP ID. Use commas (,) to separate multiple EIP IDs. The maximum length is 4,096 bytes. |
global_eip_id |
No |
String |
Specifies the global EIP ID. Use commas (,) to separate multiple global EIP IDs. The maximum length is 4,096 bytes. |
id |
No |
String |
Specifies the SNAT rule ID. |
description |
No |
String |
Provides supplementary information about the SNAT rule. The description can contain up to 255 characters and cannot contain angle brackets (<>). |
created_at |
No |
Datetime |
Specifies when the SNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format. |
nat_gateway_id |
No |
Array of strings |
Specifies the public NAT gateway ID. |
network_id |
No |
String |
Specifies the network ID used by the SNAT rule. Configure either network_id or cidr. |
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. |
status |
No |
String |
Specifies the SNAT rule status. The value can be:
|
marker |
No |
String |
Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.
|
Request 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 value. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
snat_rules |
Array of NatGatewaySnatRuleResponseBody objects |
Specifies the response body for querying SNAT rules. |
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. |
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 private networks connected to the VPC through Direct Connect or Cloud Connect. |
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. |
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 (<>). |
status |
String |
Specifies the SNAT rule status. The value can be:
|
created_at |
Datetime |
Specifies when the SNAT rule was created. The time is in yyyy-mm-dd hh:mm:ss.SSSSSS format. |
network_id |
String |
Specifies the network ID used by the SNAT rule. Configure either network_id or cidr. |
admin_state_up |
Boolean |
Specifies whether the SNAT rule is frozen. The value can be:
|
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. |
Example Requests
GET https://{NAT_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" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
SNAT rules queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot