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

ジョブ・テンプレートのインスタンス・グループのリスト

get

/api/v2/job_templates/{id}/instance_groups/

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

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

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

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

結果

それぞれのインスタンス・グループ・データ構造には次のフィールドが含まれます。

  • id: このインスタンス・グループのデータベースID。(整数)
  • type: このインスタンス・グループのデータ型。(選択)
  • url: このインスタンス・グループのURL。(文字列)
  • related: 関連リソースのURLを含むデータ構造。(オブジェクト)
  • name: このインスタンス・グループの名前。(文字列)
  • created: このインスタンス・グループが作成されたときのタイムスタンプ。(日時)
  • modified: このインスタンス・グループが最後に変更されたときのタイムスタンプ。(日時)
  • capacity: (フィールド)
  • consumed_capacity: (フィールド)
  • percent_capacity_remaining: (フィールド)
  • jobs_running: (フィールド)
  • max_concurrent_jobs: グループで実行される同時実行ジョブの最大数。ゼロに設定した場合、最大数は強制されません。(整数)
  • max_forks: グループで同時実行される分岐の最大数。ゼロに設定した場合、最大数は強制されません。(整数)
  • jobs_total: このインスタンス・グループを対象とするすべてのジョブの数(整数)
  • instances: (フィールド)
  • is_container_group: このグループのインスタンスがコンテナ化されているかどうかを示します。コンテナ化されているグループには、指定されたOpenshiftまたはKubernetesクラスタがあります。(ブール)
  • credential: (id)
  • policy_instance_percentage: 新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるすべてのインスタンスの最小パーセント。(整数)
  • policy_instance_minimum: 新しいインスタンスがオンラインになると、このグループに自動的に割り当てられるインスタンスの静的最小数。(整数)
  • policy_instance_list: このグループに割り当てられる完全一致インスタンスのリスト(json)
  • pod_spec_override: (文字列)
  • summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)

ソート

インスタンス・グループが特定の順序で返されるように指定するには、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
ソースを表示
ネストされたスキーマ : InstanceGroup
型: object
ソースを表示
ネストされたスキーマ : policy_instance_list
型: array
このグループに割り当てられる完全一致インスタンスのリスト
ソースを表示
先頭に戻る