Oracle Cloud Infrastructure Documentation

Bounce Metadata API Specifications

Use the Bounce Metadata API to provide all the prerequisite dependency information required to submit a bounce request like Start/Stop/Bounce. This information includes bounce operations, services, duration, and ticket queue details. It also provides information about environment instance options.

The following resources are supported:

Get Allowed Bounce Operations

Use this API to get allowed bounce operations.

API

/selfservice/v1/customers/services/products/bounce/operations

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can use Bounce Metadata 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/

Functionality

  • This API exposes a list of allowed bounce operations.
  • name value is the key.
  • label is a description which is used for displays.

Verb

GET

Sample response

[
  {
    "name": "Bounce",
    "label": "Bounce"
  },
  {
    "name": "Start",
    "label": "Start"
  },
  {
    "name": "Stop",
    "label": "Stop"
  }
]

Get List of Applicable Bounce Services

Use this API to get a list of default services on the environment affected during the bounce operation.

API

/selfservice/v1/customers/services/products/bounce/services

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can use Bounce Metadata 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/

Functionality

  • This API exposes a list of applicable bounce services.
  • name value is the key.
  • label is a description which is used for displays.

Verb

GET

Sample response

[
  {
    "name": "All",
    "label": "All (Apps and DB)"
  },
  {
    "name": "Apps",
    "label": "All Apps"
  },
  {
    "name": "Components",
    "label": "Apps Components"
  }
]

Get Instance Options

Use this API to get instance options.

API

/selfservice/v1/customers/{custId}/products/bounce/instances/{instanceName}/services

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access this information only for instances that belong to your customer.
  • You can use Bounce Metadata 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 exposes a list of services affected during bounce for a specific customer instance.
  • name value is the key.
  • label is a description which is used for displays.
  • {custId} and {instanceName} can be retrieved from the dependency mentioned.

Verb

GET

Parameters

Name Type Description Mandatory
custId Path parameter Customer identifier Yes
instanceName Path parameter Instance name Yes

Sample response

[
  {
    "name": "All",
    "label": "All (Apps and DB)"
  },
  {
    "name": "Apps",
    "label": "All Apps"
  },
  {
    "name": "Components",
    "label": "Apps Components"
  },
  {
    "name": "AllwithVM",
    "label": "All (Apps & DB) with VM"
  },
  {
    "name": "AppswithVM",
    "label": "All Apps with VM"
  }
]

Get Queue Information

Use this API to get queue information for bounce tickets.

API

/selfservice/v1/customers/services/{serviceType}/products/bounce/instances/{instanceName}/ticket/queue

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can access this information only for instances that belong to your customer.
  • You can use Bounce Metadata 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 gets queue information for bounce tickets.

To be used as a prerequisite for ticket creation.

{serviceType} and {instanceName} can be retrieved from the dependency mentioned.

Verb

GET

Parameters

Name Type Description Mandatory
serviceType Path parameter Service type Yes
instanceName Path parameter Instance name Yes
services Query parameter

Services options [All,Apps, Components, AllwithVM, AppswithVM]

 No

Sample response

{
    "category": "Application - EBS OCI",
    "serviceCode": "EBSI",
    "subType": "SelfService_Bounce",
    "type": "OCIEBS_Prod_SelfService"
}

Get Allowed Durations

Use this API to get allowed durations for bounce tickets.

API

/selfservice/v1/customers/services/products/bounce/durations

Scope and AuthZ

  • You must have mcs:oci:api:User scope to access this API.
  • You can use Bounce Metadata 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/

Functionality

  • This API exposes list of allowed bounce operations.
  • displayValue is the value used for display purposes.
  • value is the value considered for processing.

Verb

GET

Sample response

[
  {
    "displayValue": "2 hours",
    "value": "PT2H"
  },
  {
    "displayValue": "2 hours 30 minutes",
    "value": "PT2H30M"
  },
  {
    "displayValue": "3 hours",
    "value": "PT3H"
  },
  {
    "displayValue": "4 hours",
    "value": "PT4H"
  },
  ...
]