D.2. タスク管理

タスク情報オブジェクトは、非同期に実行されたタスクに関する情報を報告するために使用されます。

Task Report の例:

{
 "_href": "/pulp/api/v2/tasks/0fe4fcab-a040-11e1-a71c-00508d977dff/",
 "state": "running",
 "worker_name": "reserved_resource_worker-0@your.domain.com",
 "task_id": "0fe4fcab-a040-11e1-a71c-00508d977dff",
 "task_type": "pulp.server.tasks.repository.sync_with_auto_publish",
 "progress_report": {}, # contents depend on the operation
 "result": null,
 "start_time": "2012-05-17T16:48:00Z",
 "finish_time": null,
 "exception": null,
 "traceback": null,
 "tags": [
   "pulp:repository:f16",
   "pulp:action:sync"
 ],
 "spawned_tasks": [{"href": "/pulp/api/v2/tasks/7744e2df-39b9-46f0-bb10-feffa2f7014b/",
                    "task_id": "7744e2df-39b9-46f0-bb10-feffa2f7014b" }],
 "error": null
}

進行中のタスクをポーリングし、実行する非同期呼び出しの情報を生成します。ポーリングが Task Report を返す

方法: GET

Path: /pulp/api/v2/tasks/<task_id>/

パーティション: read

戻り値: クエリーされたタスクを表す Task Report

一部の非同期タスクは、完了する前にキャンセルできます。キャンセルするには、タスクが待機状態または実行状態である必要があります。

方法: DELETE

Path: /pulp/api/v2/tasks/<task_id>/

パーティション: delete

戻り値: null

現在実行しているタスクと待機中のタスクがすべて表示されます。これは、Task Report インスタンスの配列を返します。配列はタグでフィルター設定できます。

方法: GET

パス: /pulp/api/v2/tasks/

パーティション: read

戻り値: Task Report の配列

状態が終了、エラー、スキップされたすべての完了したタスクを削除できます。この呼び出しは、成功した場合は応答コード 204 を返し、要求が禁止されている場合はコード 403 を返します。

方法: DELETE

パス: /pulp/api/v2/tasks/

以下に例を示します。

/pulp/api/v2/tasks/?state=finished&state=skipped

戻り値: http 応答またはパルプ例外

API 呼び出し元はタスクを検索することもできます。これは、search criteria document を使用します。

方法: POST

パス: /pulp/api/v2/tasks/search/

パーティション: read

リクエスト本文の内容: キー criteria を含めます。その値は、検索基準 で定義されたマッピング構造です。

戻り値: 戻り値のベースがリストであることを除いて、単一のタスクを取得するのと同じ形式。結果が見つからない場合は、空のリストが返されます。

方法: GET

パス: /pulp/api/v2/tasks/search/

パーティション: read

クエリーパラメーター: クエリーパラメーターは、Search Criteria で定義されている基準オブジェクトの属性と一致する必要があります。例外として、フィールド名は必要な数の field=foo ペアを持つ単数形で指定する必要があります。

以下に例を示します。

/pulp/api/v2/tasks/search/?field=id&field=task_type&limit=20