1. Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド
  2. タスク
  3. システム・ジョブ・テンプレート

システム・ジョブ・テンプレートのスケジュールのリスト

get

/api/v2/system_job_templates/{id}/schedules/

このリソースに対してGETリクエストを行って、選択したシステム・ジョブ・テンプレートに関連付けられたスケジュールのリストを取得します。

結果のデータ構造には次が含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

countフィールドは、対象となる問合せで見つかったスケジュールの合計数を示します。nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。resultsリストには、0個以上のスケジュール・レコードが含まれます。

結果

それぞれのスケジュールのデータ構造には次のフィールドが含まれます。

  • rrule: スケジュールのiCal繰返しルールを表す値。(文字列)
  • id: このスケジュールのデータベースID。(整数)
  • type: このスケジュールのデータ型。(選択)
  • url: このスケジュールのURL。(文字列)
  • related: 関連リソースのURLを含むデータ構造。(オブジェクト)
  • summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
  • created: このスケジュールが作成されたときのタイムスタンプ。(日時)
  • modified: このスケジュールが最後に変更されたときのタイムスタンプ。(日時)
  • name: このスケジュールの名前。(文字列)
  • description: このスケジュールのオプションの説明。(文字列)
  • extra_data: (json)
  • inventory: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id)
  • scm_branch: (文字列)
  • job_type: (選択)
    • None: ---------
    • "": ---------
    • run: 実行
    • check: チェック
  • job_tags: (文字列)
  • skip_tags: (文字列)
  • limit: (文字列)
  • diff_mode: (ブール)
  • verbosity: (選択)
    • None: ---------
    • 0: 0 (標準)
    • 1: 1 (詳細)
    • 2: 2 (より詳細)
    • 3: 3 (デバッグ)
    • 4: 4 (接続デバッグ)
    • 5: 5 (WinRMデバッグ)
  • execution_environment: 実行に使用されるコンテナ・イメージ。(id)
  • forks: (整数)
  • job_slice_count: (整数)
  • timeout: (整数)
  • unified_job_template: (id)
  • enabled: このスケジュールの処理を有効にします。(ブール)
  • dtstart: 初回のスケジュールはこの時間以降に発生します。(日時)
  • dtend: 最後のスケジュールはこの時間より前に発生し、これ以降、スケジュールは失効します。(日時)
  • next_run: スケジュールされたアクションが次に実行される時間。(日時)
  • timezone: このスケジュールが実行されるタイムゾーン。このフィールドはRRULEから抽出されます。RRULEのタイムゾーンが別のタイムゾーンにリンクされている場合、そのリンクがこのフィールドに反映されます。(フィールド)
  • until: このスケジュールを終了する日付。このフィールドはRRULEから計算されます。スケジュールに終了日がない場合は、空の文字列が返されます(フィールド)

ソート

スケジュールが特定の順序で返されるように指定するには、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

リクエスト

サポートされているメディア・タイプ
パス・パラメータ
問合せパラメータ
先頭に戻る

レスポンス

サポートされているメディア・タイプ

200レスポンス

本文()
ルート・スキーマ: schema
型: object
ソースを表示
ネストされたスキーマ : results
型: array
ソースを表示
ネストされたスキーマ : Schedule
型: object
ソースを表示
ネストされたスキーマ : Extra data
型: object
タイトル: Extra data
先頭に戻る