システム・ジョブ・テンプレートのリスト
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: 更新中
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(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。