1. REST API for Lifecycle Management in Oracle API Platform Cloud Service - Classic
  2. Tasks
  3. Service Instances

View a Service Instance

get

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

Returns information about an API Platform Cloud Service - Classic instance.

Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

Request

Path Parameters
  • Name of the identity domain for the API Platform Cloud Service - Classic account.
  • Name of the API Platform Cloud Service - Classic instance.

    Note: ServiceID is the user specified name for the service and is not the ID that's autogenerated for the instance.

Header Parameters
Back to Top

Response

Supported Media Types

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : Response Body
Type: object
Title: Response Body
Show Source
Nested Schema : activityLogs
Type: array
Activity logs for the service instance.
Show Source
Nested Schema : associatedServices
Type: object
Details about services associated with a service instance.
Show Source
Nested Schema : attributes
Type: object
Show Source
Nested Schema : backup
Type: object
Show Source
Nested Schema : components
Type: object
Show Source
Nested Schema : patching
Type: object
Show Source
Nested Schema : items
Type: object
Activity logs.
Show Source
Nested Schema : messages
Type: array
Messages related to the activity.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : STORES_ON
Type: array
Show Source
  • Contains the name and service type of each service associated with this service instance.
Nested Schema : dbaUserName
Type: object
Show Source
Nested Schema : FMW_ROOT
Type: object
Show Source
Nested Schema : OTD_ROOT
Type: object
Show Source
Nested Schema : WLS_ROOT
Type: object
Show Source
Nested Schema : operationInProgress
Type: object
Details about backup operations currently in progress.
Show Source
Nested Schema : OTD
Type: object
Show Source
Nested Schema : WLS
Type: object
Show Source
Nested Schema : attributes
Type: object
Show Source
Nested Schema : hosts
Type: object
Describes the hosts.
Show Source
Nested Schema : vmInstances
Type: object
Details about each VM instance.
Show Source
Nested Schema : ADMIN_PORT
Type: object
Show Source
Nested Schema : LISTENER_PORT
Type: object
Show Source
Nested Schema : LISTENER_PORT_ENABLED
Type: object
Show Source
Nested Schema : PRIV_LISTENER_PORT
Type: object
Show Source
Nested Schema : PRIV_SECURE_LISTENER_PORT
Type: object
Show Source
Nested Schema : SECURE_LISTENER_PORT
Type: object
Show Source
Nested Schema : userHosts
Type: object
Show Source
Nested Schema : host
Type: object
Details about a host.
Show Source
Nested Schema : vm
Type: object
Details about a specific VM instance.
Show Source
Nested Schema : attributes
Type: object
Show Source
Nested Schema : hosts
Type: object
Describes the hosts.
Show Source
Nested Schema : vmInstances
Type: object
Details about each VM instance.
Show Source
Nested Schema : adminPort
Type: object
Show Source
Nested Schema : adminServerName
Type: object
Show Source
Nested Schema : adminUserName
Type: object
Show Source
Nested Schema : applicationsHome
Type: object
Show Source
Nested Schema : clusterName
Type: object
Show Source
Nested Schema : CONNECT_DESC
Type: object
Show Source
Nested Schema : contentPort
Type: object
Show Source
Nested Schema : dbConnectDescriptor
Type: object
Show Source
Nested Schema : nodeManagerPort
Type: object
Show Source
Nested Schema : nodeManagerUser
Type: object
Show Source
Nested Schema : securedAdminPort
Type: object
Show Source
Nested Schema : securedContentPort
Type: object
Show Source
Nested Schema : startManagedServer
Type: object
Attributes of the startManagedServer object.
Show Source
Nested Schema : wlsDomainName
Type: object
Show Source
Nested Schema : userHosts
Type: object
Show Source
Nested Schema : host
Type: object
Details about a host.
Show Source
Nested Schema : servers
Type: object
Describes the servers.
Show Source
Nested Schema : server
Type: object
Details about a specific server.
Show Source
Nested Schema : vm
Type: object
Details about a specific VM instance.
Show Source
Nested Schema : servers
Type: object
Details about each server.
Show Source
Nested Schema : server
Type: object
Details about a specific server instance.
Show Source
Nested Schema : currentOperation
Type: object
Show Source
Back to Top

Examples

The following example shows how to return details for a specific Oracle API Platform Cloud Service - Classic instance in an identity domain by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Examples. 

curl -i -X GET 
-u apicsadmin:password
https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Tue, 20 Dec 2016 13:53:01 GMT
Transfer-Encoding: chunked
Content-Type: application/json
X-ORACLE-DMS-ECID: 7e2e7d12-3c4f-4772-ac47-02a08cfda1e5-00018b24
X-Frame-Options: DENY
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Access-Control-Allow-Origin: *

Example of Response Body

The following example shows the contents of the response body in JSON format, including information about the service instance.

{
  "serviceId": 103,
  "serviceName": "apics12041api",
  "serviceType": "APICS",
  "domainName": "apics",
  "serviceVersion": "12cRelease2",
  "releaseVersion": "16.4.5.0.0_12031012",
  "metaVersion": "16.4.5-12031012",
  "serviceLevel": "PAAS",
  "subscription": "MONTHLY",
  "meteringFrequency": "MONTHLY",
  "edition": "EE",
  "storageContainer": "Storage-apics/APICSBackup",
  "state": "READY",
  "creator": "weblogic",
  "creationDate": "2016-12-05T05:31:03.546+0000",
  "keyComponentInstance": "WLS",
  "adminHostName": "apics12041api-wls-1",
  "attributes": {
    "FMW_ROOT": {
      "displayName": "Open Fusion Middleware Control Console",
      "type": "URL",
      "value": "https://192.168.0.1:7002/em",
      "displayValue": "https://192.168.0.1:7002/em",
      "isKeyBinding": true
    },
    "dbaUserName": {
      "displayName": "Administration User Name",
      "type": "STRING",
      "value": "sys",
      "displayValue": "sys",
      "isKeyBinding": false
    },
    "OTD_ROOT": {
      "displayName": "Open Load Balancer Console",
      "type": "URL",
      "value": "https://192.168.0.1:8989/",
      "displayValue": "https://192.168.0.1:8989/",
      "isKeyBinding": true
    },
    "WLS_ROOT": {
      "displayName": "Open WebLogic Server Console",
      "type": "URL",
      "value": "https://192.168.0.1:7002/console",
      "displayValue": "https://192.168.0.1:7002/console",
      "isKeyBinding": true
    }
  },
  "components": {
    "WLS": {
      "serviceId": 103,
      "componentId": 54,
      "state": "READY",
      "version": "12.2.1",
      "componentType": "WLS",
      "creationDate": "2016-12-05T05:31:03.000+0000",
      "instanceName": "WLS",
      "instanceRole": "NONE",
      "attributes": {
        "startManagedServer": {
          "displayName": "Should Managed server be started on scale out",
          "type": "BOOLEAN",
          "value": "true",
          "displayValue": "true",
          "isKeyBinding": false
        },
        "nodeManagerPort": {
          "displayName": "Node manager port",
          "type": "INTEGER",
          "value": "5556",
          "displayValue": "5556",
          "isKeyBinding": false
        },
        "clusterName": {
          "displayName": "Cluster Name",
          "type": "STRING",
          "value": "apics1204_cluster",
          "displayValue": "apics1204_cluster",
          "isKeyBinding": false
        },
        "adminUserName": {
          "displayName": "User Name",
          "type": "STRING",
          "value": "weblogic",
          "displayValue": "weblogic",
          "isKeyBinding": false
        },
        "nodeManagerUser": {
          "displayName": "Node Manager User Name",
          "type": "STRING",
          "value": "weblogic",
          "displayValue": "weblogic",
          "isKeyBinding": false
        },
        "contentPort": {
          "displayName": "Content port",
          "type": "INTEGER",
          "value": "8001",
          "displayValue": "8001",
          "isKeyBinding": false
        },
        "securedAdminPort": {
          "displayName": "Secured Administration port",
          "type": "INTEGER",
          "value": "7002",
          "displayValue": "7002",
          "isKeyBinding": false
        },
        "CONNECT_DESC": {
          "displayName": "Connection String",
          "type": "STRING",
          "value": "apics1204api:1521/ORCL.opcics.example.usdv1.example.com",
          "displayValue": "apics1204api:1521/ORCL.opcics.example.usdv1.example.com",
          "isKeyBinding": false
        },
        "dbConnectDescriptor": {
          "displayName": "Connection String",
          "type": "STRING",
          "value": "apics1204api:1521/ORCL.opcics.example.usdv1.example.com",
          "displayValue": "apics1204api:1521/ORCL.opcics.example.usdv1.example.com",
          "isKeyBinding": false
        },
        "adminServerName": {
          "displayName": "Admin Server Name",
          "type": "STRING",
          "value": "apics1204_adminserver",
          "displayValue": "apics1204_adminserver",
          "isKeyBinding": false
        },
        "securedContentPort": {
          "displayName": "secured content port",
          "type": "INTEGER",
          "value": "8002",
          "displayValue": "8002",
          "isKeyBinding": false
        },
        "adminPort": {
          "displayName": "Admin port",
          "type": "INTEGER",
          "value": "7001",
          "displayValue": "7001",
          "isKeyBinding": false
        },
        "wlsDomainName": {
          "displayName": "Domain Name",
          "type": "STRING",
          "value": "apics1204_domain",
          "displayValue": "apics1204_domain",
          "isKeyBinding": false
        },
        "applicationsHome": {
          "displayName": "Applications Home",
          "type": "STRING",
          "value": "/u01/app/oracle/middleware/user_projects/applications/apics1204_domain",
          "displayValue": "/u01/app/oracle/middleware/user_projects/applications/apics1204_domain",
          "isKeyBinding": false
        }
      },
      "vmInstances": {
        "apics12041api-wls-1": {
          "vmId": 55,
          "id": 55,
          "uuid": "CFD6C14EC5A04DB8A944AB442F1D29E8",
          "hostName": "apics12041api-wls-1",
          "label": "apics12041api wls 1",
          "ipAddress": "192.168.0.1",
          "publicIpAddress": "192.168.0.1",
          "usageType": "ADMIN_SERVER",
          "role": "ADMIN_SERVER",
          "componentType": "WLS",
          "state": "READY",
          "shapeId": "oc3",
          "totalStorage": 74752,
          "creationDate": "2016-12-05T05:31:16.000+0000",
          "isAdminNode": true,
          "servers": {
            "apics1204_server_1": {
              "serverId": 103,
              "serverName": "apics1204_server_1",
              "serverType": "WLS",
              "serverRole": "MANAGED",
              "state": "READY",
              "creationDate": "2016-12-05T05:31:16.000+0000",
              "serverStateDisplayName": "Ready"
            },
            "apics1204_adminserver": {
              "serverId": 103,
              "serverName": "apics1204_adminserver",
              "serverType": "WLS",
              "serverRole": "ADMIN",
              "state": "READY",
              "creationDate": "2016-12-05T05:31:16.000+0000",
              "serverStateDisplayName": "Ready"
            }
          },
          "vmStateDisplayName": "Ready"
        },
        "apics12041api-wls-2": {
          "vmId": 56,
          "id": 56,
          "uuid": "3965112482744C0388633C428C1C611C",
          "hostName": "apics12041api-wls-2",
          "label": "apics12041api wls 2",
          "ipAddress": "192.168.0.1",
          "publicIpAddress": "192.168.0.1",
          "usageType": "MANAGED_SERVER",
          "role": "MANAGED_SERVER",
          "componentType": "WLS",
          "state": "READY",
          "shapeId": "oc3",
          "totalStorage": 54272,
          "creationDate": "2016-12-05T05:31:18.000+0000",
          "isAdminNode": false,
          "servers": {
            "apics1204_server_2": {
              "serverId": 103,
              "serverName": "apics1204_server_2",
              "serverType": "WLS",
              "serverRole": "MANAGED",
              "state": "READY",
              "creationDate": "2016-12-05T05:31:18.000+0000",
              "serverStateDisplayName": "Ready"
            }
          },
          "vmStateDisplayName": "Ready"
        }
      },
      "adminHostName": "apics12041api-wls-1",
      "hosts": {
        "userHosts": {
          "apics12041api-wls-1": {
            "vmId": 55,
            "id": 55,
            "uuid": "CFD6C14EC5A04DB8A944AB442F1D29E8",
            "hostName": "apics12041api-wls-1",
            "label": "apics12041api wls 1",
            "ipAddress": "192.168.0.1",
            "publicIpAddress": "192.168.0.1",
            "usageType": "ADMIN_SERVER",
            "role": "ADMIN_SERVER",
            "componentType": "WLS",
            "state": "READY",
            "shapeId": "oc3",
            "totalStorage": 74752,
            "creationDate": "2016-12-05T05:31:16.000+0000",
            "isAdminNode": true,
            "servers": {
              "apics1204_server_1": {
                "serverId": 103,
                "serverName": "apics1204_server_1",
                "serverType": "WLS",
                "serverRole": "MANAGED",
                "state": "READY",
                "creationDate": "2016-12-05T05:31:16.000+0000"
              },
              "apics1204_adminserver": {
                "serverId": 103,
                "serverName": "apics1204_adminserver",
                "serverType": "WLS",
                "serverRole": "ADMIN",
                "state": "READY",
                "creationDate": "2016-12-05T05:31:16.000+0000"
              }
            }
          },
          "apics12041api-wls-2": {
            "vmId": 56,
            "id": 56,
            "uuid": "3965112482744C0388633C428C1C611C",
            "hostName": "apics12041api-wls-2",
            "label": "apics12041api wls 2",
            "ipAddress": "192.168.0.1",
            "publicIpAddress": "192.168.0.1",
            "usageType": "MANAGED_SERVER",
            "role": "MANAGED_SERVER",
            "componentType": "WLS",
            "state": "READY",
            "shapeId": "oc3",
            "totalStorage": 54272,
            "creationDate": "2016-12-05T05:31:18.000+0000",
            "isAdminNode": false,
            "servers": {
              "apics1204_server_2": {
                "serverId": 103,
                "serverName": "apics1204_server_2",
                "serverType": "WLS",
                "serverRole": "MANAGED",
                "state": "READY",
                "creationDate": "2016-12-05T05:31:18.000+0000"
              }
            }
          }
        }
      },
      "displayName": "Weblogic Component"
    },
    "OTD": {
      "serviceId": 103,
      "componentId": 55,
      "state": "READY",
      "version": "11.1.9",
      "componentType": "OTD",
      "creationDate": "2016-12-05T05:31:03.000+0000",
      "instanceName": "OTD",
      "instanceRole": "NONE",
      "attributes": {
        "PRIV_LISTENER_PORT": {
          "displayName": "Privileged listener port",
          "type": "INTEGER",
          "value": "80",
          "displayValue": "80",
          "isKeyBinding": false
        },
        "LISTENER_PORT_ENABLED": {
          "displayName": "Enable listener port",
          "type": "BOOLEAN",
          "value": "false",
          "displayValue": "false",
          "isKeyBinding": false
        },
        "LISTENER_PORT": {
          "displayName": "Listener port",
          "type": "INTEGER",
          "value": "8080",
          "displayValue": "8080",
          "isKeyBinding": false
        },
        "SECURE_LISTENER_PORT": {
          "displayName": "Secured Listener port",
          "type": "INTEGER",
          "value": "8081",
          "displayValue": "8081",
          "isKeyBinding": false
        },
        "PRIV_SECURE_LISTENER_PORT": {
          "displayName": "Privileged secure listener port",
          "type": "INTEGER",
          "value": "443",
          "displayValue": "443",
          "isKeyBinding": false
        },
        "ADMIN_PORT": {
          "displayName": "Admin port",
          "type": "INTEGER",
          "value": "8989",
          "displayValue": "8989",
          "isKeyBinding": false
        }
      },
      "vmInstances": {
        "apics12041api-lb-1": {
          "vmId": 57,
          "id": 57,
          "uuid": "4DAA050E2EB84FDBB1BB11D1CC5BFA9E",
          "hostName": "apics12041api-lb-1",
          "label": "apics12041api lb 1",
          "ipAddress": "192.168.0.1",
          "publicIpAddress": "192.168.0.1",
          "usageType": "ADMIN_SERVER",
          "role": "ADMIN_SERVER",
          "componentType": "OTD",
          "state": "READY",
          "shapeId": "oc3",
          "totalStorage": 50176,
          "creationDate": "2016-12-05T05:31:23.000+0000",
          "isAdminNode": true,
          "vmStateDisplayName": "Ready"
        }
      },
      "adminHostName": "apics12041api-lb-1",
      "hosts": {
        "userHosts": {
          "apics12041api-lb-1": {
            "vmId": 57,
            "id": 57,
            "uuid": "4DAA050E2EB84FDBB1BB11D1CC5BFA9E",
            "hostName": "apics12041api-lb-1",
            "label": "apics12041api lb 1",
            "ipAddress": "192.168.0.1",
            "publicIpAddress": "192.168.0.1",
            "usageType": "ADMIN_SERVER",
            "role": "ADMIN_SERVER",
            "componentType": "OTD",
            "state": "READY",
            "shapeId": "oc3",
            "totalStorage": 50176,
            "creationDate": "2016-12-05T05:31:23.000+0000",
            "isAdminNode": true
          }
        }
      },
      "displayName": "Oracle Load Balancer"
    }
  },
  "associatedServices": {
    "STORES_ON": [
      {
        "serviceName": "apics1204api",
        "serviceType": "DBaaS"
      }
    ]
  },
  "activityLogs": [
    {
      "activityLogId": 10023,
      "serviceName": "apics12041api",
      "serviceType": "api",
      "identityDomain": "apics",
      "serviceId": 103,
      "jobId": 10736,
      "startDate": "2016-12-19T18:50:00.419+0000",
      "endDate": "2016-12-19T19:24:25.082+0000",
      "status": "FAILED",
      "operationId": 103,
      "operationType": "BACKUP",
      "summaryMessage": "BACKUP",
      "initiatedBy": "SYSTEM",
      "messages": [
        {
          "activityDate": "2016-12-19T18:50:00.419+0000",
          "message": "Activity Submitted"
        },
        {
          "activityDate": "2016-12-19T18:50:00.451+0000",
          "message": "Activity Started"
        },
        {
          "activityDate": "2016-12-19T19:00:38.351+0000",
          "message": "Backup health check passed...Locked the WebLogic Server domain configuration...Started the backup of configuration data for WebLogic administration server and managed servers...Completed the backup of configuration data for WebLogic administration server and managed servers...Started the backup of configuration data for Oracle Traffic Director admin host apics12041api-lb-1...Completed the backup of configuration data for Oracle Traffic Director admin node on apics12041api-lb-1...Started the backup of database...Unable to perform the database backup. Database backup utility reported the following error: INFO . The DBaaS Backup api cannot authenticate, please check your Cloud Storage credentials.*** OBKUP::ERROR END . Cannot complete config files backup. Cannot upload config file tar. The DBaaS Backup api cannot authenticate, please check your Cloud Storage credentials. ERROR: Getting Auth Token, check /var/opt/oracle/log/oss/token.out...Unlocked the WebLogic Server domain configuration..."
        },
        {
          "activityDate": "2016-12-19T19:02:38.396+0000",
          "message": "SM-BKP-5106: Operation failed and will be retried."
        },
        {
          "activityDate": "2016-12-19T19:12:15.954+0000",
          "message": "Backup health check passed...Locked the WebLogic Server domain configuration...Started the backup of configuration data for WebLogic administration server and managed servers...Completed the backup of configuration data for WebLogic administration server and managed servers...Started the backup of configuration data for Oracle Traffic Director admin host apics12041api-lb-1...Completed the backup of configuration data for Oracle Traffic Director admin node on apics12041api-lb-1...Started the backup of database...Unable to perform the database backup. Database backup utility reported the following error: INFO . The DBaaS Backup api cannot authenticate, please check your Cloud Storage credentials.*** OBKUP::ERROR END . Cannot complete config files backup. Cannot upload config file tar. The DBaaS Backup api cannot authenticate, please check your Cloud Storage credentials. ERROR: Getting Auth Token, check /var/opt/oracle/log/oss/token.out...Unlocked the WebLogic Server domain configuration..."
        },
        {
          "activityDate": "2016-12-19T19:14:16.001+0000",
          "message": "SM-BKP-5106: Operation failed and will be retried."
        },
        {
          "activityDate": "2016-12-19T19:24:23.856+0000",
          "message": "Backup health check passed...Locked the WebLogic Server domain configuration...Started the backup of configuration data for WebLogic administration server and managed servers...Completed the backup of configuration data for WebLogic administration server and managed servers...Started the backup of configuration data for Oracle Traffic Director admin host apics12041api-lb-1...Completed the backup of configuration data for Oracle Traffic Director admin node on apics12041api-lb-1...Started the backup of database...Unable to perform the database backup. Database backup utility reported the following error: INFO . The DBaaS Backup api cannot authenticate, please check your Cloud Storage credentials.*** OBKUP::ERROR END . Cannot complete config files backup. Cannot upload config file tar. The DBaaS Backup api cannot authenticate, please check your Cloud Storage credentials. ERROR: Getting Auth Token, check /var/opt/oracle/log/oss/token.out...Unlocked the WebLogic Server domain configuration..."
        },
        {
          "activityDate": "2016-12-19T19:24:25.082+0000",
          "message": "Activity Ended"
        }
      ]
    }
  ],
  "layeringMode": "Single",
  "serviceLevelDisplayName": "Oracle Java Cloud Service",
  "editionDisplayName": "Enterprise Edition",
  "meteringFrequencyDisplayName": "Monthly",
  "OTD_ROOT": "https://192.168.0.1:8989/",
  "dbaUserName": "sys",
  "FMW_ROOT": "https://192.168.0.1:7002/em",
  "WLS_ROOT": "https://192.168.0.1:7002/console",
  "totalSharedStorage": 0,
  "serviceStateDisplayName": "Ready",
  "computeSiteName": "example",
  "patching": {
    "currentOperation": {
      "operation": "NONE"
    },
    "totalAvailablePatches": 0
  },
  "backup": {
    "operationInProgress": {},
    "lastFailedBackupDate": "2016-12-19T18:50:00.554+0000"
  }
}
Back to Top