移動

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

ジョブ・リクエストの強制取消し操作の開始

post

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

CANCELステータスで非同期リクエストを完了します。前提条件が満たされた場合、リクエストはCANCELLED状態に遷移します。1.呼出し側は、リモートジョブが実行されていないことを確認する必要があります。2.リクエストは非同期レスポンスを待機しており、CANCELLING状態である必要があります。3.リクエストがCANCELLING状態になってから、またはジョブがこのリクエストに対して最後にチェックインされてから30分以上経過している必要があります。

リクエスト

パス・パラメータ

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

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

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

200レスポンス

操作が開始されました

本文()

ルート・スキーマ: 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."
        }
    }
}

409レスポンス

競合

本文()

ルート・スキーマ: 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."
        }
    }
}

先頭に戻る