View All IP Reservations
/paas/api/v1.1/network/{identityDomainId}/services/jaas/ipreservations
Returns information about the IP reservations created for Oracle Java Cloud Service in the given identity domain. Both used and unused IP reservations are returned.
IP reservations are assigned to Java Cloud Service instances that are attached to shared networks or IP networks. This endpoint can be used with the ?networkType
query parameter to get all IP reservations (that is, for use with both IP networks and shared networks) or only those IP reservations that can be assigned to instances associated with IP networks. If you use the endpoint without specifying the query paramater, only those that can be used with shared networks are returned.
Request
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
networkType(optional): string
Allowed values (case-sensitive):
ALL
: Get details of all IP reservations (with shared networks and IP networks).IPNetwork
: Get details of only those IP reservations that can be assigned to instances attached to IP networks.
-
Authorization: string
Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
-
X-ID-TENANT-NAME: string
Identity domain ID for the Oracle Java Cloud Service account.
Response
- application/json
200 Response
object
-
activities(optional):
array activities
Groups details about ongoing and failed activity messages, if any.
-
ipReservations(optional):
array ipReservations
Groups all IP reservations.
array
object
-
activity(optional):
object activity
Ongoing and failed activities, if any.
object
-
message(optional):
string
Activity detail.
-
status(optional):
string
Activity status.
object
-
accountId(optional):
string
This is no longer available. The identity domain ID and service type of the service. For example,
myidentitydomain_JAAS
, whereJAAS
is the service type of Oracle Java Cloud Service. -
computeSiteName(optional):
string
Location of the IP reservation.
-
creationTime(optional):
string
Date and time the IP reservatione was created.
-
hostName(optional):
string
Name of the Managed Server or Load Balancer node that is using the named IP reservation. This attribute is only returned if the IP reservation is in use.
-
id(optional):
string
Id of the IP reservation.
-
identityDomain(optional):
string
The identity domain ID of the service.
-
ipAddress(optional):
string
The public IP address for the IP reservation.
-
name(optional):
string
Name of the IP reservation.
-
networkType(optional):
string
Indicates whether the IP reservation is intended for instances attached to IP networks or the shared network. This attribute is only returned for IP reservations that are intended to be used with IP networks.
-
serviceEntitlementId(optional):
string
Entitlement ID used to identify the service in the account.
-
serviceName(optional):
string
Name of the Oracle Java Cloud Service instance where the named IP reservation is used. This attribute is only returned if the IP reservation is in use.
-
serviceType(optional):
string
The service type of the service. For example,
JaaS
is the service type of Oracle Java Cloud Service. -
status(optional):
string
Status of the IP reservation. Valid values:
INITIALIZING
,UNUSED
,USED
.
Examples
The following example shows how to view all IP reservations created for Oracle Java Cloud Service, by submitting a GET request on the REST resource using cURL.
Note: The command in this example uses the URL structure https://rest_server_url/resource-path
, where rest_server_url
is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.
cURL Command
-
To get the details of all the IP reservations:
curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/network/ExampleIdentityDomain/services/jaas/ipreservations?networkType=ALL
-
To get the details of the IP reservations that can be assigned to only instances attached to the shared network:
curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/network/ExampleIdentityDomain/services/jaas/ipreservations
-
To get the details of the IP reservations that can be assigned to only instances attached to IP networks:
curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/network/ExampleIdentityDomain/services/jaas/ipreservations?networkType=IPNetwork
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK
Date: Wed, 22 Mar 2017 21:24:07 GMT
Content-Language: en
Content-Type: application/json
Example of Response Body
The following is an example of the response returned in JSON format, showing USED and UNUSED IP reservations. This sample response is for a request that included the optional ?networkType=ALL
query parameter.
{
"ipReservations": [
{
"id": 10008,
"name": "ipres03",
"ipAddress": "111.111.111.111",
"status": "UNUSED",
"identityDomain": "exampleidentitydomain",
"serviceType": "JaaS",
"computeSiteName": "uscom-central-1",
"serviceEntitlementId": "1111111111",
"creationTime": "2018-04-10T15:49:40.874+0000"
},
{
"id": 12009,
"name": "ipres04",
"networkType": "IPNetwork",
"ipAddress": "111.111.11.1",
"status": "UNUSED",
"identityDomain": "exampleidentitydomain",
"serviceType": "JaaS",
"computeSiteName": "uscom-east-1",
"serviceEntitlementId": "1111111111",
"creationTime": "2018-06-05T20:31:14.022+0000"
},
{
"id": 7505,
"name": "ipres01",
"ipAddress": "129.158.72.44",
"status": "UNUSED",
"identityDomain": "exampleidentitydomain",
"serviceType": "JaaS",
"computeSiteName": "uscom-east-1",
"serviceEntitlementId": "1111111111",
"creationTime": "2018-02-06T22:36:42.562+0000"
},
{
"id": 9359,
"name": "ipres02",
"networkType": "IPNetwork",
"ipAddress": "111.111.111.11",
"status": "USED",
"identityDomain": "exampleidentitydomain",
"serviceType": "JaaS",
"computeSiteName": "uscom-east-1",
"serviceName":"ExampleInstance",
"hostName":"exampleinstance-wls-3",
"serviceEntitlementId": "1111111111",
"creationTime": "2018-03-21T05:06:47.480+0000"
}
],
"activities": [
{
"activity": {
"message": "Creation of [ipres05] ip reservation(s) is in progress.",
"status": "RUNNING"
}
}
]
}