Get Execution Details

Use this API to get details for a bounce execution.

API

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

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can get bounce execution details only for your customer.
  • 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.

Base Path

/selfservice/v1/

Dependency

Functionality

  • This API allows you to get details for a bounce execution.
  • Response 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 API to get bounce options for an instance.
    • primaryContact is the contact to be used while creating the ticket. This parameter must be a valid contact for the Customer Support Identifier (CSI).

Verb

GET

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
executionId Path parameter Unique execution ID for the patch execution Yes

Sample response

{
  "id": "3-7JZXAMZ",
  "target": "DCMATI",
  "operation": "stop",
  "services": "all",
  "duration": {
    "unit": "hours",
    "value": 4
  },
  "blackOutDuration": {
    "unit": "hours",
    "value": 2
  },
  "summary": "Submit Bounce",
  "scheduledStart": "2020-08-26T8:53:51-07:00",
  "scheduledEnd": "2020-08-26T10:53:51-07:00",
  "scheduledBy": "<email ID>",
  "isLogs": true,
  "createdOn": "2020-08-25T6:51:41-07:00",
  "createdBy": "<email ID>",
  "updatedOn": "2020-08-25T6:51:41-07:00",
  "updatedBy": "<email ID>",
  "bounceOptions": {
    "options": [
      {
        "name": "CLEAR_APACHE_CACHE",
        "value": true
      }
    ],
    "hosts": [
      {
        "name": "vserv1282.us.oracle.com",
        "tier": "MT",
        "options": [
          {
            "name": "APACHE",
            "value": true
          },
          {
            "name": "CONCURRENT_MANAGER",
            "value": true
          },
          {
            "name": "OPMN",
            "value": true
          },
          {
            "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": "WORKFLOW_MAILER",
            "value": true
          }
        ]
      }
    ]
  },
  "ticketingDetails": {
    "rfcNumber": "3-7JZXAMZ",
    "primaryContact": "<email ID>",
    "customerNote": "Action Plan",
    "rfcType": "OCIEBS_Prod_SelfService",
    "rfcSubType": "SelfService_Bounce",
    "status": "Open",
    "subStatus": "Ready For Execution",
    "customerStatus": "Acknowledged"
  }
}