Oracle Database Management REST API

Copyright © 2019 Oracle and/or its affiliates. All rights reserved. |
Oracle Database
Management REST API
Jeff Smith
Senior Principal Product Manager
Jeff.d.smith@oracle.com || @thatjeffsmith
Database Tools, Oracle Corp
1

Copyright © 2019, Oracle and/or its affiliates. All rights reserved. |
At a Glance
• Manage & Monitor your Oracle Database
• Supports 11gR2, 12, 18, & 19c
• REST Endpoints backed by ORDS
• General, Data Dictionary, Monitoring,
Performance, & PDB Lifecycle Management
• Database User Authentication via REST Enabled Schemas
2

Getting Started
• Install ORDS 19.1 or higher and configure your database
• Enable the DB API
• REST Enable an ADMIN Schema w/DBA (11g) or PDB_DBA (12c+) role
• OpenAPI {Swagger/JSON} doc available at
/ords/hr/_/db-api/latest/metadata-catalog/openapi.json

Configuring User for DB API
Option #1, Mid Tier User:
Option #2, DB User:

API Docs
Oracle Docs Swagger.JSON Mounted to API

Example: All Invalid Objects - Docs
• Find the right end point
• Try it out
6

Example: All Invalid Objects – Method + URL
GET http://localhost:8080/ords/hr/_/db-api/latest/database/objects/
• ORDS is running Standalone localhost:8080/ords
• HR is the REST Enable Schema with DBA /hr
• DB API mounted to _/db-api
• Version of API /latest
– /latest or /stable => current version
– /19.1.0 => specific version
• Objects URI /database/objects/

Example: All Invalid Objects - Response
{
"items": [
{
"owner": "SYS",
"object_name": "I_FILE#_BLOCK#",
"subobject_name": null,
"object_id": 9,
"data_object_id": 9,
"object_type": "INDEX",
"created": "2017-01-26T18:52:53Z",
"last_ddl_time": "2017-01-26T18:52:53Z",
"timestamp": "2017-01-26:13:52:53",
"status": "VALID",
"temporary": "N",
"generated": "N",
"secondary": "N",
"namespace": 4,
"edition_name": null,
"sharing": "NONE",
"editionable": null,
"oracle_maintained": "Y",
"application": "N",
"default_collation": null,
"duplicated": "N",
"sharded": "N",
"created_appid": null,
"created_vsnid": null,
"modified_appid": null,
"modified_vsnid": null,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/ords/hr/_/db-api/19.1.0/database/objects/SYS,I_FILE%23_BLOCK%23"
}
]
},
DBA_OBJECTS in {JSON} with links to individual objects

Example: All Invalid Objects - Paging
"hasMore": true,
"limit": 25,
"offset": 0,
"count": 25,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/ords/hr/_/db-api/19.1.0/database/objects/"
},
{
"rel": "describedby",
"href": "http://localhost:8080/ords/hr/_/db-api/19.1.0/metadata-catalog/"
},
{
"rel": "first",
"href": "http://localhost:8080/ords/hr/_/db-api/19.1.0/database/objects/"
},
{
"rel": "next",
"href": "http://localhost:8080/ords/hr/_/db-api/19.1.0/database/objects/?offset=25"
}
]
}
Paged Results (default pagesize 25)

Example: All Invalid Objects - Filtering
Getting ONLY Invalid Objects
Query Parameters on the URI
/ords/hr/_/db-api/19.1.0/database/objects/?q={"$eq":{"status":"INVALID"}}
New query is now
SELECT *
FROM DBA_OBJECTS
WHERE STATUS = ‘INVALID’;
Query Filtering Docs

Example: Data Pump
• Inputs
– What directory?
– What type of export?
– How many threads?
– What are we exporting?
• Response
– Links to get status/log

Example: Data Pump – Export 2 Tables in Local Schema (HR)
{
"datapump_dir": "DATA_PUMP_DIR",
"filter": "HOCKEY_STATS, UNTAPPD",
"job_mode": "TABLE",
"threads": 2
}
POST BODY Response

Example: Data Pump – Resources Created
"links": [
…,
{
"rel": "related",
"href": "http://localhost:8080/ords/hr/_/db-api/19.1.0/database/datapump/jobs/HR,DATAPUMP_REST_EXPORT_20190105140710/EXPDAT-2019-05-01-14_07_11.LOG"
},
{
"rel": "self",
"href": "http://localhost:8080/ords/hr/_/db-api/19.1.0/database/datapump/jobs/HR,DATAPUMP_REST_EXPORT_20190105140710/"
}
]
Job Log File
The Job and its metadata

Example: Data Pump – Log File

Example: Data Pump – Job Details

Example: Data Pump – Download the DMP!

Example: Data Pump – What it looks like in the database

What’s Next?
• OS Monitoring Endpoints (CPU, DISK, MEMORY, PROCESSES)
• DBCA
• Data Pump (complete)
Features Planned for CY2019
18

Oracle Database Management REST API

More Related Content

What's hot (20)

Similar to Oracle Database Management REST API (20)

More from Jeff Smith (20)

Recently uploaded (20)

Oracle Database Management REST API