Oracle Cloud Infrastructureドキュメント

ワークフロー・ステータスAPI仕様

ワークフロー・ステータスAPIを使用して、実行ステータスの情報を取得します。このAPIを使用して、実行の親ステータスまたは実行の詳細ステータスを取得できます。

次のリソースがサポートされています:

ワークフロー・ステータスの取得

このAPIを使用して、実行のワークフロー・ステータスを取得します。

API

/selfservice/v1/executions/status

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客が作成した実行についてのみ実行ステータスを取得できます。
  • 顧客がオプトインしたセルフサービス機能についてのみ実行ステータスを取得できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/selfservice/v1/

機能

  • このAPIは、実行のワークフロー・ステータスを公開します。
  • executionIdは実行IDです。
  • statusは、指定された実行の親ステータスです。

動詞

GET

パラメータ

名前 タイプ 説明 必須
id 問合せパラメータ

実行ID。

  • CEMLI、BOUNCE、およびCONFIGの場合は、RFC番号を使用します。

  • VMの起動/停止、Exadataおよびヘルス・チェックの場合は、実行IDを使用します。

ノート:

複数のIDを次の形式で渡すことができます:

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

 少なくとも1つのIDを渡す必要があります。
requestor 問合せパラメータ

APIをコールしている機能名。たとえば、Exadataのスケール・アップまたはスケール・ダウン機能の場合はEXADATA_CPU_SCALEです。

リクエスタの値は次のとおりです:
機能 リクエスタ
Cemli CEMLI
バウンス BOUNCE
構成 CONFIG
VMの起動/停止 BOUNCE_VM
Exadataのスケール・アップまたはスケール・ダウン EXADATA_CPU_SCALE
インスタンス・ヘルス・チェック INSTANCE_HEALTHCHECK
はい

サンプル・レスポンス

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

ワークフロー・ステータス詳細の取得

このAPIを使用して、ワークフロー・ステータス詳細を取得します。

API

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

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客が作成した実行についてのみ実行詳細ステータスを取得できます。
  • 顧客がオプトインしたセルフサービス機能についてのみ実行ステータスを取得できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/selfservice/v1/

機能

  • このAPIは、実行のワークフロー・ステータス詳細を公開します。
  • executionIdは実行IDです。
  • stepIdは現在のステップIDで、指定されたステップの子ステップを識別するために使用されます。渡されない場合、ステップはルート・ステップとして処理されます。
  • subSteps.stepIdはサブステップのステップIDで、指定したステップの子ステップを識別するために後続のAPIコールで使用されます。
  • subSteps.endTimeは、特定のマイルストンが完了した時間です。
  • subSteps.hasSubStepは、指定されたsubStepに子ステップがあるかどうかを示します
  • subSteps.nameはマイルストン名です。
  • subSteps.statusは、RFCの指定マイルストンのステータスです。
  • subSteps.remarkは、指定されたマイルストンのログです。

動詞

GET

パラメータ

名前 タイプ 説明 必須
id 問合せパラメータ

実行ID。

  • CEMLI、BOUNCE、およびCONFIGの場合は、RFC番号を使用します。

  • VMの起動/停止、Exadataおよびヘルス・チェックの場合は、実行IDを使用します。

 はい
stepId 問合せパラメータ このパラメータは、現在のステップIDを示します。このパラメータは、特定のステップの子ステップを識別するために使用されます。渡されない場合、ステップはルート・ステップとして処理されます。

いいえ

デフォルトは0です
requestor 問合せパラメータ

APIをコールしている機能名。たとえば、Exadataのスケール・アップまたはスケール・ダウン機能の場合はEXADATA_CPU_SCALEです。

リクエスタの値は次のとおりです:
機能 リクエスタ
Cemli CEMLI
バウンス BOUNCE
構成 CONFIG
VMの起動/停止 BOUNCE_VM
Exadataのスケール・アップまたはスケール・ダウン EXADATA_CPU_SCALE
インスタンス・ヘルス・チェック INSTANCE_HEALTHCHECK
はい

サンプル・レスポンス

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