Oracle Cloud Infrastructure Documentation

Cancel Execution

Use this API to cancel the schedule for a configuration execution.

API

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

Scope and AuthZ

  • You must have mcs:oci:api:Approver scope to access this API.
  • You can cancel the execution schedule only for your customer instances.
  • You can use Configuration execution API only if your customer has opted-in for Configuration functionality.

Headers

  • Authorization: Bearer <Token>

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

Base Path

/selfservice/v1/

Dependency

Functionality

This API allows you to cancel the schedule for a configuration execution.

Verb

PUT

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 patches have to be applied. Yes
executionId Path parameter Unique execution ID for the patch execution. Yes

Sample request 

{
  "action": "cancel"
}

Sample response (single activity)

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ",
  "status": "Open",
  "subStatus": "Ready For Scheduling/Approval",
  "custStatus": "Review Update",
  "config": {
    "type": "Trace & Debug",
    "activity": {
      "name": "FRD Enable/Disable",
      "type": "Enable"
    }
  }
}

Sample response (Toggle activity)

{
  "id": "3-7JZXAMZ",
  "rfcNumber": "3-7JZXAMZ",
  "status": "Open",
  "subStatus": "Ready For Scheduling/Approval",
  "custStatus": "Review Update",
  "config": {
    "type": "Trace & Debug",
    "activity": {
      "name": "FRD Enable/Disable",
      "type": "Enable"
    }
  },
  "downStreamExecutions": [
    {
      "id": "3-7JZXAMB",
      "rfcNumber": "3-7JZXAMB",
      "status": "Open",
      "subStatus": "Ready For Scheduling/Approval",
      "custStatus": "Review Update",
      "config": {
        "type": "Trace & Debug",
        "activity": {
          "name": "FRD Enable/Disable",
          "type": "Disable"
        }
      }
    }
  ]
}