Oracle Cloud Infrastructure Documentation

Create Execution

Use this API to create Bounce execution.

API

/selfservice/v1/customers/{supportIdentifier}/{serviceType}/products/bounce/instances/{instanceId}/executions

Scope and AuthZ

  • You must have mcs:oci:api:PrivilegedUser scope to access this API.
  • You can create bounce execution only for your customer instances.
  • You can use Bounce API only if customer has opted-in for bounce functionality.

Headers

  • Authorization: Bearer <Token>

    Where <Token> is the OAUTH token returned by the Authorization Server (JWT Token).

  • Identifier: <JWKS Identifier>

    Where <JWKS Identifier> is the GUID generated when JWKS URI is set by customer admin in self-service platform.

Dependency

Base Path

/selfservice/v1/

Functionality

  • This API allows the user to create a Bounce Execution for a customer instance.
  • Request fields that require explanation:
    • operation is any operation such as start, stop, or bounce.
    • services can be one of All, Apps, Components, AllwithVM, or AppswithVM.
    • blackOutDuration is the blackout duration to be set in a stop operation.
    • duration is the time needed for applying the patch.
    • bounceOptions specifies the components that need to be bounced. Applicable bounce options can be fetched using the dependency mentioned.
    • primaryContact is the contact to be used while creating the ticket. primaryContact a valid contact for the Customer Support Identifier (CSI)
  • Response field that requires explanation:
    • id is the unique identifier for the execution.

Verb

POST

Parameters

Name Type Description Mandatory
supportIdentifier Path parameter Customer Support Identifier (CSI) Yes
serviceType Path parameter Service type (For example, EBSO, EBSZ, or EBSI) Yes
instanceId Path parameter Target name or instance name on which patches have to be applied Yes

Sample request 

{
  "operation": "stop",
  "services": "All",
  "summary": "Submit Bounce",
  "duration": {
    "unit": "hours",
    "value": 4
  },
  "blackOutDuration": {
    "unit": "hours",
    "value": 2
  },
  "bounceOptions": {
    "options": [
      {
        "name": "CLEAR_APACHE_CACHE",
        "value": true
      },
      {
        "name": "MANAGED_SERVER",
        "value": false
      }
    ],
    "hosts": [
      {
        "name": "vserv1282.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "CONCURRENT_MANAGER",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          },
          {
            "name": "CLEAR_APACHE_CACHE",
            "value": false
          },
          {
            "name": "WORKFLOW_MAILER",
            "value": true
          }
        ]
      },
      {
        "name": "vserv1283.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "CONCURRENT_MANAGER",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          },
          {
            "name": "CLEAR_APACHE_CACHE",
            "value": false
          },
          {
            "name": "WORKFLOW_MAILER",
            "value": true
          }
        ]
      }
    ]
  },
  "ticketingDetails": {
    "primaryContact": "<email ID>",
    "customerNote": "Action Plan"
  }
}

Sample response

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ"
}