Quick Start
Set up your environment and create your Oracle Big Data Cloud using the REST API by performing the following tasks.
Prerequisites
Prerequisite | More Information |
Learn about Oracle Cloud. | See Getting Started with Oracle Cloud for information about Oracle Cloud. |
Step 1: Obtain Account Information
The account creation e-mail from Oracle contains the identity domain name, user name, and password for your Oracle Big Data Cloud instance. If you do not have this information, then contact your service administrator.
Step 2: Install cURL
Examples within this documentation use cURL to send and receive requests from the Oracle Big Data Cloud.
-
Installing cURL, see Install cURL.
-
Authentication, see Authentication.
Step 3: Understand the Format of Resource URLs
-
See Send Requests.
-
You are now ready to start interacting with the Oracle Big Data Cloud REST API.
Step 4: Execute your first REST API call using cURL
This assumes everything is set up, and that you already created a Oracle Big Data Cloud instance.
curl -I -X GET \ -u "myusername:mypassword" \ -H "X-ID-TENANT-NAME: {identityDomainId}" \ -H "Accept: application/json" \ https://rest_server_url/paas/api/v1.1/instancemgmt/{identityDomainId}/services/cs/instances
-
myusername:mypassword
is the user name and password associated with the account, separated by a colon. -
{identityDomainId}
is the identity domain (tenant) associated with the account, which you enter when logging into the cloud. -
https://rest_server_url
is provided by your setup, as described in Send Requests.
The above will output the response header and response body, and provide information about all Oracle Big Data Cloud instances associated to the account and domain id. Output will look similar to:
server: Oracle-Application-Server-11g x-oracle-dms-ecid: 005FeC1q_mm3n355RvFCvd0004t91103mD x-oracle-dms-ecid: 005FeC1q_mm3n355RvFCvd0004t91103mD x-frame-options: DENY content-language: en content-type: application/json vary: user-agent date: Wed, 12 Dec 2016 23:05:02 GMT content-length: 11274 {"services":{ "MyTestInstance":{ "serviceId":64381, "serviceName":"MyTestInstance", "serviceType":"cs", "domainName":"mydomain", "serviceVersion":"16.4", ...
Note:
The response header text was included because-i
was passed into the cURL command. Remove
-i
to only see the body response (JSON).