Create a Service Instance

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/BDCSCE/instances

Creates an Big Data Cloud Instance.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
The request body defines the details of the create service instance request.
Root Schema : Request Body
Type: object
Title: Request Body
Show Source
  • When you are using Oracle Cloud Infrastructure (OCI), provide the availabilityDomain string. Otherwise do not provide a value.
    Example: KiKR:PHX-AD-1
  • Name of an existing Container Service Classic container to be associated with the cluster, or a new one to be created. The container is used for writing application logs and reading application JARs and other supporting files. You must enter the complete (fully qualified) REST URL for Container Service Classic, appended by the container name. Copy the REST endpoint URL from the My Services page for Container Service Classic and append the container name to it. For example: https://a9999999.storage.oraclecorp.com/v1/Storage-a9999999/bdcsce . Note: The container name may not contain underscores. The same formatting requirement applies to the cloudStorageContainer attribute in the REST API.
    Example: https://a9999999.storage.oraclecorp.com/v1/Storage-a9999999/bdcsce
  • Enter password credential for the Oracle cloud storage account.
    Example: Welcome1
  • Enter username credential for the Oracle cloud storage account.
    Example: Storageadmin
  • components
    Title: components
    Contains configuration details of bdcsce.
  • OCI Cloud Storage Bucket URL eg: oci://bdcsce@mytenancy/ where bdcsce is the default bucket where application binaries and application logs are stored. mytenancy is your Tenancy
    Example: oci://bdcsce@mytenancy/
  • OCI Cloud Storage PEM Key Fingerprint. This has to be generated, please refer to 'How to Generate an API Signing Key' section in Oracle Cloud Infrastructure documentation.
    Example: none
  • OCI Cloud Storage PEM Key. This has to be generated, please refer to 'How to Generate an API Signing Key' section in Oracle Cloud Infrastructure documentation.
    Example: none
  • Full OCI Cloud Storage URL, eg: https://objectstorage.us-phoenix-1.oraclecloud.com .
    Example: https://objectstorage.us-phoenix-1.oraclecloud.com
  • OCI Cloud Storage User OCID. Refer to 'Required Keys and OCIDs' in Developer Tools documentation of Oracle Cloud Infrastructure
    Example: none
  • When you are using Oracle Cloud Infrastructure (OCI), provide the region string. Otherwise do not provide a value. Select a region that's within the default data region of your account. If your default data region is EMEA, then select eu-frankfurt-1 or uk-london-1. If your default data region is North America, then select us-ashburn-1 or us-phoenix-1.
    Example: us-phoenix-1
  • You may add an optional description that can be used to help identify this new service. The description is only used during service list display and is not used internally by Service Manager
  • Name of Big Data Cloud instance. The service name: Must not exceed 50 characters. Must start with a letter. Must contain only letters, numbers, or hyphens. Must not contain any other special characters. Must be unique within the identity domain.
  • When you are using Oracle Cloud Infrastructure (OCI), provide the subnet string. Specify the Oracle Cloud Identifier (OCID) of a subnet from a virtual cloud network (VCN) that you had created previously on Oracle Cloud Infrastructure. For the instructions to create a VCN and subnet, see Prerequisites for Oracle Platform Services on Oracle Cloud Infrastructure in the Oracle Cloud Infrastructure documentation. The OCID is a unique autogenerated ID. To find out the OCID of a subnet, go to the Oracle Cloud Infrastructure web console, select the Networking tab, click the VCN that your subnet is in, and look for the OCID field under the subnet that you want to use.
    Example: ocid1.subnet.oc1.phx.aaaaabbbbbcccccdddddeeeeefffffggggghhhhhiiiiijjjjjkkkkklllll
  • You can choose to enter a public key name, the public key text or have the service generate the key to use for service host access. SSH Access is disabled by default. To enable it, edit the Access Rules.
    Example: ssh-rsa AABBB3NzaC1yc2EAAAADAQABAAABAQDOOVKYC3NI6FQd63NTlEGhvGuk7+H69VCYXLC6JGIhaNQGb0DnEukcDVlONInrY0OFKD1NYFGPwuh+C65mgv3af+fCerUedWZwFKzuo+vNikQ9DOI7OIpCN3YHgZW43OmK51G2hfmi7QFjyNpJdUkw2GQb+IlP3lVAF4cQ5Pf1LZfn8oJVfDpAlZuIqR5MBDcoi/dNEO2a6o+Wm5tCOrkTuOLjOFqdWG0ugAsZyz/KwIZL9/ks4AGeM+RrJr8KA6Ck4XlSG62sMD4ph5GZSXQYsvodJjypC8XnAb6nW5LHEq6KYSooG/UBgzUVW0bsxFQoHO1nGtzZmn0KJd5Gu3rt xperiment
  • Enter default VM user.
    Example: opc
Example:
{
    "components":{
        "bdcsce":{
            "IDCSEnabled":"false",
            "adminUserName":"bdcsce_admin",
            "adminUserPassword":"Welcome-1",
            "bdfsCacheSize":"50",
            "clusterSize":"3",
            "deploymentProfile":"FULL",
            "hdfsStorage":"50",
            "shape":"oc2m",
            "sparkVersion":"2_1"
        }
    },
    "serviceDescription":"bdcsce trial instance",
    "serviceName":"bdcsce",
    "vmPublicKeyText":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDOOVKYC3NI6FQd63NTlEGhvGuk7+H69VCYXLC6JGIhaNQGb0DnEukcDVlONInrY0OFKD1NYFGPwuh+C65mgv3af+fCerUedWZwFKzuo+vNikQ9DOI7OIpCN3YHgZW43OmK51G2hfmi7QFjyNpJdUkw2GQb+IlP3lVAF4cQ5Pf1LZfn8oJVfDpAlZuIqR5MBDcoi/dNEO2a6o+Wm5tCOrkTuOLjOFqdWG0ugAsZyz/KwIZL9/ks4AGeM+RrJr8KA6Ck4XlSG62sMD4ph5GZSXQYsvodJjypC8XnAb6nW5LHEq6KYSooG/UBgzUVW0bsxFQoHO1nGtzZmn0KJd5Gu3rt xperiment",
    "vmUser":"opc"
}
Nested Schema : components
Type: object
Title: components
Contains configuration details of bdcsce.
Show Source
Nested Schema : bdcsce
Type: object
Title: bdcsce
Show Source
  • Pattern: (?=.*\d)(?=.*[a-z])(?=.*[A-Z])(?=.*\w).{8,}
    Password for the Big Data Cloud user. Password must be at least 8 characters long with at least one lower case letter, one upper case letter, one number and one special character. For example, Ach1z0#d.
    Example: Ach1z0#d
  • Default Value: admin
    Pattern: ^[a-zA-Z]+[a-zA-Z0-9_]{2,25}
    User name for the Big Data Cloud. User name should start with a letter, consist of letters and numbers, and be between 2 to 25 characters.
  • Minimum Value: 50
    Maximum Value: 74000
    Default Value: 50
    Usable Cache, value in GB. Actual allocated physical storage will be the value specified for BDFS plus additional 5% for intermediate logs. Oracle block storage has an inbuilt replication of 2x.
  • Minimum Value: 1
    Default Value: 3
    Big Data processing units are distributed across different VMs. Value must be atleast 1. Choosing 3 or more nodes provide high availability(HA) with multiple master nodes. If less than 3 nodes specified, only one node will be master node with all critical services running on same node in non-HA mode
  • Default Value: FULL
    Allowed Values: [ "BASIC", "FULL" ]
    Deployment Profile defines a specialized cluster that has been optimized for a specific use case. "FULL" - Provisions cluster with Spark, MapReduce, Zeppelin, Hive, Spark Thrift, Big Data File System. "BASIC" - Provisions cluster with Spark, MapReduce and Zeppelin
  • Minimum Value: 50
    Maximum Value: 512000
    Default Value: 50
    Usable HDFS Storage, value in GB. Actual allocated physical storage will be twice the value specified for HDFS replication plus additional 5% for intermediate logs
  • Default Value: false
    Designates whether IDCS authentication is enabled. If not enabled, HTTP Basic authentication is leveraged to authenticate a cluster user.
  • Default Value: SHARED
    Allowed Values: [ "SHARED", "EXCLUSIVE" ]
    Queue profile defines job queues appropriate for different types of workloads. Each queue has minimum guaranteed capacity and maximum allowed capacity. "SHARED" (Preemption On) option provides three queues with preemption - api(min:50, max:100), interactive(min:40, max:100) and default (min:10, max:100). "EXCLUSIVE" (Preemption Off) option provides two queues without preemption - dedicated(min:80, max:80) and default(min:20, max:20). Queue configuration can be customized on Cluster Manager.
  • Default Value: oc2m
    Allowed Values: [ "oc2m", "oc3m", "oc4m", "oc5m", "VM.Standard1.4", "VM.Standard1.8", "VM.Standard1.16", "VM.Standard2.2", "VM.Standard2.4", "VM.Standard2.8", "VM.Standard2.16", "VM.Standard2.24", "BM.Standard1.36" ]
    The compute shape to use for Big Data Cloud Servers. It defines how much memory, storage, and processing power should be allocated for each Virtual Machine of bdcsce. Compute Shape can be: oc2m: 2 OCPU, 30GB RAM. oc3m: 4 OCPU, 60GB RAM. oc4m: 8 OCPU, 120GB RAM. oc5m: 10 OCPU, 150GB RAM. VM.Standard1.4: 4 OCPU, 28GB RAM. VM.Standard1.8: 8 OCPU, 56GB RAM. VM.Standard1.16: 16 OCPU, 112GB RAM. VM.Standard2.2: 2 OCPU, 30GB RAM. VM.Standard2.4: 4 OCPU, 60GB RAM. VM.Standard2.8: 8 OCPU, 120GB RAM. VM.Standard2.16: 16 OCPU, 240GB RAM. VM.Standard2.24: 24 OCPU, 320GB RAM. BM.Standard1.36: 36 OCPU, 252GB.
  • Default Value: 1_6
    Allowed Values: [ "1_6", "2_1" ]
    Spark Version. Version of Spark to be installed.
Back to Top

Response

Supported Media Types

202 Response

Accepted. Submitted job to create your service instance. See Status Codes for information about other HTTP status codes.
Body ()
Root Schema : Response Body
Type: object
Title: Response Body
Show Source
Nested Schema : details
Type: object
Title: details
Show Source
Example Response (details)
{
    "jobId":"1572",
    "message":"Submitted job to create service [bdcsce] in domain [identity]."
}

412 Response

Precondition Failed. Rejected request to create service instance.
Body ()
Root Schema : Response Body
Type: object
Title: Response Body
Show Source
Nested Schema : details
Type: object
Title: details
Show Source
Nested Schema : issues-array
Type: array
Title: issues-array
Issues to be resolved for a succesfull request.
Show Source
  • Example: [Value for parameter [hdfsStor (5)] is not in valid limit 5-512000]
Example Response (details)
{
    "issues":[
        "[Value for parameter [hdfsStor (5)] is not in valid limit 5-512000]"
    ],
    "message":"Rejected create service [bdcsce] in domain [identity]."
}
Back to Top