Ausführungsdetails abrufen

Mit dieser API können Sie Details zu einer Bounce-Ausführung abrufen.

API

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

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können Bounce-Ausführungsdetails nur für Ihren Kunden abrufen.
  • Sie können die Bounce-API nur verwenden, wenn der Kunde sich für die Bounce-Funktionalität angemeldet hat.

Header

  • Autorisierung: Bearer <Token>

    Dabei ist <Token> das OAUTH-Token, das vom Autorisierungsserver zurückgegeben wird (JWT-Token).

  • ID: <JWKS Identifier>

    Dabei ist <JWKS Identifier> die GUID, die generiert wird, wenn die JWKS-URI vom Kundenadministrator in der Selfserviceplattform festgelegt wird.

Basispfad

/selfservice/v1/

Abhängigkeit

Funktionalität

  • Mit dieser API können Sie Details zu einer Bounce-Ausführung abrufen.
  • Antwortfelder, für die eine Erläuterung erforderlich ist:
    • operation ist ein Vorgang wie "start", "stop" oder "bounce".
    • services kann "All", "Apps", "Components", "AllwithVM" oder "AppswithVM" sein.
    • blackOutDuration ist die Blackoutdauer, die in einem Stoppvorgang festgelegt werden soll.
    • duration ist die Zeit, die für das Einspielen des Patches erforderlich ist.
    • bounceOptions gibt die Komponenten an, die neu gestartet werden müssen. Anwendbare Bounce-Optionen können mit der API zum Abrufen von Bounce-Optionen für eine Instanz abgerufen werden.
    • primaryContact ist der Kontakt, der beim Erstellen des Tickets verwendet werden soll. Dieser Parameter muss ein gültiger Kontakt für die CSI-(Customer Support Identifier-)Nummer sein.

Verb

GET

Parameter

Name Typ Beschreibung Obligatorisch
supportIdentifier Pfadparameter CSI-Nummer Ja
serviceType Pfadparameter Servicetyp (z.B. EBSO, EBSZ oder EBSI) Ja
instanceId Pfadparameter Name des Ziels oder der Instanz, auf dem oder der Patches eingespielt werden müssen Ja
executionId Pfadparameter Eindeutige Ausführungs-ID für die Patchausführung Ja

Beispielantwort

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