1. REST API for Lifecycle Management in Oracle API Platform Cloud Service - Classic
  2. Tasks
  3. Service Instances

Create a Service Instance

post

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

Creates an API Platform Cloud Service - Classic instance.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : Request Body
Type: object
Title: Request Body
Show Source
  • Name of the Oracle Storage Cloud Service container used to provide storage for your service instance backups. Use the following format to specify the container name: <storageservicename>-<storageidentitydomain>/<containername>.
  • Password for the Oracle Storage Cloud Service administrator.
  • Username for the Oracle Storage Cloud Service administrator.
  • components
    components

  • Edition of the service instance; this value must be EE.

  • Free-form text that provides additional information about the service instance.
  • Service level for the service instance; this value must be PAAS.
  • Name of the API Platform Cloud Service - Classic 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.
  • The API Platform Cloud Service - Classic software version; this value must be 12cRelease2.
  • Billing unit. Valid values are:
    • HOURLY: Pay only for the number of hours used during your billing period. This is the default.
    • MONTHLY: Pay one price for the full month irrespective of the number of hours used.
  • Public key for the secure shell (SSH). This key will be used for authentication when connecting to the API Platform Cloud Service - Classic instance using an SSH client. You generate an SSH public-private key pair using a standard SSH key generation tool. See Accessing a VM Through a Secure Shell (SSH) in Using Oracle API Platform Cloud Service - Classic.
  • vm user.
Nested Schema : components
Type: object
components
Show Source
Nested Schema : OTD
Type: object
Show Source
  • Desired compute shape. A shape defines the number of Oracle Compute Units (OCPUs) and amount of memory (RAM). For this release, the only supported shape is oc3 (1 OCPU, 7.5 GB memory).

    See About Shapes in Using Oracle Compute Cloud Service for more information about shapes.

Nested Schema : WLS
Type: object
Show Source
  • Password for WebLogic Server administrator. The password must meet the following requirements:
    • Starts with a letter
    • Is between 8 and 30 characters long
    • Contains letters, at least one number, and optionally, any number of these special characters: dollar sign ($), pound sign (#), and underscore (_)
  • Username for the WebLogic Server administrator. The name must be between 8 and 128 characters long and cannot contain any of the following characters:
    • Tab
    • Brackets
    • Parentheses
    • The following special characters: left angle bracket (<), right angle bracket (>), ampersand (&), pound sign (#), pipe symbol (|), and question mark (?).
  • Username for the Oracle Database Cloud - Database as a Service instance administrator. This value must be set to a database user with SYSDBA system privileges. You can use the default user SYS or a user that has been granted the SYSDBA privilege.
  • Password for the Oracle Database Cloud - Database as a Service instance administrator.
  • Name of the Oracle Database Cloud - Databse as a Service instance to be used with the API Platform Cloud Service - Classic instance. The specified database service instance must be running.
  • Desired compute shape. A shape defines the number of Oracle Compute Units (OCPUs) and amount of memory (RAM). For this release, the only supported shape is oc3 (1 OCPU, 7.5 GB memory).

    See About Shapes in Using Oracle Compute Cloud Service for more information about shapes.

Back to Top

Response

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.
Headers
Back to Top

Examples

The following example shows how to create an Oracle API Platform Cloud Service - Classic instance by submitting a POST request on the REST resource using cURL. For more information about cURL, see cURL Examples. 

curl -i -X POST 
-u apicsadmin:password
-H "Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json"
-d @payload.json
https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances

Example of Request Body

The following shows a request body, in JSON format.

{
  "serviceName": "apics",
  "serviceLevel": "PAAS",
  "subscription": "MONTHLY",
  "serviceDescription": "Description of my API Platform Cloud Service instance.",
  "serviceVersion": "12cRelease2	",
  "edition": "EE",
  "noOfGatewayLicenses":"1",
  "cloudStorageUser": "apics.Storageadmin",
  "cloudStoragePassword": "password",
  "cloudStorageContainer": "Storage-apics/APICSBackup",
  "vmPublicKeyText": "Token key",
  "vmUser": "opc",
  "components": {
    "WLS": {
      "shape": "oc3",
      "adminUserName": "Admin",
      "adminPassword": "password",
      "dbServiceName": "mpadb4",
      "dbaName": "SYS",
      "dbaPassword": "Password_1"
    },
    "OTD": {
      "shape": "oc3"
    }
  }
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 202 Accepted
Date: Wed, 23 Nov 2016 08:54:39 GMT
Transfer-Encoding: chunked
Location: https://example.com:7103/paas/api/v1.1/activitylog/apics/job/26336
Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Service-URI: https://example.com:7103/paas/api/v1.1/instancemgmt/apics/services/APICS/instances/apics
Retry-After: 60
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: 7077e58cc81a37d2:-4cd90f8:15878a7e3f0:-8000-0000000000005d62
Access-Control-Allow-Origin: *
X-Frame-Options: DENY

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
	"details": {
		"message": "Submitted job to create service [apics] in domain [apics].",
		"jobId": "26336"
	}
}
Back to Top