Jump to

• Request
• Response
• Examples

List All Stacks

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/stack/instances

Retrieves all stacks in the identity domain.

Request

Path Parameters

• identityDomainId: string
  Name of the Oracle Cloud identity domain

Query Parameters

• expand(optional): string
  The types of information to retrieve. Valid values are ALL, instances, resources, template and attributes.
• orderBy(optional): string
  The stack attributes used to sort the list. Valid values are createdOn, creator, name, type, and state.
• status(optional): string
  Retrieve only those stacks with this status. Valid values are NEW, INITIALIZING, READY, CONFIGURING, TERMINATING, STOPPING, STOPPED, STARTING, DISABLING, DISABLED and TERMINATED.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : viewallstacks-response

Type: object

The response body contains information about one or more cloud stacks.

Show Source

• applications(optional): array applications
  A list of cloud stacks.

{
    "description":"The response body contains information about one or more cloud stacks.",
    "properties":{
        "applications":{
            "type":"array",
            "description":"A list of cloud stacks.",
            "items":{
                "$ref":"#/definitions/viewstack-response"
            }
        }
    }
}

Nested Schema : applications

Type: array

A list of cloud stacks.

Show Source

• Array of: object viewstack-response
  The response body contains information about the stack.

{
    "type":"array",
    "description":"A list of cloud stacks.",
    "items":{
        "$ref":"#/definitions/viewstack-response"
    }
}

Nested Schema : viewstack-response

Type: object

The response body contains information about the stack.

Show Source

• createdBy(optional): string
  Name of the user who created the stack
• createdOn(optional): string
  Creation time of the stack
• creationJobId(optional): string
  ID of the job that created the stack
• description(optional): string
  Description of the stack
• identityDomain(optional): string
  Name of the Oracle Cloud identity domain
• modifiedOn(optional): string
  Modification time of the stack
• serviceName(optional): string
  Name of the stack
• state(optional): string
  Status of the stack
• stateDetail(optional): string
  Additional description about the stack status

{
    "description":"The response body contains information about the stack.",
    "properties":{
        "identityDomain":{
            "type":"string",
            "description":"Name of the Oracle Cloud identity domain"
        },
        "serviceName":{
            "type":"string",
            "description":"Name of the stack"
        },
        "description":{
            "type":"string",
            "description":"Description of the stack"
        },
        "state":{
            "type":"string",
            "description":"Status of the stack"
        },
        "stateDetail":{
            "type":"string",
            "description":"Additional description about the stack status"
        },
        "createdBy":{
            "type":"string",
            "description":"Name of the user who created the stack"
        },
        "createdOn":{
            "type":"string",
            "description":"Creation time of the stack"
        },
        "modifiedOn":{
            "type":"string",
            "description":"Modification time of the stack"
        },
        "creationJobId":{
            "type":"string",
            "description":"ID of the job that created the stack"
        }
    }
}

Back to Top

Examples

The following example shows how to view a list of stacks (instances) in Oracle Cloud Stack by submitting a GET request to the stacks endpoint.

cURL Command

curl -i -X GET \
-u yourUsername:yourPassword \
-H "X-ID-TENANT-NAME:MyIdentityDomain" \
https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances

Note: This example uses the URL prefix for the United States. 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: Thu, 25 Aug 2016 18:50:14 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

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

{
     "identityDomain": "MyIdentityDomain",
     "stacks": [
     {
          "serviceName": "MyStack",
          "description": "My first stack",
          "state": "READY",
          "stateDetail": "Ready",
          "identityDomain": "MyIdentityDomain",
          "createdBy": "yourUsername",
          "creationJobId": "80161",
          "createdOn": "2016-07-26T15:48:18.366+0000",
          "modifiedOn": "2016-07-26T15:48:18.365+0000",
          "links": [
               {
                    "rel": "canonical",
                    "href": "https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances/MyStack"
               },
               {
                    "rel": "self",
                    "href": "https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances/MyStack"
               }
          ]
     },
     {
          "serviceName": "MyStack2",
          "description": "My second stack",
          "state": "READY",
          "stateDetail": "Ready",
          "identityDomain": "MyIdentityDomain",
          "createdBy": "yourUsername",
          "creationJobId": "80161",
          "createdOn": "2016-07-27T15:48:18.366+0000",
          "modifiedOn": "2016-07-27T15:48:18.365+0000",
          "links": [
               {
                    "rel": "canonical",
                    "href": "https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances/MyStack2"
               },
               {
                    "rel": "self",
                    "href": "https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances/MyStack2"
               }
          ]

     }]
}

Back to Top