Create a Service Instance

post

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

Create Oracle Event Hub Service instance to produce and consume messages. To create the service instance, you may need to specify the (systemName) attribute in body of this request (i.e Oracle Event Hub Cloud Service - Dedicated instance name on which you will host your Oracle Event Hub Cloud Service instance). If you create using UI, this is specified as (Hosted On). Other attributes supported are Number of Partitions (1 to 256) and Retention Period (24 hours to 336 hours i.e. 14 days). The replication factor is 1, 2, 3 by default for one node, two node, more than or equal to three node kafka cluster respectively. Replication factor is not exposed to the end user. Kafka 0.10.2 and Kafka 1.1.0 is supported for the Oracle Event Hub Cloud Service 18.3.4

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
  • Default Value: Delete
    Allowed Values: [ "Delete", "Compact" ]
    'Delete' policy deletes the log after retention period. 'Compact' policy ensures that Kafka will always retain at least the last known value for each message key within the log of data for a single topic partition. Use 'Compact' only with messages that specify keys.
  • This attribute is required only to create Oracle Event Hub Cloud Service topic and its value can only be "oracle".
  • Minimum Value: 1
    Maximum Value: 256
    Default Value: 2
    Number of Partitions, minimum is 1 and maximum is 256
  • Minimum Value: 24
    Maximum Value: 336
    Default Value: 24
    Number of hours to retain the log. Minimum is 24 hrs and maximum is 336 hrs
  • 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 Oracle Event Hub Cloud Service instance. The service name: Must not exceed 50 characters. Must start with a letter. Must contain only letters and numbers. Must not contain any other special characters. Must be unique within the identity domain.
  • Name of Oracle Event Hub Cloud Service - Dedicated instance to host this Oracle Event Hub Cloud Service instance. This attribute is required only to create Oracle Event Hub Cloud Service-Dedicated topic.
Example:
{
    "serviceName":"topicxyz",
    "serviceDescription":"string",
    "numPartitions":2,
    "retentionPeriod":24,
    "logCleanupPolicy":"Compact",
    "managedSystemType":"oracle"
}
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)
{
    "message":"Submitted job to create service [oehcs] in domain [identity].",
    "jobId":"1572"
}

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: [Number of hours to retain the log. Minimum 24 and Maximum 336 hours i.e. 14 days]
Example Response (details)
{
    "message":"Rejected create service [oehcs] in domain [identity].",
    "issues":[
        "[Number of hours to retain the log. Minimum 24 and Maximum 336  hours i.e. 14 days]"
    ]
}
Back to Top