REST API for Oracle SOA Cloud Service on Oracle Public Cloud Machine

View All Managed Servers

get

/api/v1.1/instances/{identityId}/{serviceId}/servers

Returns a list of managed servers for a service.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json
text/plain

202 Response

Body

Root Schema : ViewManagedServerResponse

Properties

serverInProgress: Type: array serverInProgress

Groups all servers that are in the process of being created, with the status of In Progress.
servers: Type: array servers

Groups all servers defined for the service instance.

Nested Schema : serverInProgress

Type: array

Groups all servers that are in the process of being created, with the status of In Progress.

Items

Type: object allservers

Nested Schema : servers

Type: array

Groups all servers defined for the service instance.

Items

Type: object allservers

Nested Schema : allservers

Properties

clusterName: Type: string

Name of the cluster to which the Managed Server belongs.
creationDate: Type: string

Date and time the server was created.
hostname: Type: string

Host name of the server.
isAdmin: Type: boolean

Flag that specifies whether this Managed Server is also the Administration Server.
jobId: Type: string

Job ID for the scale operation.
name: Type: string

Name of the server.
nodeType: Type: string

Type of node. For example, WLS or DG.
reservedIp: Type: string

IP address that is allocated from the IP address pool associated with the Managed Server. This attribute is valid only for the Administration Server or load balancer.
shape: Type: string

Compute shape of the server. See About Machine Images and Shapes in Using Oracle Compute Cloud Service.
status: Type: string

Status of the operation. For example, Ready.
storageAllocated: Type: string

Amount of allocated storage in MBs.

Examples

The following example shows how to view information about all Managed Servers for an Oracle SOA Cloud Service instance by submitting a GET request on the REST resource using cURL. For more information, see Use cURL.

cURL Command

curl -i -X GET -u joe@example.com:Welcome1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/servers

Note:: This example uses the URL prefix for the United States ( soacs). For information about the URL prefixes for other regions of the world, see Send Requests.

Example of Response Header

The following shows an example of the response header:

HTTP/1.1 200 OK
Date: Tue, 02 Sep 2014 12:52:22 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following shows an example of the response body:

{
   "servers":[
      {
         "clusterName":"ExampleI_cluster",
         "name":"ExampleI_server_1",
         "shape":"oc3m",
         "nodeType":"WLS",
         "isAdmin":true,
         "hostname":"123.45.6.78",
         "status":"Ready",
         "reservedIp":"",
         "storageAllocated":47000,
         "creationDate":"Jun 3, 2014 8:19:08 AM"
      },
      {
         "clusterName":"ExampleI_cluster"",
         "name":"ExampleI_server_2",
         "shape":"oc3m",
         "nodeType":"WLS",
         "isAdmin":false,
         "hostname":"ExampleI-wls-2",
         "status":"Ready",
         "reservedIp":"",
         "storageAllocated":27000,
         "creationDate":"Jun 3, 2014 8:19:30 AM"
      },
      {
         "clusterName":"ExampleI_cluster",
         "name":"ExampleI_server_3",
         "shape":"oc3m",
         "nodeType":"WLS",
         "isAdmin":false,
         "hostname":"ExampleI-wls-3",
         "status":"Ready",
         "reservedIp":"",
         "jobId":"17",
         "storageAllocated":27000,
         "creationDate":"Jun 3, 2014 9:04:15 AM"
      }],
   "serverInProgress":[
      {
         "clusterName":"MyCluster",
         "name":"ExampleI_server_4",
         "shape":"oc3m",
         "nodeType":"WLS",
         "isAdmin":false,
         "hostname":"myfirstinstance-wls-2",
         "status":"Preparing_VM",
         "reservedIp":"",
         "jobId":"705",
         "storageAllocated":28672,
         "creationDate":"Jan 29, 2015 8:27:45 PM"
      }
   ]
}