Bounce Execution API Specifications

Use the Bounce Execution API to create, schedule, retrieve, list Bounce Executions for all applicable instances (for the Bounce enabled Support Identifiers). It also provides the functionality to check for execution conflicts and bounce options.

The following resources are supported:

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"
}

Schedule Execution

Use this API to schedule or reschedule a bounce execution.

API

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

Scope and AuthZ

You must have mcs:oci:api:Approver scope to access this API.
You can schedule 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.

Base Path

/selfservice/v1/

Dependency

Functionality

This API allows you to schedule or reschedule a Bounce Execution for a customer instance.

Request field that requires explanation:
- scheduledTime is the time in UTC when the execution has to be scheduled. ScheduleTime must be at least 16 minutes from the current time.

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	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 request

{
  "scheduledTime": "2020-08-26T8:53:51-07:00",
  "action": "schedule"
}

Sample response (success)

{
  "scheduledStart": "2020-08-26T8:53:51-07:00",
  "scheduledEnd": "2020-08-26T10:53:51-07:00",
  "status": "Open",
  "subStatus": "Ready For Execution",
  "custStatus": "Review Update"
}

Sample response (conflicts)

{
  "conflicts": [
    {
      "rfcNumber": "3-7JZXAMZ",
      "rfcType": "CODE_PROMO",
      "rfcSubType": "CEMLI_PATCH",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "scheduledStart": "2020-08-26T8:53:51-07:00",
      "scheduledEnd": "2020-08-26T10:53:51-07:00",
      "duration": {
        "unit": "hours",
        "value": 2
      }
    },
    {
      "rfcNumber": "3-7JZXAGH",
      "rfcType": "OCIEBS_Prod_SelfService",
      "rfcSubType": "SelfService_Bounce",
      "status": "Open",
      "subStatus": "Ready For Execution",
      "scheduledStart": "2020-08-26T8:53:51-07:00",
      "scheduledEnd": "2020-08-26T10:53:51-07:00",
      "duration": {
        "unit": "hours",
        "value": 3
      }
    },
    {
      "rfcNumber": "3-6JZXAMH",
      "rfcType": "Configuration - EBSO",
      "rfcSubType": "Autoexec-Config",
      "status": "Open",
      "subStatus": "Ready For Scheduling/Approval",
      "scheduledStart": "2020-08-26T8:53:51-07:00",
      "scheduledEnd": "2020-08-26T10:53:51-07:00",
      "duration": {
        "unit": "hours",
        "value": 4
      }
    }
  ]
}

Cancel Schedule

Use this API to cancel the schedule 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:Approver scope to access this API.
You can cancel 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.

Base Path

/selfservice/v1/

Dependency

Functionality

This API allows you to cancel the schedule for a Bounce 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	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 request

{
  "action": "cancel"
}

Sample response (success)

{
  "status": "Open",
  "subStatus": "Ready For Scheduling/Approval",
  "custStatus": "Review Update"
}

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"
  }
}

List of Executions

Use this API to list bounce executions.

API

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

Scope and AuthZ

You must have mcs:oci:api:User scope to access this API.
You can get a list of 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 list bounce executions.

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
`target`	Query parameter	Target name or instance name	No
`status`	Query parameter		No
`subStatus`	Query parameter		No
`customerStatus`	Query parameter		No

Sample response (success)

[
  {
    "createdBy": "<email ID>",
    "createdOn": "2022-01-13T06:32:56Z",
    "id": "3-CDQF5Z0",
    "scheduledBy": "<email ID>",
    "scheduledEnd": "2022-01-14T05:00:00Z",
    "scheduledStart": "2022-01-14T03:00:00Z",
     "target": "OMCEBSOR3",
    "ticketingDetails": {
      "customerNote": "Action Plan",
      "customerStatus": "Review Update",
      "primaryContact": "<email ID>",
      "rfcNumber": "3-CDQF5Z0",
      "rfcSubType": "SelfService_Bounce",
      "rfcType": "OCIEBS_Prod_SelfService",
      "status": "Open",
      "subStatus": "Ready For Execution"
    }
  },
  {
    "createdBy": "<email ID>",
    "createdOn": "2022-01-12T08:40:03Z",
    "id": "3-CDQEVUP",
    "target": "TCMATI",
    "ticketingDetails": {
      "customerNote": "Action Plan",
      "customerStatus": "Acknowledged",
      "primaryContact": "<email ID>",
      "rfcNumber": "3-CDQEVUP",
      "rfcSubType": "ACE_DATAFIX",
      "rfcType": "OCIEBS_ACE_DATAFIX",
      "status": "Open",
      "subStatus": "Ready for Scheduling/Approval"
    }
  },
  {
    "createdBy": "<email ID>",
    "createdOn": "2021-12-21T14:34:39Z",
    "id": "3-CDNJILA",
    "scheduledBy": "<email ID>",
    "scheduledEnd": "2021-12-21T17:04:43Z",
    "scheduledStart": "2021-12-21T15:04:43Z",
    "target": "TCMATI",
    "ticketingDetails": {
      "customerNote": "Action Plan",
      "customerStatus": "Review Update",
      "primaryContact": "<email ID>",
      "rfcNumber": "3-CDNJILA",
      "rfcSubType": "CEMLI_PATCH",
      "rfcType": "OCIEBS_CEMLI_PATCH",
      "status": "Open",
      "subStatus": "Ready For Execution"
    }
  }
]

Get Execution Conflicts

Use this API to get execution conflicts.

API

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

Scope and AuthZ

You must have mcs:oci:api:Approver scope to access this API.
You can get conflict details for the executions that belong to your customer services and 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.

Base Path

/selfservice/v1/

Dependency

Functionality

This API allows you to get execution conflicts.

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	Yes
`scheduledStart`	Query parameter		No
`scheduledEnd`	Query parameter		No

Sample response

[
  {
    "rfcNumber": "3-7JZXAMZ",
    "rfcType": "CODE_PROMO",
    "rfcSubType": "CEMLI_PATCH",
    "status": "Open",
    "subStatus": "Ready For Execution",
    "scheduledStart": "2020-08-26T8:53:51-07:00",
    "scheduledEnd": "2020-08-26T10:53:51-07:00",
    "duration": {
      "unit": "hours",
      "value": 2
    }
  },
  {
    "rfcNumber": "3-7JZXAGH",
    "rfcType": "OCIEBS_Prod_SelfService",
    "rfcSubType": "SelfService_Bounce",
    "status": "Open",
    "subStatus": "Ready For Execution",
    "scheduledStart": "2020-08-26T8:53:51-07:00",
    "scheduledEnd": "2020-08-26T10:53:51-07:00",
    "duration": {
      "unit": "hours",
      "value": 3
    }
  },
  {
    "rfcNumber": "3-6JZXAMH",
    "rfcType": "Configuration - EBSO",
    "rfcSubType": "Autoexec-Config",
    "status": "Open",
    "subStatus": "Ready For Scheduling/Approval",
    "scheduledStart": "2020-08-26T8:53:51-07:00",
    "scheduledEnd": "2020-08-26T10:53:51-07:00",
    "duration": {
      "unit": "hours",
      "value": 4
    }
  }
]

Get Bounce Options for an Instance

Use this API to get bounce options for an instance.

API

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

Scope and AuthZ

You must have mcs:oci:api:User scope to access this API.
You can get bounce options for your customer services and instances only.
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 bounce options for an instance.

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	Yes

Sample response

{
  "hosts": [
    {
      "name": "adc42setest034.oracleoutsourcing.com",
      "options": [
        {
          "label": "OPMN services",
          "name": "OPMN",
          "value": false
        },
        {
          "label": "Apache",
          "name": "APACHE",
          "value": false
        },
        {
          "label": "Concurrent Manager",
          "name": "CONCURRENT_MANAGER",
          "value": false
        },
        {
          "label": "Workflow Mailer",
          "name": "WORKFLOW_MAILER",
          "value": false
        }
      ],
      "tier": "MT"
    },
    {
      "name": "adc42setest034.oracleoutsourcing.com",
      "options": [
        {
          "label": "Database",
          "name": "DATABASE",
          "value": false
        },
        {
          "label": "Database Listener",
          "name": "DB_LISTENER",
          "value": false
        }
      ],
      "tier": "DB"
    }
  ],
  "options": [
    {
      "label": "Clear Apache Cache",
      "name": "bounceAddOnCACHE",
      "value": false
    }
  ],
  "specialInstructionsExist": false
}

Oracle Cloud Infrastructure Documentation

Bounce Execution API Specifications

Create Execution

API

Scope and AuthZ

Headers

Dependency

Base Path

Functionality

Verb

Parameters

Sample request

Sample response

Schedule Execution

API

Scope and AuthZ

Headers

Base Path

Dependency

Functionality

Verb

Parameters

Sample request

Sample response (success)

Sample response (conflicts)

Cancel Schedule

API

Scope and AuthZ

Headers

Base Path

Dependency

Functionality

Verb

Parameters

Sample request

Sample response (success)

Get Execution Details

API

Scope and AuthZ

Headers

Base Path

Dependency

Functionality

Verb

Parameters

Sample response

List of Executions

API

Scope and AuthZ

Headers

Base Path

Dependency

Functionality

Verb

Parameters

Sample response (success)

Get Execution Conflicts

API

Scope and AuthZ

Headers

Base Path

Dependency

Functionality

Verb

Parameters

Sample response

Get Bounce Options for an Instance

API

Scope and AuthZ

Headers

Base Path

Dependency

Functionality

Verb

Parameters

Sample response