1. REST API for Oracle Java Cloud Service
  2. Tasks
  3. Snapshots

View a Snapshot

get

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/snapshots/{snapshotName}

Returns information about a snapshot of an Oracle Java Cloud Service instance.

Request

Path Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : view-snapshot
Type: object
Groups details of the snapshot.
Show Source
Nested Schema : cloneServices
Type: array
Array of JSON object elements, with one element for each service instance clone that was created from the snapshot.
Show Source
Nested Schema : metadata
Type: object
Groups metadata details of the service instance. This includes WLS component details, and OTD component details (if provisioned).
Show Source
Nested Schema : view-service-instance-clone
Type: object
Show Source
Nested Schema : attributes
Type: object
Groups attribute details.
Nested Schema : components
Type: object
Groups details about the WLS component and the OTD component (if provisioned).
Nested Schema : credentials
Type: object
Groups details of component and system credentials.
Back to Top

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"
}
Back to Top