1. Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド
  2. タスク
  3. インスタンス・グループ

インスタンス・グループのインスタンスのリスト

get

/api/v2/instance_groups/{id}/instances/

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

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

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

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

結果

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

  • id: このインスタンスのデータベースID。(整数)
  • hostname: (文字列)
  • type: このインスタンスのデータ型。(選択)
  • url: このインスタンスのURL。(文字列)
  • related: 関連リソースのURLを含むデータ構造。(オブジェクト)
  • summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
  • uuid: (文字列)
  • created: このインスタンスが作成されたときのタイムスタンプ。(日時)
  • modified: このインスタンスが最後に変更されたときのタイムスタンプ。(日時)
  • last_seen: インスタンスが最後にメイン・クラスタ・ノードに対するハートビート・タスクを実行したとき。実行ノードのレセプタ・メッシュへの最後に確認された接続。(日時)
  • health_check_started: このインスタンスで最後にヘルス・チェックが開始されたとき。(日時)
  • health_check_pending: (フィールド)
  • last_health_check: CPU、メモリー、容量のリフレッシュのために、このインスタンスで最後にヘルス・チェックが実行されたとき。(日時)
  • errors: 最後のヘルス・チェックからのエラーの詳細。(文字列)
  • capacity_adjustment: (10進)
  • version: (文字列)
  • capacity: (整数)
  • consumed_capacity: (フィールド)
  • percent_capacity_remaining: (フィールド)
  • jobs_running: このインスタンスの対象となる実行状態または待機状態のジョブの数(整数)
  • jobs_total: このインスタンスを対象とするすべてのジョブの数(整数)
  • cpu: (10進)
  • memory: このインスタンスの合計システム・メモリー(バイト単位)。(整数)
  • cpu_capacity: (整数)
  • mem_capacity: (整数)
  • enabled: (ブール)
  • managed_by_policy: (ブール)
  • node_type: このノードがメッシュで果たす役割。(選択)
    • control: コントロール・プレーン・ノード
    • execution: 実行プレーン・ノード
    • hybrid: コントローラと実行
    • hop: メッセージ受渡しノード(実行機能なし)
  • node_state: このインスタンスの現在のライフ・サイクル・ステージを示します。(選択)
    • provisioning: プロビジョニング
    • provision-fail: プロビジョニング失敗
    • installed: インストール済
    • ready: 準備完了
    • unavailable: 使用不可
    • deprovisioning: プロビジョニング解除
    • deprovision-fail: プロビジョニング解除失敗
  • ip_address: (文字列)
  • listener_port: レセプタが受信接続をリスニングするポート。(整数)
  • peers: (フィールド)
  • peers_from_control_nodes: Trueの場合、コントロール・プレーン・クラスタ・ノードは自動的にピアリングする必要があります。(ブール)

ソート

インスタンスが特定の順序で返されるように指定するには、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
ソースを表示
ネストされたスキーマ : Instance
型: object
ソースを表示
ネストされたスキーマ : peers
型: array
一意のアイテムが必要: true
ソースを表示
先頭に戻る