View a Snapshot
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/snapshots/{snapshotName}
Request
-
identityDomainId: string
Identity domain ID for the Oracle Java Cloud Service account.
-
serviceId: string
Name of the Oracle Java Cloud Service instance.
-
snapshotName: string
Name of the snapshot.
-
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
-
cloneCount(optional):
integer
Number of service instance clones created from this snapshot.
On Oracle Cloud Infrastructure Classic and Oracle Cloud at Customer: A snapshot cannot be deleted as long as there exists one or more service instance clones created from the snapshot.
-
cloneServices(optional):
array cloneServices
Array of JSON object elements, with one element for each service instance clone that was created from the snapshot.
-
description(optional):
string
Description of this snapshot.
-
metadata(optional):
object metadata
Groups metadata details of the service instance. This includes WLS component details, and OTD component details (if provisioned).
-
name(optional):
string
Name of this snapshot.
-
opStatusMessage(optional):
string
Last status message. For example:
Snapshot Succeeded
-
status(optional):
string
Status of the snapshot. For example:
Succeeded
-
timestamp(optional):
string
The date-and-time stamp when this snapshot was created.
array
object
-
attributes(optional):
object attributes
Groups attribute details.
-
components(optional):
object components
Groups details about the WLS component and the OTD component (if provisioned).
-
computeSiteName(optional):
string
Location of service instance.
-
credentials(optional):
object credentials
Groups details of component and system credentials.
-
edition(optional):
string
Current version for the service definition (schema) used by the service instance.
-
iaasPlatform(optional):
string
Platform of service instance.
-
metaVersion(optional):
string
Current version for the service definition (schema) used by the service instance.
-
meteringFrequency(optional):
string
Current version for the service definition (schema) used by the service instance.
-
releaseVersion(optional):
string
The specific Oracle WebLogic Server software binaries in use.
-
serviceLevel(optional):
string
Current version for the service definition (schema) used by the service instance.
-
serviceVersion(optional):
string
The Oracle WebLogic Server software release that was provisioned.
-
subscription(optional):
string
Current version for the service definition (schema) used by the service instance.
object
-
creationTime(optional):
string
The date-and-time stamp when the service instance clone was created.
-
description(optional):
string
Description of the service instance clone.
-
releaseVersion(optional):
string
The specific Oracle WebLogic Server software binaries in use. For example:
12.2.1.x
-
serviceName(optional):
string
Name of the service instance clone.
-
status(optional):
string
Status of the service instance clone. For example:
READY
-
version(optional):
string
The Oracle WebLogic Server software release in use. For example:
12cRelease214
object
object
object
Examples
The following example shows how to view details of a snapshot 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
curl -i -X GET -u username:password -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/snapshots/mySnapshot-1
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK
Date: Fri, 27 Oct 2017 20:34:29 GMT
Content-Length: 11338
Content-Language: en
Content-Type: application/json
Example of Response Body
The following shows an example of the response body.
{
"name":"mySnapshot-1",
"description":"Snapshot of the service instance ExampleInstance",
"cloneCount":1,
"timestamp":"2017-10-27T20:27:17.951+0000",
"remoteSnapshot":false,
"scheduledSnapshot":false,
"detachableSnapshot":false,
"cloneServices":
[
{
"version":"12cRelease214",
"serviceName":"ExampleInstanceClone",
"description":"Clone of ExampleInstance using the snaphot mySnapshot-1",
"creationTime":"2017-10-27T21:21:33.621+0000",
"status":"READY",
"releaseVersion":"12.2.1.4.201102"
}
],
"metadata":
{
"components":
{
"WLS":
{
"attributes":
{..},
"domainConfig":
{
"schemaPrefix":"Sp976387220",
"servers":
[
{
"machineName":"ExampleI_machine_1",
"listenAddress":"exampleinstance-wls-1.compute-exampleidentitydomain.oraclecloud.internal",
"name":"ExampleI_adminserver",
"listenPort":9071,
"isAdminServer":true
},
{
"clusterName":"ExampleI_cluster",
"machineName":"ExampleI_machine_1",
"listenAddress":"exampleinstance-wls-1",
"name":"ExampleI_server_1",
"listenPort":9073
}
],
"nodeManagers":
[
{
"listenAddress":"exampleinstance-wls-1",
"name":"ExampleI_machine_1",
"listenPort":5556
}
],
"dataSources":[],
"clusters":
[
{"name":"ExampleI_cluster"}
]
},
"componentType":"WLS",
"version":"12.2.1.4.0",
"releaseVersion":"12.2.1.4.170926",
"instanceName":"WLS",
"instanceRole":"NONE",
"isKeyComponent":true,
"credentials":{..},
"vmInstances":
{
"myjcsinstance-wls-1":
{
"vmId":108942,
"vmIndex":1,
"hostName":"exampleinstance-wls-1",
"label":"ExampleInstance wls 1",
"ipAddress":"10.xx.xxx.xx",
"publicIpAddress":"10.xx.xxx.xx",
"role":"ADMIN_SERVER",
"shapeId":"oc4",
"totalStorage":83968,
"isAdminNode":true,
"attributes":{},
"servers":
{
"ExampleI_adminserver":
{
"serverId":45392,
"serverName":"ExampleI_adminserver",
"serverType":"ADMIN",
"attributes":{..}
},
"myJCSins_server_1":
{
"serverId":45393,
"serverName":"ExampleI_server_1",
"serverType":"MS",
"attributes":{..}
}
},
"storageVolumes":
{..}
}
}
},
"OTD":
{
"componentType":"OTD",
"version":"12.2.1.3.0",
"releaseVersion":"12.2.1.3.201020",
"instanceName":"OTD",
"instanceRole":"NONE",
"isKeyComponent":false,
"attributes":{..},
"credentials":{..},
"vmInstances":
{
"exampleinstance-lb-1":
{
"vmId":108895,
"vmIndex":1,
"hostName":"exampleinstance-lb-1",
"label":"exampleinstance lb 1",
"ipAddress":"10.xx.xxx.xx",
"publicIpAddress":"10.xx.xxx.xx",
"role":"ADMIN_SERVER",
"shapeId":"oc3",
"totalStorage":70656,
"isAdminNode":true,
"attributes":{},
"servers":
{
"exampleinstance-lb-1":
{
"serverId":45346,
"serverName":"exampleinstance-lb-1",
"serverType":"OTD_SERVER",
"attributes":
{
"serviceListenerPort":"80",
"otdSystemAdminUser":"JaaS_System_OTD_Admin",
"otdConfigName":"opc-config",
"serviceSecuredListenerPort":"443",
"securedListenerPort":"8081",
"otdAdminUser":"username",
"listenerPortEnabled":"false",
"adminPort":"8989",
"policy":"LEAST_CONNECTION_COUNT",
"listenerPort":"8080"
}
}
},
"storageVolumes":{}
},
"exampleinstance-lb-2":
{
"vmId":108896,
"vmIndex":2,
"hostName":"exampleinstance-lb-2",
"label":"ExampleInstance lb 2",
"ipAddress":"10.xx.xxx.xxx",
"publicIpAddress":"10.xx.xxx.xxx",
"role":"NODE_VM",
"shapeId":"oc3",
"totalStorage":50176,
"isAdminNode":false,
"attributes":{},
"servers":
{
"exampleinstance-lb-2":
{
"serverId":45347,
"serverName":"exampleinstance-lb-2",
"serverType":"OTD_SERVER",
"attributes":
{
"serviceListenerPort":"80",
"otdSystemAdminUser":"JaaS_System_OTD_Admin",
"otdConfigName":"opc-config",
"serviceSecuredListenerPort":"443",
"securedListenerPort":"8081",
"otdAdminUser":"username",
"listenerPortEnabled":"false",
"adminPort":"8989",
"policy":"LEAST_CONNECTION_COUNT",
"listenerPort":"8080"
}
}
},
"storageVolumes":{}
}
}
}
},
"serviceVersion":"12cRelease214",
"releaseVersion":"12.2.1.4.201102",
"metaVersion":"17.4.4-1710250637",
"serviceLevel":"PAAS",
"subscription":"HOURLY","
"meteringFrequency":"HOURLY",
"edition":"EE",
"attributes":{..},
"credentials":{..}
},
"status":"Succeeded",
"opStatusMessage":"Snapshot Succeeded"
}