View Stack Details
get
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/stack/instances/{stackName}
Retrieve information about a specific stack
Request
Path Parameters
-
identityDomainId: string
Name of the Oracle Cloud identity domain
-
stackName: string
Name of the stack to retrieve
Query Parameters
-
expand(optional): string
The types of information to retrieve. Valid values are ALL, instances, resources, template and attributes.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : viewstack-response
Type:
objectThe 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
Examples
The following example shows how to monitor a specific stack in Oracle Cloud Stack by submitting a GET request to the endpoint for the stack.
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/MyStack
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. The properties displayed for each resource in the stack will vary by resource type. This example shows a stack that consists of an Oracle MySQL Cloud Service resource and an Oracle Application Container Cloud Service resource.
{
"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"
}
],
"serviceURI": "https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances/MyStack",
"template": {
"templateName": "MyTemplate",
"templateVersion": "1.0.0",
"templateURI": "https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/templates/cst/instances/MyTemplate?version=1.0.0"
},
"resources": {
"mysql": {
"serviceId": 1707,
"serviceName": "MyStack-mysql",
"serviceType": "MySQLCS",
"domainName": "MyIdentityDomain",
"serviceVersion": "5.7",
"releaseVersion": "5.7.13",
"metaVersion": "1.0.0-160706",
"serviceDescription": "DB used with ACCS",
"serviceLevel": "PAAS",
"subscription": "HOURLY",
"meteringFrequency": "HOURLY",
"edition": "EE",
"storageContainer": "Storage-MyIdentityDomain/MyContainer",
"state": "READY",
"creator": "yourUsername",
"creationDate": "2016-07-26T15:48:25.006+0000",
"attributes": {
"MYSQL_PORT": {
"displayName": "MySQL Port",
"type": "INTEGER",
"value": "3306",
"displayValue": "3306",
"isKeyBinding": true
},
"LOCAL_BACKUP_VOLUME_SIZE": {
"displayName": "Backup Volume Size",
"type": "STRING",
"value": "50G",
"displayValue": "50G",
"isKeyBinding": false
},
"CLOUD_STORAGE_CONTAINER": {
"displayName": "Cloud Storage Container",
"type": "STRING",
"value": "Storage-MyIdentityDomain/MyContainer",
"displayValue": "Storage-MyIdentityDomain/MyContainer",
"isKeyBinding": false
},
"BACKUP_DESTINATION": {
"displayName": "Backup Destination",
"type": "STRING",
"value": "BOTH",
"displayValue": "Both Cloud and Disk Storage",
"isKeyBinding": false
},
"LOCAL_BACKUP_VOLUME_MOUNT": {
"displayName": "Backup Volume Location",
"type": "STRING",
"value": "/u01/backup",
"displayValue": "/u01/backup",
"isKeyBinding": false
},
"DATA_VOLUME_SIZE": {
"displayName": "Usable Database Storage (GB)",
"type": "STRING",
"value": "25G",
"displayValue": "25G",
"isKeyBinding": false
}
}
},
"app": {
"serviceName": "MyStack-App",
"serviceType": "apaas",
"state": "RUNNING",
"stateDetail": "RUNNING",
"serviceStateDisplayName": "RUNNING",
"attributes": {"webURL": "http://someURL"},
"statistics": {
"ocpus": "",
"memory": 1,
"storage": "",
"publicIpAddressCount": ""
}
}
},
"statistics": {
"ocpus": 1,
"memory": 8.5,
"storage": 135,
"publicIpAddressCount": 1,
"resourceId": "MyStack"
},
"parameterValues": {
"Public key text": "**********",
"Backup container": "Storage-MyIdentityDomain/MyContainer",
"Mysql access password": "**********",
"Cloud Storage password": "**********",
"Cloud Storage user name": "MyIdentityDomain.yourUsername"
}
}