インスタンスのリスト
get
/api/v2/instances/
このリソースに対してGETリクエストを行って、インスタンスのリストを取得します。
結果のデータ構造には次が含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count
フィールドは、対象となる問合せで見つかったインスタンスの合計数を示します。 next
フィールドとprevious
フィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 results
リストには、0個以上のインスタンス・レコードが含まれます。
結果
それぞれのインスタンス・データ構造には次のフィールドが含まれます。
id
: このインスタンスのデータベースID。(整数)type
: このインスタンスのデータ型。(選択)url
: このインスタンスのURL。(文字列)related
: 関連リソースのURLを含むデータ構造。(オブジェクト)uuid
: (文字列)hostname
: (文字列)created
: このインスタンスが作成されたときのタイムスタンプ。(日時)modified
: このインスタンスが最後に変更されたときのタイムスタンプ。(日時)last_seen
: 最後にインスタンスがメイン・クラスタ・ノードに対してハートビート・タスクを実行したとき。 実行ノードの受容体メッシュへの最後の既知の接続。(日時)last_health_check
: CPU、メモリーおよび容量をリフレッシュするために、このインスタンスでヘルス・チェックが前回実行された時間。(日時)errors
: 最後のヘルス・チェックからのエラーの詳細。(文字列)capacity_adjustment
: (10進)version
: (文字列)capacity
: (整数)consumed_capacity
: (フィールド)percent_capacity_remaining
: (フィールド)jobs_running
: このインスタンスの対象となる実行状態または待機状態のジョブの数(整数)jobs_total
: このインスタンスを対象とするすべてのジョブの数(整数)cpu
: (整数)memory
: このインスタンスのシステム・メモリーの合計(バイト)。(整数)cpu_capacity
: (整数)mem_capacity
: (整数)enabled
: (ブール)managed_by_policy
: (ブール)node_type
: (choice)control
: コントロール・プレーン・ノードexecution
: 実行プレーン・ノードhybrid
: コントローラと実行hop
: メッセージを渡すノード、実行機能なし
ソート
インスタンスが特定の順序で返されるように指定するには、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
( 「Oracle Linux Automation Manaerに追加」)関連フィールド全体を検索します:
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。