Oracle Management Cloud Common REST API

Get Started With Monitoring

Oracle Management Cloud provides comprehensive monitoring for all your applications. This REST API provides a simple programmatic way to query and manipulate all your metrics and monitoring data.

Out-of-the-Box Entity Types Reference

This reference guide lists all entities with examples supported by Oracle Management Cloud.

Oracle Management Cloud supports a number of entity types that don't have to be actively created and managed by the user. These include:

Hosts

The following host entity types are officially supported by Oracle Management Cloud.

These are the hosts that can be created out-of-the-box using the REST API for Oracle Management Cloud. The only required property is HostName.

Table - Hosts

Host Name	API Entity Type Name	Required Properties
IBM AIX	HostAIX	HostName
HP-UX	HostHPUX	HostName
Linux	HostLinux	HostName
Solaris	HostSolaris	HostName
Windows	HostWindows	HostName

Create a Host Entity Type

Create a new JSON file called Host.json and paste the following:

{
  "entityType": "HostLinux",
  "entityName": "host01.example.com",
  "properties": {
    "HostName": "host01.example.com"
  }
}

Running this curl command will create the entity HostLinux with a unique identifying property HostName.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entityTypes -d "@Host.json"

WebLogic

The following WebLogic-related entity types are officially supported by Oracle Management Cloud

These are the WebLogic-related entity types that can be created out-of-the-box using the REST API for Oracle Management Cloud:

WebLogic Server

API Entity Type Name: WebLogicServer

Required Properties

DomainHome
HostName
ServerNames

Optional Associations

WebLogicServer omc_uses Host
WebLogicServer omc_uses WebLogicNodeManager

Note that all Out-of-the-box entities must be created before adding associations.

Create a WebLogic Server Entity

Create a new JSON file called WebLogicServer.json and paste the following:

{
  "entityType": "WebLogicServer",
  "entityName": "weblogic.example.com",
  "properties": {
    "DomainHome":"/home/Oracle/Middleware/domains",
    "HostName":"weblogic.example.com",
    "ServerNames":"wlserver"
  }
}

Running this curl command will create the entity weblogic.example.com.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@WebLogicServer.json"

WebLogic Domain

API Entity Type Name: WebLogicDomain

Required Properties

DomainHome
AdministrationServerHost

Optional Associations

WebLogicDomain omc_contains WebLogicServer
WebLogicDomain omc_contains WebLogicCluster
WebLogicDomain omc_contains WebLogicNodeManager

Note that all Out-of-the-box entities must be created before adding associations.

Create a WebLogic Domain Entity

Create a new JSON file called WebLogicDomain.json and paste the following:

{
  "entityType": "WebLogicDomain",
  "entityName": "myTestDomain",
  "properties":{
    "DomainHome":"/home/Oracle/Middleware/domains",
    "AdministrationServerHost":"weblogic.example.com"
  }
}

Running this curl command will create the entity WebLogicDomain01.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@WebLogicDomain.json"

WebLogic Cluster

API Entity Type Name: WebLogicCluster

Required Properties

AdministrationServerHost
ClusterName

Optional Associations

WebLogicCluster omc_contains WebLogicServer

Note that all Out-of-the-box entities must be created before adding associations.

Create a WebLogic Cluster Entity

Create a new JSON file called WebLogicCluster.json and paste the following:

{
  "entityType": "WebLogicCluster",
  "entityName": "myTestCluster",
  "properties": {
    "AdministrationServerHost":"weblogic.example.com",
    "ClusterName":"myTestCluster",
  }
}

Running this curl command will create the entity myTestCluster.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@WebLogicCluster.json"

WebLogic Node Manager

API Entity Type Name: WebLogicNodeManager

Required Properties

HostName
WebLogicNodeManagerMiddlewareHome

Optional Associations

WebLogicNodeManager omc_uses WebLogicDomain
WebLogicNodeManager omc_uses Host

Note that all Out-of-the-box entities must be created before adding associations.

Create a WebLogic Node Manager Entity

Create a new JSON file called WebLogicNodeManager.json and paste the following:

{
  "entityType": "WebLogicNodeManager",
  "entityName": "myNodeManager",
  "properties":{
    "WebLogicNodeManagerMiddlewareHome":"/home/Oracle/Middleware/domains/nodemanager",
    "HostName":"weblogic.example.com"
  }
}

Running this curl command will create the entity myNodeManager.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@WebLogicNodeManager.json"

Oracle Database

The following Oracle Database entity types are officially supported by Oracle Management Cloud

These are the Oracle Database-related entity types that can be created out-of-the-box using the REST API for Oracle Management Cloud:

Oracle Database

API Entity Type Name: OracleDatabase

Required Properties

ServerName
Port
GlobalDatabaseName

Optional Associations

OracleDatabase omc_contains OracleDatabaseInstance
OracleDatabase omc_uses AutomaticStorageManagement
OracleDatabase omc_contains OraclePluggableDatabase
OracleDatabase omc_uses Host

Note that all Out-of-the-box entities must be created before adding associations.

Create a Oracle Database Entity

Create a new JSON file called OracleDatabase.json and paste the following:

{
  "entityType": "OracleDatabase",
  "entityName": "myTestDatabase",
  "properties": {
    "GlobalDatabaseName": "myTestDatabase",
    "Port": "1521",
    "ServerName": "testdatabase.example.com"
  }
}

Running this curl command will create the entity OracleDatabase01.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@OracleDatabase.json"

Oracle Database Instance

API Entity Type Name: OracleDatabaseInstance

Required Properties

ServerName
InstanceName

Optional Associations

OracleDatabaseInstance omc_uses Host

Note that all Out-of-the-box entities must be created before adding associations.

Create a Oracle Database Instance Entity

Create a new JSON file called OracleDatabaseInstance.json and paste the following:

{
  "entityType": "OracleDatabaseInstance",
  "entityName": "myTestInstance",
  "properties": {
    "ServerName": "testdatabase.example.com",
    "InstanceName": "myTestInstance"
  }
}

Running this curl command will create the entity myTestInstance.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@OracleDatabaseInstance.json"

Oracle Database Listener

API Entity Type Name: OracleDatabaseListener

Required Properties

HostName
OracleHome
Alias

Optional Associations

OracleDatabaseListener omc_uses OracleDatabase
OracleDatabaseListener omc_monitored_by OracleDatabaseInstance
OracleDatabaseListener use Host

Note that all Out-of-the-box entities must be created before adding associations.

Create a Oracle Database Listener Entity

Create a new JSON file called OracleDatabaseListener.json and paste the following:

{
  "entityType": "OracleDatabaseListener",
  "entityName": "myTestListener",
  "properties": {
    "HostName": "testdatabase.example.com",
    "OracleHome": "/u01/app/oracle/12.1.0.2/",
    "Alias": "myTestListener"
  }
}

Running this curl command will create the entity myTestListener.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@OracleDatabaseListener.json"

Oracle Database Cluster Listener

API Entity Type Name: OracleDatabaseClusterListener

Required Properties

HostName
ClusterwareHome
ListenerName

Optional Associations

OracleDatabaseClusterListener omc_uses OracleDatabase
OracleDatabaseClusterListener omc_contains OracleDatabaseListener

Note that all Out-of-the-box entities must be created before adding associations.

Create a Oracle Database Cluster Listener Entity

Create a new JSON file called OracleDatabaseClusterListener.json and paste the following:

{
  "entityType": "OracleDatabaseClusterListener",
  "entityName": "myTestClusterListener",
  "properties": {
    "HostName": "testdatabase.example.com",
    "ClusterwareHome": "/u01/app/crs/",
    "ListenerName": "myTestListener"
  }
}

Running this curl command will create the entity myTestClusterListener.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@OracleDatabaseClusterListener.json"

Oracle Database System

API Entity Type Name: OracleDatabaseSystem

Required Properties

DatabaseHostName
DatabaseGlobalName
Port

Optional Associations

OracleDatabaseSystem omc_contains OracleDatabase
OracleDatabaseSystem omc_uses OracleDatabaseListener
OracleDatabaseSystem omc_uses Host

Note that all Out-of-the-box entities must be created before adding associations.

Create a Oracle Database System Entity

Create a new JSON file called OracleDatabaseSystem.json and paste the following:

{
  "entityType": "OracleDatabaseSystem",
  "entityName": "myTestSystem",
  "properties": {
    "DatabaseHostName": "testdatabase.example.com",
    "DatabaseGlobalName": "myTestDatabase",
    "Port": "1521"
  }
}

Running this curl command will create the entity myTestSystem.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@OracleDatabaseSystem.json"

Automatic Storage Management

API Entity Type Name: AutomaticStorageManagement

Required Properties

Port
GlobalName
Version
AllHostNamesInternal

Optional Associations

AutomaticStorageManagement omc_contains AutomaticStorageManagementInstance
AutomaticStorageManagement omc_uses Host

Note that all Out-of-the-box entities must be created before adding associations.

Create a AutomaticStorageManagement Entity

Create a new JSON file called AutomaticStorageManagement.json and paste the following:

{
  "entityType": "AutomaticStorageManagement",
  "entityName": "myAutomaticStorageManagement",
  "properties": {
    "Port": "1521",
    "GlobalName": "myTestDatabase",
    "Version": "12.1.0.2",
    "AllHostNamesInternal": "testdatabase.example.com"
  }
}

Running this curl command will create the entity myAutomaticStorageManagement.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@AutomaticStorageManagement.json"

Automatic Storage Management Instance

API Entity Type Name: AutomaticStorageManagementInstance

Required Properties

HostName
InstanceName

Create a AutomaticStorageManagementInstance Entity

Create a new JSON file called AutomaticStorageManagementInstance.json and paste the following:

{
  "entityType": "AutomaticStorageManagementInstance",
  "entityName": "myAutomaticStorageManagementInstance",
  "properties": {
    "HostName": "testdatabase.example.com",
    "InstanceName": "myAutomaticStorageManagementInstance",
  }
}

Running this curl command will create the entity myAutomaticStorageManagementInstance.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@AutomaticStorageManagementInstance.json"

Oracle Pluggable Database

API Entity Type Name: OraclePluggableDatabase

Required Properties

PDBHostName
PDBPort
PDBServiceName
CDBNameforPDB

Optional Associations

OraclePluggableDatabase omc_monitored_by OracleDatabase
OraclePluggableDatabase omc_uses Host

Note that all Out-of-the-box entities must be created before adding associations.

Create a Oracle Pluggable Database Entity

Create a new JSON file called OraclePluggableDatabase.json and paste the following:

{
  "entityType": "OraclePluggableDatabase",
  "entityName": "myTestPluggableDatabase",
  "properties": {
    "PDBHostName": "testdatabase.example.com",
    "PDBPort": "1521",
    "PDBServiceName": "testdatabase.example.com",
    "CDBNameforPDB": ""
  }
}

Running this curl command will create the entity myTestPluggableDatabase.

curl -u USER:PASSWORD -X POST -H "Content-Type: application/json" https://OMC_URL:PORT/serviceapi/entityModel/uds/entities -d "@OraclePluggableDatabase.json"

Use Cases

Here are some common tasks that you might want to perform using the REST API for Oracle Management Cloud.

Use Case	More Information
Follow an End-to-End Example Journey Using REST API	Follow an End-to-End Example Journey Using REST API
Create and Monitor a Car Sharing Application	Create and Monitor a Car Sharing Application
Monitor Custom Entities Using the Metrics API	Monitor Custom Entities Using the Metrics API