移動

• リクエスト
• レスポンス

リクエスト実行のステータスの設定

post

ess/rest/scheduler/v1/requests/{requestId}/executionStatus

リクエスト実行のステータスを設定します。これは、ジョブ・リクエストから起動して、実行の結果をスケジューラに通知することを目的としています。スケジューラでは、リクエスト状態の遷移を進める方法を示すインジケータとして使用されます。

リクエスト

パス・パラメータ

• requestId(required): integer(int64)
  ジョブ・リクエストID

サポートされるメディア・タイプ

• application/json
• application/vnd.oracle.resource+json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

ソースの表示

• requestHandle: string
  実行中のリクエストに関連付けられたリクエスト・ハンドルは、リクエストの実行中のインスタンスに対する不透明な識別子を表します。
• status: string
  指定できる値: [ "SUCCESS", "UPDATE", "PAUSE", "WARNING", "ERROR", "BUSINESS_ERROR", "CANCEL", "SUSPEND" ]

  非同期ジョブのコールバック・ステータス。非同期ステータスを戻しても、リクエストの状態が対応する値に変更されることは保証されません。リクエストの新しい状態は、古い状態、非同期ステータス、および後続の処理で発生する可能性のあるエラーによって異なります。SUCCESS -- ジョブは正常に実行されました。UPDATE -- 非同期ジョブが更新されました。PAUSE -- サブリクエストの実行のためにジョブが一時停止しました。WARNING -- ジョブは警告を発行しています。ERROR -- ジョブの実行中に再試行可能なエラーが発生しました。CANCEL -- ジョブは実行を取り消しました。通常、これはスケジューラAPIを使用してジョブを取り消すことによって生じます。SUSPEND -- ジョブがそれ自体を一時停止しました。BUSINESS_ERROR -- ジョブの実行中に再試行不可能なエラーが発生しました
• statusMessage: string
  ステータスがERRORまたはBUSINESS_ERRORの場合はエラー・メッセージ、ステータスがWARNINGの場合は警告メッセージ、ステータスがPAUSEDの場合は一時停止状態。ステータスがSUCCESSまたはCANCELの場合、値は無視されます。

{
    "type":"object",
    "properties":{
        "requestHandle":{
            "type":"string",
            "description":"The request handle associated with the executing request represents an opaque identifer for the executing instance of the request."
        },
        "status":{
            "type":"string",
            "description":"Callback status of an asynchronous job. Returning an asynchronous status does not guarantee\nthat the state of the request will change to the corresponding value. The new state of the request\nwill depend on the old state, the async status, and any errors that may occur in subsequent processing.\n\nSUCCESS         -- the job ran successfully\n\nUPDATE          -- the asynchronous job is updated\n\nPAUSE           -- the job has paused for the execution of sub-requests\n\nWARNING         -- the job is issuing a warning\n\nERROR           -- the job encountered a retryable error\n\nCANCEL          -- The job has cancelled its execution. Usually this originates from cancelling the job using the scheduler APIs\n\nSUSPEND         -- the job has suspended itself\n\nBUSINESS_ERROR  -- the job encountered a non-retryable error\n",
            "enum":[
                "SUCCESS",
                "UPDATE",
                "PAUSE",
                "WARNING",
                "ERROR",
                "BUSINESS_ERROR",
                "CANCEL",
                "SUSPEND"
            ]
        },
        "statusMessage":{
            "type":"string",
            "description":"An error message if the status is ERROR or BUSINESS_ERROR, a warning message if the status\nis WARNING, the paused state if the status is PAUSED. The value will be ignored if the\nstatus is SUCCESS or CANCEL.\n"
        }
    }
}

リクエスト本文 - application/vnd.oracle.resource+json ()

ルート・スキーマ: schema

型: object

ソースの表示

• requestHandle: string
  実行中のリクエストに関連付けられたリクエスト・ハンドルは、リクエストの実行中のインスタンスに対する不透明な識別子を表します。
• status: string
  指定できる値: [ "SUCCESS", "UPDATE", "PAUSE", "WARNING", "ERROR", "BUSINESS_ERROR", "CANCEL", "SUSPEND" ]

  非同期ジョブのコールバック・ステータス。非同期ステータスを戻しても、リクエストの状態が対応する値に変更されることは保証されません。リクエストの新しい状態は、古い状態、非同期ステータス、および後続の処理で発生する可能性のあるエラーによって異なります。SUCCESS -- ジョブは正常に実行されました。UPDATE -- 非同期ジョブが更新されました。PAUSE -- サブリクエストの実行のためにジョブが一時停止しました。WARNING -- ジョブは警告を発行しています。ERROR -- ジョブの実行中に再試行可能なエラーが発生しました。CANCEL -- ジョブは実行を取り消しました。通常、これはスケジューラAPIを使用してジョブを取り消すことによって生じます。SUSPEND -- ジョブがそれ自体を一時停止しました。BUSINESS_ERROR -- ジョブの実行中に再試行不可能なエラーが発生しました
• statusMessage: string
  ステータスがERRORまたはBUSINESS_ERRORの場合はエラー・メッセージ、ステータスがWARNINGの場合は警告メッセージ、ステータスがPAUSEDの場合は一時停止状態。ステータスがSUCCESSまたはCANCELの場合、値は無視されます。

{
    "type":"object",
    "properties":{
        "requestHandle":{
            "type":"string",
            "description":"The request handle associated with the executing request represents an opaque identifer for the executing instance of the request."
        },
        "status":{
            "type":"string",
            "description":"Callback status of an asynchronous job. Returning an asynchronous status does not guarantee\nthat the state of the request will change to the corresponding value. The new state of the request\nwill depend on the old state, the async status, and any errors that may occur in subsequent processing.\n\nSUCCESS         -- the job ran successfully\n\nUPDATE          -- the asynchronous job is updated\n\nPAUSE           -- the job has paused for the execution of sub-requests\n\nWARNING         -- the job is issuing a warning\n\nERROR           -- the job encountered a retryable error\n\nCANCEL          -- The job has cancelled its execution. Usually this originates from cancelling the job using the scheduler APIs\n\nSUSPEND         -- the job has suspended itself\n\nBUSINESS_ERROR  -- the job encountered a non-retryable error\n",
            "enum":[
                "SUCCESS",
                "UPDATE",
                "PAUSE",
                "WARNING",
                "ERROR",
                "BUSINESS_ERROR",
                "CANCEL",
                "SUSPEND"
            ]
        },
        "statusMessage":{
            "type":"string",
            "description":"An error message if the status is ERROR or BUSINESS_ERROR, a warning message if the status\nis WARNING, the paused state if the status is PAUSED. The value will be ignored if the\nstatus is SUCCESS or CANCEL.\n"
        }
    }
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json
• application/vnd.oracle.resource+json

200レスポンス

OK

本文()

ルート・スキーマ: Links

型: array

ソースの表示

• 配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

ネストされたスキーマ: Link

型: object

ソースの表示

• href(required): string
• rel(required): string
  指定できる値: [ "self", "cancel", "forceCancel", "hold", "release", "subscribe", "permissions", "executionStatus" ]

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "enum":[
                "self",
                "cancel",
                "forceCancel",
                "hold",
                "release",
                "subscribe",
                "permissions",
                "executionStatus"
            ]
        },
        "href":{
            "type":"string"
        }
    }
}

400レスポンス

入力が無効です

本文()

ルート・スキーマ: SimpleExceptionDetail

型: object

ソースの表示

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。たとえば、ESS-00500などです。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI。チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

403レスポンス

この操作では許可されません

本文()

ルート・スキーマ: SimpleExceptionDetail

型: object

ソースの表示

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。たとえば、ESS-00500などです。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI。チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

404レスポンス

リクエストIDが見つかりません

本文()

ルート・スキーマ: SimpleExceptionDetail

型: object

ソースの表示

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。たとえば、ESS-00500などです。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI。チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

500レスポンス

スケジューリング・サブシステム・エラーが発生しました。

本文()

ルート・スキーマ: SimpleExceptionDetail

型: object

ソースの表示

• detail: string
  詳細エラー・メッセージ
• errorCode: string
  ESS固有のエラー・コード。たとえば、ESS-00500などです。
• status: integer
  HTTPステータス・コード
• title(required): string
  要約エラー・メッセージ
• type(required): string
  URI。チームがアプリケーション固有の問題タイプを提供できる場合に役立ちます。そうでない場合は、少なくともHTTPエラー・コード・ページにリンクする必要があります。

{
    "required":[
        "title",
        "type"
    ],
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"URI. It will be beneficial if teams can provide application specific problem types. If not, at least we should link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"summary error message"
        },
        "status":{
            "type":"integer",
            "description":"HTTP status code"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "errorCode":{
            "type":"string",
            "description":"ESS-specific error code. For example ESS-00500."
        }
    }
}

先頭に戻る