システム・ジョブ・テンプレートのリスト
get
/api/v2/system_job_templates/
このリソースに対して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
: このシステム・ジョブ・テンプレートのオプションの説明。(文字列)last_job_run
: (日時)last_job_failed
: (ブール)next_job_run
: (日時)status
: (選択)new
: 新規pending
: 保留中waiting
: 待機中running
: 実行中successful
: 成功failed
: 失敗error
: エラーcanceled
: 取消し済never updated
: 更新なしok
: OKmissing
: 不明none
: 外部ソースなしupdating
: 更新中
execution_environment
: 実行に使用されるコンテナ・イメージ。(id)job_type
: (選択)""
: ---------cleanup_jobs
: 特定の日数より前のジョブを削除しますcleanup_activitystream
: 特定の日数より前のアクティビティ・ストリーム・エントリを削除しますcleanup_sessions
: 期限切れのブラウザ・セッションをデータベースから削除しますcleanup_tokens
: 期限切れのOAuth 2アクセス・トークンおよびリフレッシュ・トークンを削除します
ソート
システム・ジョブ・テンプレートが特定の順序で返されるように指定するには、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レスポンス
ネストされたスキーマ : SystemJobTemplate
型:
ソースを表示
object
- created: string
タイトル:
Created
読取り専用:true
- description: string
タイトル:
Description
- execution_environment: integer
タイトル:
Execution environment
実行に使用するコンテナ・イメージ。 - id: integer
タイトル:
ID
読取り専用:true
- job_type: string
タイトル:
Job type
指定できる値:[ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens" ]
- last_job_failed: boolean
タイトル:
Last job failed
読取り専用:true
- last_job_run: string(date-time)
タイトル:
Last job run
読取り専用:true
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- next_job_run: string(date-time)
タイトル:
Next job run
読取り専用:true
- related: string
- status: string
タイトル:
Status
読取り専用:true
指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing", "none", "updating" ]
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- type: string
タイトル:
Type
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true