タスク実行の停止
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
先にタスクの起動APIを呼び出して、taskUuidを取得する必要があります。
説明:タスクの実行ステータスが最終状態になっている場合、このAPIを呼び出しても効果はありません。
テンプレート
postManテンプレート
apiタスク実行の停止.json(右クリックして「名前を付けて保存」)
Javaテンプレート
リクエストモデル:StopTaskReq.java(右クリックして「名前を付けて保存」)
レスポンスモデル:なし
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/task/stop | 専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください。 |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数は、認証APIから返されたaccess Tokenに置き換える必要があります。 |
| Content-Type | application/json |
リクエストボディ
| 名称 | タイプ | 説明 | 必須かどうか | 説明 |
|---|---|---|---|---|
| taskUuid | string | タスク実行のuuid | はい | なし |
リクエスト例
{
"taskUuid": "45c882ed-e44f-4818-afc0-05172e7ff111"
}
レスポンス
レスポンスボディ
| 名称 | タイプ | 必須かどうか | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を示します。ステータスコードの説明を参照してください。 |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドに基づいて、APIの呼び出しが成功したかどうかを判断できます。 |
| msg | string | はい | ステータスコードの説明です。 |
レスポンスボディの例
{
"code": 200,
"success": true
}
エラーが発生した場合は、ステータスコードの説明に移動してください。