Retrieve Details of an IP Address Reservation Used in IP Networks
/network/v1/ipreservation/{name}
Required Role: To complete this task, you must have the Compute_Operations
role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.
Request
- application/oracle-compute-v3+json
-
name: string
The three-part name of the object (
/Compute-identity_domain/user/object
).
-
Cookie: string
The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.
Response
- application/oracle-compute-v3+json
200 Response
-
set-cookie: string
The cookie value is returned if the session is extended
object
-
description(optional):
string
Description of the object.
-
ipAddress(optional):
string
Reserved NAT IPv4 address from the IP address pool.
-
ipAddressPool(optional):
string
Name of the IP address pool to reserve the NAT IP from.
-
name(optional):
string
Name of the IP address reservation.
-
tags(optional):
array tags
Tags associated with the object.
-
uri(optional):
string
Uniform Resource Identifier
Examples
cURL Command
The following example shows how to retrieve details of an IP reservation by submitting a GET
request on the REST resource using cURL. For more information about cURL, see Use cURL.
Enter the command on a single line. Line breaks are used in this example for readability.
curl -X GET -H "Cookie: $COMPUTE_COOKIE" -H "Content-Type: application/oracle-compute-v3+json" -H "Accept: application/oracle-compute-v3+json" https://api-z999.compute.us0.oraclecloud.com/network/v1/ipreservation/Compute-acme/jack.jones@example.com/ipreservation1
-
COMPUTE_COOKIE
is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication. -
api-z999.compute.us0.oraclecloud.com
is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests. -
acme
andjack.jones@example.com
are example values. Replaceacme
with the identity domain ID of your Compute Classic account, andjack.jones@example.com
with your user name.
Example of Response Body
The following example shows the response body in JSON format.
{ "name": "/Compute-acme/jack.jones@example.com/ipreservation1", "uri": "https://api-z999.compute.us0.oraclecloud.com/network/v1/ipreservation/Compute-acme/jack.jones@example.com/ipreservation1", "description": null, "tags": [], "ipAddress": "10.252.152.90", "ipAddressPool": "/oracle/public/public-ippool" }