Jump to

• Request
• Response
• Examples

View Application Instances

get

/paas/service/apaas/api/v1.1/apps/{identityDomainId}/{appName}/instances

Retrieves detailed information about all instances of an application.

Request

Path Parameters

• appName: string
  Name of the application
• identityDomainId: string
  Name of the identity domain for the Oracle Application Container Cloud Service acount

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

The response body contains information about all application instances.

Root Schema : viewInstances-response

Type: object

The response body contains information about all application instances.

Show Source

• applicationDetails(optional): string
  Information about the application
• identityDomain(optional): string
  Identity Domain of the application
• processes(optional): array processes
  Process details of an application

{
    "description":"The response body contains information about all application instances.",
    "properties":{
        "identityDomain":{
            "type":"string",
            "description":"Identity Domain of the application"
        },
        "applicationDetails":{
            "type":"string",
            "description":"Information about the application"
        },
        "processes":{
            "type":"array",
            "description":"Process details of an application",
            "items":{
                "$ref":"#/definitions/viewProcesses"
            }
        }
    }
}

Nested Schema : processes

Type: array

Process details of an application

Show Source

• Array of: object viewProcesses
  The response body contains information about all application processes.

{
    "type":"array",
    "description":"Process details of an application",
    "items":{
        "$ref":"#/definitions/viewProcesses"
    }
}

Nested Schema : viewProcesses

Type: object

The response body contains information about all application processes.

Show Source

• instances(optional): object instances
  Instances of the application process
• processName(optional): string
  Name of the process

{
    "description":"The response body contains information about all application processes.",
    "properties":{
        "processName":{
            "type":"string",
            "description":"Name of the process"
        },
        "instances":{
            "type":"object",
            "description":"Instances of the application process",
            "items":{
                "$ref":"#/definitions/viewInstance"
            }
        }
    }
}

Nested Schema : instances

Type: object

Instances of the application process

Show Source

• Array of: object viewInstance

{
    "type":"object",
    "description":"Instances of the application process",
    "items":{
        "$ref":"#/definitions/viewInstance"
    }
}

Nested Schema : viewInstance

Type: object

Show Source

• instanceURL(optional): string
  Instance URL. Use this url to get a description of the application instance.
• memory(optional): string
  Memory of the instance
• name(optional): string
  Instance Name. Use this name to manage a specific instance.
• status(optional): string
  Status of the instance

{
    "properties":{
        "name":{
            "type":"string",
            "description":"Instance Name. Use this name to manage a specific instance."
        },
        "status":{
            "type":"string",
            "description":"Status of the instance"
        },
        "memory":{
            "type":"string",
            "description":"Memory of the instance"
        },
        "instanceURL":{
            "type":"string",
            "description":"Instance URL. Use this url to get a description of the application instance."
        }
    }
}

Back to Top

Examples

The following example shows how to display details of all instances of an Oracle Application Cloud Service application by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, including how to determine your region, see Send Requests.

curl -i -X GET -u [e-mail]:Welcome1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/ExampleIdentityDomain/ExampleAppName/instances

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 
200 OK  
Date: Wed, 04 Feb 2015 21:24:33 GMT  
Transfer-Encoding: chunked  
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"processes": [
         {
             "processName": "web",
             "instances": [
                 {
                     "name": "web.1",
                     "status": "RUNNING",
                     "instanceURI": "https://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/ExampleIdentityDomain/ExampleAppName/instances/web.1"
                 }
             ]
         }
     ],
     "identityDomain": "ExampleIdentityDomain",
     "applicationDetails": "ExampleAppName"
 }

Back to Top