Get Execution Details

Use this API get details for a CEMLI patch execution.

API

/cemli/v1/customers/{supportIdentifier}/{serviceType}/products/patch/instances/{instanceId}/executions/{executionId}

Scope and AuthZ

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

/cemli/v1/

Dependency

Functionality

  • This API allows you to get details for a CEMLI patch execution.
  • Response fields that require an explanation:
    • selfService is the type of patch execution. The supported value is CEMLI_PATCH.
    • autoSkip value decides whether the execution must continue with the subsequent patches if failures occur while applying any of the selected patches.
    • autoStop value decides whether the execution must stop if failures occur while applying any of the selected patches.
    • nonProdRfc is the corresponding NonProduction ticket for which the patch execution was done with the same patch list.
    • duration is the time needed for applying the patch
    • bounceOptions specifies the components that need to be bounced if required. Applicable bounce options can be fetched using Get Bounce Options for an Instance.
    • primaryContact is the contact to be used while creating the ticket. This parameter must be the valid contact for 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 Instance name or target name on which the patches have to be applied Yes
executionId Path parameter Unique execution ID for the patch execution Yes

Sample response

{
  "autoSkip": true,
  "autoStop": false,
  "bounceOptions": {
    "hosts": [
      {
        "name": "adc42setest043.oracleoutsourcing.com",
        "options": [
          {
            "label": "Apache",
            "name": "APACHE",
            "value": true
          },
          {
            "label": "Concurrent Manager",
            "name": "CONCURRENT_MANAGER",
            "value": false
          }
        ],
        "tier": "MT"
      }
    ],
    "options": [
      {
        "label": "Managed Server",
        "name": "managed_servers",
        "value": false
      },
      {
        "label": "Clear Apache Cache",
        "name": "bounceAddOnCACHE",
        "value": true
      }
    ],
    "specialInstructionsExist": false
  },
  "createdBy": "<email ID>",
  "createdOn": "2021-12-21T14:34:39Z",
  "duration": {
    "unit": "Hours",
    "value": 2
  },
  "hotBackup": false,
  "id": "3-CDNJILA",
  "patchListOption": "10000001923-CEMLI#US",
  "patchNumbers": [
    "10000001923"
  ],
  "patchStaged": false,
  "scheduledBy": "<user's email ID>",
  "scheduledEnd": "2021-12-21T17:04:43Z",
  "scheduledStart": "2021-12-21T15:04:43Z",
  "summary": "Apply 1 cemli patches; Auto RFC - AutoSkip",
  "target": "TCMATI",
  "ticketingDetails": {
    "customerNote": "Action Plan",
    "customerStatus": "Review Update",
    "primaryContact": "<primary contact's email ID>",
    "rfcNumber": "3-CDNJILA",
    "rfcSubType": "CEMLI_PATCH",
    "rfcType": "OCIEBS_CEMLI_PATCH",
    "status": "Open",
    "subStatus": "Ready For Execution"
  },
  "updatedBy": "<user's email ID>",
  "updatedOn": "2021-12-21T14:34:44Z"
}