Oracle DBaaS OEM WebServices

EM12C Cloud APIs for database creation
DBaaS : Database as a Service

Johan Louwers
EM12C API Database creation
Calling application
Oracle Enteprise Manager 12C cloud APIs for

database as a service
Oracle EM12C
S
Case(s)
2
3
Use Oracle EM12C cloud APIs from a portal for creating a new
database
Use Oracle EM12C cloud APIs as part of a bigger external flow

requiring database creation.
Example variable
Capgemini : Database as a Service Johan Louwers. | 2014

Copyright 2014 Capgemini. All rights reserved.
Calling application
Oracle EM12C
Sub-flow from calling application to request databases creation
S
Case(s)
2
3
Within the calling application users can request the creation of a

new database as a standalone action.
Within in overall flow in the calling application the need arises to

create a new database as part of a larger request flow. For
example creating application server, database server and deploy
an application.
Example variable

Calling application
Oracle EM12C

(S) Start of sub-flow for database creation.
Input required.
A number of inputs are needed from a request form in the custom

calling application.
Inputs are specified in the next slides
2
3
Example variable

Calling application
Oracle EM12C

(1) Call EM12C API (A) for database creation
URI :
/em/cloud/dbaas/dbplatformtemplate/CC3BBB665A6BC6FFE040F00AEF252456
2
3
Request headers :
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
Content-Type:
application/oracle.com.cloud.common.DbPlatformInstance+json
BODY :
{
"zone": "/em/cloud/dbaas/zone/82CF1C28FA20A183C99D138FF8065F19",
"name": "<Request name>",
"description": "<Request Description>",
"params":
{
"username": "Master Account username for the DB",
"password": "Password for the Master Account on the DB",
"database_sid" : "Database SID" ,
"service_name" : "Name of the additional service to be created"
}
}
Example variable

Calling application
Oracle EM12C

Sample response :
{
2
3
"uri" : "/em/cloud/dbaas/dbplatforminstance/byrequest/1171" ,
"name" : "Test_create_intance" ,
"resource_state" :
{
"state" : "INITIATED"
} ,
"media_type" :
"application/oracle.com.cloud.common.DbPlatformInstance+json" ,
"canonicalLink" :
"/em/websvcs/restful/extws/cloudservices/service/v0/ssa/em/cloud/dbaas/
dbplatforminstance/byrequest/1171" ,
"status" : "SCHEDULED"
}
!! required to request status of creation process in step 3 !!
Example variable

Calling application
Oracle EM12C

curl example :
2
3
curl -k -u username:password -X POST -H "Content-Type:

application/oracle.com.cloud.common.DbPlatformInstance+json" -d
"{\"zone\":\"/em/cloud/dbaas/zone/82CF1C28FA20A183C99D138FF8065F19\",\"
name\":\"REQUEST_TESTDB\",\"description\":\ TEST DATABASE CREATE
\",\"params\":{\"username\":\TEST_ADMIN\",\"password\":\TEST_PASSWD\"
,\"service_name\":\TESTNAME\"}}"
https://example.company.com:7799/em/cloud/dbaas/dbplatformtemplate/CC3B
BB665A6BC6FFE040F00AEF252456
Example variable

Calling application
Oracle EM12C

curl example :
2
3

,\"service_name\":\"TESTNAME\"}}"
Username:password
Username & password of the self service user (inside OEM) who is
requesting the new database to be created.
Needs to be provided from a free text fields in the custom request
form within the calling application
Example variable

Calling application
Oracle EM12C

curl example :
2
3

Zone ID
Needs to be provided as the value of a dropdown menu in the custom
request form within the calling application where the visible text is a
meaningful text to humans. (when only one zone is available this could be a static hidden
value in the form)
Example variable
Can be delivered manually by DBaaS team or can be

queried via APIs
Calling application
Oracle EM12C

curl example :
2
3

Name
Name of the request. (possible naming convention 20 chars long & no spaces)
Needs to be provided from a free text field in the custom request form
within the calling application.
Will require java-script to enforce naming convention.

Example variable

10
Calling application
Oracle EM12C

curl example :
2
3

Description
Description of the request. (possible naming convention 50 chars long & no special chars)

Example variable

11
Calling application
Oracle EM12C

curl example :
2
3

Username (DB)
Master account username for the database. (possible naming convention 10 chars
long & no special chars)

Example variable

12
Calling application
Oracle EM12C

curl example :
2
3

Password (DB)
Master account password for the database. (possible naming convention min 8
chars long, should include at least one capital letter and a number)
Needs to be provided from a free password field in the custom

request form within the calling application.

Example variable

13
Calling application
Oracle EM12C

curl example :
2
3

Service name
Service name for the database. (possible naming convention min 10 chars long, should
all be capital letters, no special chars)
Needs to be provided from a free field in the custom request form


Example variable

14
Calling application
Oracle EM12C

curl example :
2
3

FQDN
FQDN of the EM12C server
Example variable

15
Calling application
Oracle EM12C

curl example :
2
3

Template ID
Needs to be provided as the value of a dropdown menu in the custom
request form within the calling application where the visible text is a
meaningful text to humans. (when only one template is available this could be a static
hidden value in the form)
Example variable
Can be delivered manually by DBaaS team or can be

queried via APIs
16
Calling application
Oracle EM12C

(2) Database creation takes, depending on the platform,
from a couple of seconds to a couple of minutes. Wait timer
for 3 minutes is advised before continuing to the next step.
2
3
Example variable

17
Calling application
Oracle EM12C

(3) Call EM12C API (B) for database creation process status
!! If the request is NOT completed return to step 2 !!
2
3
Example variable

18
Calling application
Oracle EM12C

URI :
/em/cloud/dbaas/dbplatforminstance/byrequest/1171
Request headers :
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
BODY :
2
3
!! ID from response message (A) !!
Example variable

19
Calling application
Oracle EM12C

curl example :
curl -k -u username:password
https://example.company.com.nl:7799/em/cloud/dbaas/dbplatforminstance/b
yrequest/1171
2
3
Username:password
Username & password of the self service user (inside OEM) who is
requesting the new database to be created.
Is already provided as part of input for step 1 Needs to be provided
from a free text fields in the custom request form within the calling
application
Example variable

20
Calling application
Oracle EM12C

curl example :
curl -k -u username:password
https://example.company.com.nl:7799/em/cloud/dbaas/dbplatforminstance/b
yrequest/1171
2
3
FQDN
FQDN of the EM12C server
Example variable

21
Calling application
Oracle EM12C

Sample response :
{
2
3
"name" : "REQUEST_TESTDB_CREATE_31_41" ,
"description" : "Create Database for \"REQUEST_TESTDB\"." ,
"resource_state" :
{
"state" : "CREATING"
} ,
"context_id" : "1171" ,
"media_type" :
"canonicalLink" :
"status" : "IN_PROGRESS" ,
"created" : "2014-11-24 18:31:43.0"
}
!! Indicating creation is not ready, return to step 2 !!
Example variable

22
Calling application
Oracle EM12C

Sample response :
{
2
3
"name" : "DBNAME.example.company.com" ,
"resource_state" :
{
"state" : "READY"
} ,
"context_id" : "1171" ,
"media_type" :
"canonicalLink" :
"status" : "RUNNING" ,
"created" : "2014-11-24 18:40:41.0" ,
"based_on" :
"/em/cloud/dbaas/dbplatformtemplate/CC3BBB665A6BC6FFE040F00AEF252456" ,
"connect_string" :
"(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=somehost.examp
le.company.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=TESTNAME.exampl
<SNIP>
Example variable
!! Indicating creation is done !!

23
Calling application
Oracle EM12C

Additional information.
2
3
Some examples of additional information in the response which can

be used in the calling application for next steps or to inform the
requesting user.
Name
: full database name
Created
: creation date of database
connect_string
: connection string for connecting to the database
master_username
: username of the database master account
db_version
: version of the database
standby_database_configured : standby database created (Boolean)
Example variable

24
Calling application
Oracle EM12C

Additional information.
Some examples of additional information in the response which can

be used in the calling application for next steps or to inform the
requesting user.
2
3
"measurable_attributes" :
[
{"name:"up_time,"value:"0,"units:"Hours} ,
{"name:"total_sga,"value:"4077.703,"units:"MB} ,
{"name:"available_space,"value:"1056.813,"units:"MB} ,
{"name:"cpu_utilization,"value:"0.071,"units:"%} ,
{"name:"total_memory,"value:"4253.839,"units:"MB} ,
{"name:"db_time,"value:".117,"units:"CentiSeconds Per Second},
{"name":"cpu_count","value":"2","units":"Cores}
]
Example variable

25
Calling application
Oracle EM12C

(E) End of sub-flow for database creation.
Next step.
The full end-to-end flow in the calling application can continue.
User could/should be informed on the details of the created database.
2
3
Example variable

26
More information

https://docs.oracle.com/cd/E24628_01/doc.121/e28814/dbaas_ssa_user_
api.htm#EMCLO1148

28
About Capgemini
With almost 140,000 people in over 40 countries, Capgemini is
one of the world's foremost providers of consulting, technology
and outsourcing services. The Group reported 2013 global
revenues of EUR 10.1 billion.
Together with its clients, Capgemini creates and delivers
business and technology solutions that fit their needs and drive
the results they want. A deeply multicultural organization,
Capgemini has developed its own way of working, the
Collaborative Business Experience, and draws on
Rightshore, its worldwide delivery model.
Learn more about us at www.capgemini.com.
www.capgemini.com
The information contained in this presentation is proprietary.
2014 Capgemini. All rights reserved.
Rightshore is a trademark belonging to Capgemini.

Oracle DBaaS OEM WebServices

Uploaded by

Copyright:

Available Formats

Oracle DBaaS OEM WebServices

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Oracle DBaaS OEM WebServices

Uploaded by

Copyright:

Available Formats

What is the purpose of the EM12C cloud API?

What is the purpose of the EM12C cloud API?

What are the main steps to create a database using the EM12C API?

What are the main steps to create a database using the EM12C API?

EM12C Cloud APIs for database creation

DBaaS : Database as a Service

EM12C API Database creation

Oracle Enteprise Manager 12C cloud APIs for

Use Oracle EM12C cloud APIs as part of a bigger external flow

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

Within the calling application users can request the creation of a

Within in overall flow in the calling application the need arises to

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

A number of inputs are needed from a request form in the custom

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

curl -k -u username:password -X POST -H "Content-Type:

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

curl -k -u username:password -X POST -H "Content-Type:

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

curl -k -u username:password -X POST -H "Content-Type:

Can be delivered manually by DBaaS team or can be

EM12C API Database creation

Sub-flow from calling application to request databases creation

curl -k -u username:password -X POST -H "Content-Type:

Will require java-script to enforce naming convention.

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

curl -k -u username:password -X POST -H "Content-Type:

Will require java-script to enforce naming convention.

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

curl -k -u username:password -X POST -H "Content-Type:

Will require java-script to enforce naming convention.

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation

curl -k -u username:password -X POST -H "Content-Type:

Needs to be provided from a free password field in the custom

Will require java-script to enforce naming convention.

Capgemini : Database as a Service Johan Louwers. | 2014

EM12C API Database creation

Sub-flow from calling application to request databases creation