Documentation

ホストリストの API エンドポイント

このリソースに 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
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.2
actions
POST
name
type string
required
true
label name
max_length 512
description
type string
required
false
label description
default (Empty Text)
inventory
type field
required
true
enabled
type boolean
required
false
label enabled
help_text Is this host online and available for running jobs?
default
true
instance_id
type string
required
false
label instance id
max_length 100
default (Empty Text)
variables
type string
required
false
label variables
help_text Host variables in JSON or YAML format.
default (Empty Text)
last_job
type field
required
false
default null
last_job_host_summary
type field
required
false
default null
GET
id
type integer
label ID
help_text Database ID for this host.
type
type multiple choice
help_text Data type for this host.
choices
0
0 host
1 Host
url
type string
help_text URL for this host.
related
type object
help_text Data structure with URLs of related resources.
summary_fields
type object
help_text Data structure with name/description for related resources.
created
type datetime
help_text Timestamp when this host was created.
modified
type datetime
help_text Timestamp when this host was last modified.
name
type string
label name
description
type string
label description
inventory
type field
enabled
type boolean
label enabled
help_text Is this host online and available for running jobs?
instance_id
type string
label instance id
variables
type string
label variables
help_text Host variables in JSON or YAML format.
has_active_failures
type boolean
label has active failures
help_text Flag indicating whether the last job failed for this host.
has_inventory_sources
type boolean
label has inventory sources
help_text Flag indicating whether this host was created/updated from any external inventory sources.
last_job
type field
last_job_host_summary
type field
types
0 host
search_fields
0 description
1 name