システム・ジョブのリスト
get
/api/v2/system_jobs/
このリソースに対してGETリクエストを行って、システム・ジョブのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
countフィールドは、対象となる問合せで見つかったシステム・ジョブの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上のシステム・ジョブ・レコードが含まれます。
結果
それぞれのシステム・ジョブ・データ構造には次のフィールドが含まれます。
id: このシステム・ジョブのデータベースID。(整数)type: このシステム・ジョブのデータ型。(選択)url: このシステム・ジョブのURL。(文字列)related: 関連リソースのURLを含むデータ構造。(オブジェクト)summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created: このシステム・ジョブが作成されたときのタイムスタンプ。(日時)modified: このシステム・ジョブが最後に変更されたときのタイムスタンプ。(日時)name: このシステム・ジョブの名前。(文字列)description: このシステム・ジョブのオプションの説明。(文字列)unified_job_template: (id)launch_type: (選択)manual: 手動relaunch: 再起動callback: コールバックscheduled: スケジュール済dependency: 依存性workflow: ワークフローwebhook: Webフックsync: 同期scm: SCM更新
status: (選択)new: 新規pending: 保留中waiting: 待機中running: 実行中successful: 成功failed: 失敗error: エラーcanceled: 取消し済
execution_environment: 実行に使用されるコンテナ・イメージ。(id)failed: (ブール)started: ジョブが開始のためにキューに入れられた日時。(日時)finished: ジョブの実行が終了した日時。(日時)canceled_on: 取消しリクエストが送信された日時。(日時)elapsed: ジョブが実行された経過時間(秒)。(10進)job_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)execution_node: ジョブが実行されたノード。(文字列)launched_by: (フィールド)work_unit_id: このジョブに関連付けられた受信者作業ユニットID。(文字列)system_job_template: (id)job_type: (選択)"": ---------cleanup_jobs: 特定の日数より前のジョブを削除しますcleanup_activitystream: 特定の日数より前のアクティビティ・ストリーム・エントリを削除しますcleanup_sessions: 期限切れのブラウザ・セッションをデータベースから削除しますcleanup_tokens: 期限切れのOAuth 2アクセス・トークンおよびリフレッシュ・トークンを削除します
extra_vars: (文字列)result_stdout: (フィールド)
ソート
システム・ジョブが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。
?order_by=name
フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。
?order_by=-name
フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。
?order_by=name,some_other_field
ページ区切り
リクエストごとに返される結果の数を変更するには、page_size問合せ文字列パラメータを使用します。 特定のページの結果を取得するには、page問合せ文字列パラメータを使用します。
?page_size=100&page=2
結果で返されるpreviousリンクおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。
検索
モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search問合せ文字列パラメータを使用します。
?search=findme
(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- page: integer
ページ区切りが設定された結果セット内のページ番号。
- page_size: integer
ページごとに返す結果の数。
- search: string
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ネストされたスキーマ : SystemJobList
型:
ソースを表示
object- canceled_on: string(date-time)
タイトル:
Canceled on読取り専用:true取消リクエストが送信された日時。 - created: string
タイトル:
Created読取り専用:true - description: string
タイトル:
Description - elapsed: string(decimal)
タイトル:
Elapsed読取り専用:trueジョブが実行された経過時間(秒)。 - execution_environment: integer
タイトル:
Execution environment実行に使用するコンテナ・イメージ。 - execution_node: string
タイトル:
Execution node読取り専用:true最小長:1ジョブが実行されたノード。 - extra_vars: string
タイトル:
Extra vars - failed: boolean
タイトル:
Failed読取り専用:true - finished: string(date-time)
タイトル:
Finished読取り専用:trueジョブの実行が終了した日時。 - id: integer
タイトル:
ID読取り専用:true - job_explanation: string
タイトル:
Job explanation読取り専用:true最小長:1ジョブが実行および取得できなかった場合にジョブの状態を示すステータス・フィールド - job_type: string
タイトル:
Job type指定できる値:[ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens" ] - launch_type: string
タイトル:
Launch type読取り専用:true指定できる値:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ] - launched_by: string
タイトル:
Launched by読取り専用:true - modified: string
タイトル:
Modified読取り専用:true - name(required): string
タイトル:
Name最小長:1最大長:512 - related: string
- result_stdout: string
タイトル:
Result stdout読取り専用:true - started: string(date-time)
タイトル:
Started読取り専用:trueジョブが開始のためにキューに入れられた日時。 - status: string
タイトル:
Status読取り専用:true指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ] - summary_fields: string
タイトル:
Summary fields読取り専用:true - system_job_template: string
タイトル:
System job template - type: string
タイトル:
Type読取り専用:true - unified_job_template: string
タイトル:
unified job template読取り専用:true - url: string
タイトル:
Url読取り専用:true - work_unit_id: string
タイトル:
Work unit id読取り専用:true最小長:1このジョブに関連付けられた受容体作業ユニットID。