Oracle Cloud Infrastructure-Dokumentation

Workflowstatus-API - Spezifikationen

Mit der Workflowstatus-API können Sie Informationen zum Ausführungsstatus abrufen. Mit dieser API können Sie den übergeordneten Ausführungsstatus oder den detaillierten Status einer Ausführung abrufen.

Die folgenden Ressourcen werden unterstützt:

Workflowstatus abrufen

Mit dieser API können Sie den Workflowstatus der Ausführung abrufen.

API

/selfservice/v1/executions/status

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können den Ausführungsstatus nur für Ausführungen abrufen, die von Ihrem Kunden erstellt wurden.
  • Sie können den Ausführungsstatus nur für die Selfservice-Funktionalität abrufen, für die sich der Kunde 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/

Funktionalität

  • Diese API zeigt den Workflowstatus von Ausführungen an.
  • executionId ist die Ausführungs-ID.
  • status ist der übergeordnete Status der angegebenen Ausführung.

Verb

GET

Parameter

Name Typ Beschreibung Obligatorisch
id Abfrageparameter

Ausführungs-ID.

  • Verwenden Sie für CEMLI, BOUNCE und CONFIG die RFC-Nummer.

  • Verwenden Sie für VM-Start/-Stopp, Exadata und Health Check die Ausführungs-ID.

Hinweis:

Mehrere IDs können im folgenden Format übergeben:

/selfservice/v1/executions/status ?id=<id1>&id=<id2>&...

Mindestens eine ID muss übergeben werden.
requestor Abfrageparameter

Funktionsname, der die API aufruft. Beispiel: EXADATA_CPU_SCALE für die vertikale oder horizontale Skalierungsfunktion von Exadata.

Die Requestor-Werte lauten:
Funktionalität Requestor
Cemli CEMLI
Bounce BOUNCE
Konfiguration CONFIG
VM-Start/-Stopp BOUNCE_VM
Exadata vertikal oder horizontal skalieren EXADATA_CPU_SCALE
Health Check der Instanz INSTANCE_HEALTHCHECK
Ja

Beispielantwort

{
"response": [
    {
        "executionId": "3-BLFVC0W",
        "status": "success"
    },
    {
        "executionId": "3-XTFVC0W",
        "status": "success"
    }
  ]
}

Details des Workflowstatus abrufen

Mit dieser API können Sie Details des Workflowstatus abrufen.

API

/selfservice/v1/executions/{id}/status/details

Geltungsbereich und AuthZ

  • Sie benötigen den Geltungsbereich mcs:oci:api:User, um auf diese API zugreifen zu können.
  • Sie können Ausführungsstatusdetails nur für Ausführungen abrufen, die von Ihrem Kunden erstellt wurden.
  • Sie können den Ausführungsstatus nur für die Selfservice-Funktionalität abrufen, für die sich der Kunde 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/

Funktionalität

  • Diese API zeigt Details des Workflowstatus von Ausführungen an.
  • executionId ist die Ausführungs-ID.
  • stepId ist die aktuelle Schritt-ID und wird verwendet, um untergeordnete Schritte für den angegebenen Schritt zu identifizieren. Andernfalls wird der Schritt als Root-Schritt behandelt.
  • subSteps.stepId ist eine Schritt-ID für einen Unterschritt und wird in nachfolgenden API-Aufrufen verwendet, um untergeordnete Schritte für den angegebenen Schritt zu identifizieren.
  • subSteps.endTime ist der Zeitpunkt, zu dem der angegebene Meilenstein abgeschlossen ist.
  • subSteps.hasSubStep gibt an, ob der angegebene subStep untergeordnete Schritte aufweist
  • subSteps.name ist der Meilensteinname.
  • subSteps.status ist der Status für den angegebenen Meilenstein für RFC.
  • subSteps.remark ist das Log für den angegebenen Meilenstein.

Verb

GET

Parameter

Name Typ Beschreibung Obligatorisch
id Abfrageparameter

Ausführungs-ID.

  • Verwenden Sie für CEMLI, BOUNCE und CONFIG die RFC-Nummer.

  • Verwenden Sie für VM-Start/-Stopp, Exadata und Health Check die Ausführungs-ID.

 Ja
stepId Abfrageparameter Dieser Parameter gibt die aktuelle Schritt-ID an. Mit diesem Parameter werden untergeordnete Schritte für einen bestimmten Schritt identifiziert. Andernfalls wird der Schritt als Root-Schritt behandelt.

Nein

Der Standardwert ist 0
requestor Abfrageparameter

Funktionsname, der die API aufruft. Beispiel: EXADATA_CPU_SCALE für die vertikale oder horizontale Skalierungsfunktion von Exadata.

Die Requestor-Werte lauten:
Funktionalität Requestor
Cemli CEMLI
Bounce BOUNCE
Konfiguration CONFIG
VM-Start/-Stopp BOUNCE_VM
Exadata vertikal oder horizontal skalieren EXADATA_CPU_SCALE
Health Check der Instanz INSTANCE_HEALTHCHECK
Ja

Beispielantwort

{
    "executionId": "3-7JZXAGH",
    "stepId": 0,
    "subSteps": [
        {
            "endTime": "2021-04-21T01:56:24Z",
            "hasSubStep": true,
            "name": "RFC Submission",
            "startTime": "2021-04-21T01:52:24Z",
            "status": "Completed",
            "stepId": 159,
            "remark": "RFC successfully submitted to workflow engine"
        },
        {
            "endTime": "2021-04-21T01:59:24Z",
            "hasSubStep": false,
            "name": "RFC Execution",
            "startTime": "2021-04-21T01:52:24Z",
            "status": "Queued",
            "stepId": 236,
            "remark": "RFC successfully executed"
        }
    ]
}