Lab 5: Working with REST APIs

Size: px

Start display at page:

Download "Lab 5: Working with REST APIs"

Clare Kelly
5 years ago
Views:

Lab 5: Working with REST APIs Oracle Database Cloud Service Hands On Lab 1) In this Lab we will install the REST Client Postman 2) Use Rest API calls to a) Create a database service b) List account

1 Lab 5: Working with REST APIs Oracle Database Cloud Service Hands On Lab 1) In this Lab we will install the REST Client Postman 2) Use Rest API calls to a) Create a database service b) List account instances c) Create a Storage Cloud container 1) Install the Postman Client in google chrome browser Open your chrome browser and copy paste the below URL. Click on Add to Chrome Button. dcbncdddomop?hl=en 2) It will ask for a confirmation, so go ahead and click on Add App

2 3) Confirm Postman Client has been added to your chrome browser. In your chrome browser enter chrome://apps/ and you should see postman client as highlighted below.

3 4) Click on the Postman Client and a new window opens up, Click on Take me Straight to the app. I ll create an account another time. 5) Now we are ready to use the Postman client. You should see a something like below.

4 2a) Use Rest API call to Create Database Instance 1) To make a REST API call from the Postman client, lets enter below inputs. a) Let s change the REST API method as POST, you can select it from the drop down list. Enter the REST API end point URL as {DoaminName} Change {DomainName} to the one assigned to you. c) In the Authorization Tab, select Type as Basic Auth. Enter the Username, Password that s provided to you.

for RAW b) Make sure the JASON (Application/jason) is selected in the drop down list.

5 2) Click on the Headers Tab Enter the below key-value data, use the DomainName that s provided to you a) X-ID-TENANT-NAME {DomainName} b) Content-Type application/json 3) Click on Body tab a) Select the Radio button for RAW b) Make sure the JASON (Application/jason) is selected in the drop down list. c) Now copy paste the below JASON API to create database. Update the Public Key Provided to you. { "description": "Lab5 Demo DB", "edition": "EE_HP",

6 "level": "PAAS", "servicename": "Lab5", "shape": "oc3", "subscriptiontype": "MONTHLY", "version": " ", "vmpublickeytext": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCHxmYyPHHE+vvkG/1RBfZFrA uwfmro0pztre71soyvz51iwqykao7qtgdyacpnjefjiz3gdriwi41jkmn mlbcckm4xti9y99st7q7hhul5ygnsimoamdkk7je1quafg7ql5kg6xaxw dzbikek7odb8dpqpha3efzxg33sr7inzs5evzqezusdfue8rbvnrw5tvzo G97a8TgzbJbtvkzxJdL5u+XsrbspyOQWACTlyjD7hzOh0pSuCUWIM1dmA OOA82VaAiEQgoRKaNYbfC+gN6TrvoD35nEasF1ROslRB+pZyyXSJ2f+nGz M7NPDTXfg2j1xFmmO5mg6tjFHlsV+mh", "parameters": [ { "type": "db", "usablestorage": "15", "adminpassword": "Labs123#", "sid": "ORCL", "pdbname": "PDB1", "failoverdatabase": "no", "backupdestination": "BOTH", "cloudstoragecontainer": " /Storage-bdef ec5a7257f08e72aebd3/Lab5Backup", "createstoragecontainerifmissing": true, "cloudstorageuser": "dbdevcloud_ww@oracle.com", "cloudstoragepwd": "XXXXXXXX" } ] }

7 4) Lets save this. Click on Save button on the top right. 5) A new window pops up. a) Enter a Request Name as Create Database using Rest API b) Enter New Collection Name as Oracle c) Click save.

8 6) You should see the saved entry on your left.

9 7) Now let s click on the Send Button. Make sure you click on it only once. This will make a REST API call to Oracle Database Cloud Service. Observer the status of the request as seen below on the bottom right. It should show as 202 Accepted. 8) Let s login to OPC Database Service Console check if instance provisioning has started. As you can see below status shows as Creating Service

10 2b) Use Rest API call to List Service Instances 1) To make a REST API call from the Postman client, let s enter below inputs. a) Let s change the REST API method as GET, you can select it from the drop down list. b) Enter the REST API end point URL as c) {DoaminName} Change {DomainName} to the one assigned to you. d) In the Authorization Tab, select Type as Basic Auth. Enter the Username, Password that s provided to you. e) Click on the Headers Tab Enter the below key-value data, use the DoaminName that s provided to you c) X-ID-TENANT-NAME {DomainName} d) Content-Type application/json

11 f) Lets save this. Click on Save button on the top right. g) A new window pops up. d) Enter a Request Name as List Service Instances e) Save to existing collection / Folder as Oracle f) Click save.

12 h) You should see the saved entry on your left.

13 i) Now let s click on the Send Button. This will make a REST API call to Oracle Database Cloud Service. Observer the status of the request as seen below on the bottom right. It should show as 200 OK. Observer the response which shows you the list of instances you have created in your Database Cloud Services

14 2c) Use Rest API call to Create Storage Cloud Container To create an object storage container in the Storage service, 1) Obtain the REST endpoints for your storage account from your storage service dashboard as follows, On you re my services dashboard, select View Details from the hamburger menu on the Storage service tile as shown below

15 On the Storage Service Details page make note of the following two REST endpoints,

16 2) Now go to the Postman client and create an API request to get a storage auth token a. Use the Auth V1 Enpoint URL in your Get request URL For eg. your URL should look something like this, auth/v1.0 b. In the Headers section provide X-Storage-User as X-Storage-User Storage-bdef ec5a7257f08e72aebd3:oowdemoXXX X-Storage-Pass <account_password>

17 Hit Send. You storage Auth token should appear in the response body. You should also see a status code OK 3) Use this Auth token to create a storage container using this PUT request. Note the PUT URL is constructed using the following format <REST Endpoint Permanent> / <ContainerName> Where <REST Endpoint Permanent> is the URL you obtained in step 1 and ContainerName is a valid container name you choose for eg. MyBackups An example URL for the PUT request would look like this,

https://storagebdef785401634ec5a7257f08e72aebd3.storage.oraclecloud.

18 In the Headers section create a key X-Auth-Token and provide the complete auth token received in the previous step. If all goes well, you should see status 201 Created in your response 1) Login to your My Services dashboard and click on Storage.

documentation and write an API call to start/stop a service instance?

19 2) You should see the name of the container that you created. Workshop Challenge: Can you read up Oracle Cloud s REST API documentation and write an API call to start/stop a service instance? Good luck!

Lab 2: Setting up secure access

Lab 2: Setting up secure access Oracle Database Cloud Service Hands On Lab This lab is divided into 3 parts 1. Securely Connecting to DBCS instance using Putty 2. Configuring SQL Developer for Secure Access