このリソースに GET リクエストを実行して、ホストリストを取得します。
GET /api/v1/hosts/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
X-API-Time: 0.050s
返されるデータ構造には以下のものが含まれます。
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count フィールドはクエリーで見つかったホストの合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results にはホストレコードが一覧表示されますが、ゼロの場合もあります。
各ホストのデータ構造には以下のフィールドが含まれます。
id: ホストのデータベース ID (整数)type: ホストのデータタイプ (複数選択)host: ホストurl: ホストの URL (文字列)related: 関連リソースの URL のあるデータ構造 (オブジェクト)summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)created: ホスト作成時のタイムスタンプ (日時)modified: ホストの最終更新時のタイムスタンプ (日時)name: (文字列)description: (文字列)inventory: (フィールド)enabled: このホストはオンラインで、ジョブを実行するために利用できるかどうか (ブール値)instance_id: (文字列)variables: YAML または JSON 形式のホスト変数 (文字列)has_active_failures: ホストの最後のジョブが失敗したかどうかを示すフラグ (ブール値)has_inventory_sources: ホストが外部インベントリーソースから作成/更新されたかどうかを示すフラグ (ブール値)last_job: (フィールド)last_job_host_summary: (フィールド)新規ホストを作成するには、以下のホストフィールドを使ってリソースに POST リクエストを実行します。
name: (文字列。必須)description: (文字列。デフォルトは "")inventory: (フィールド。デフォルトは "")enabled: このホストはオンラインで、ジョブを実行するために利用できるかどうか (ブール値。デフォルトは True)instance_id: (文字列。デフォルトは "")variables: YAML または JSON 形式のホスト変数 (文字列。デフォルトは "")last_job: (フィールド。デフォルトは None)last_job_host_summary: (フィールド。デフォルトは None)オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。
| name | Host List | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| description | # List Hosts: Make a GET request to this resource to retrieve the list of hosts. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| renders |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| parses |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| added_in_version | 1.2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| actions |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| types |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| search_fields |
|