タスク情報の取得

2024年1月10日

ID 199646

タスクに関する情報を識別子で取得します。

メソッド:

GET /api/2.0/virtualization/tasks/{ID}

各パラメータの説明:

{ID} - タスクの識別子(必須パラメータ)。

このリクエストが正常に完了すると、REST API はタスクに関する次の情報を返します:

<task id="{ID}" created="{日時}" stateChanged="{日時}" changed="{日時}">

<state>{ステータス}</state>

<type>{種別}</type>

<stage>{ステージ}</stage>

<progress>{実行の進捗}</progress>

<result>{結果}</result>

<!-- タスクの実行が失敗した場合、エラーメッセージが結果の代わりに表示されます。

<error>{エラーメッセージ}</error>

</task>

各パラメータの説明:

  • {ID} – タスク ID。
  • created="{日時}" - タスクの作成日時。形式:YYYY-MM-DDThh:mm:ss。
  • stateChanged="{日時}" – タスクの変更日時。形式:YYYY-MM-DDThh:mm:ss。
  • changed="{日時}" - タスクの変更日時。形式:YYYY-MM-DDThh:mm:ss。
  • {ステータス} - タスクのステータス
  • {種別} - タスクの種別。例:
  • {名前} - タスク名。
  • {ステージ} - タスク実行のステージ。
  • {実行の進捗} – タスクの進捗状況をパーセンテージで示します。
  • {結果} - タスクの実行結果。例:作成したテナントの情報またはレポートの識別子など。
  • {エラーメッセージ} - タスクの実行中にエラーが発生すると、エラーメッセージが表示されます。

リターンコード:

  • 200 (OK) – リクエストが正常に完了しました。
  • 403 (Forbidden) – リソースへのアクセスが拒否されました。
  • 404 (Not Found) – Integration Server データベース内に、指定した識別子のタスクが見つかりません。

この記事はお役に立ちましたか?
改善できる点がありましたらお聞かせください。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。
フィードバックをいただき、ありがとうございました。改善に向けて取り組んでまいります。