移動先

• リクエスト
• レスポンス

ホストの取得

get

/api/v2/hosts/{id}/

このリソースに対してGETリクエストを行って、次のフィールドを含む単一のホスト・レコードを取得します。

• id: このホストのデータベースID。(整数)
• type: このホストのデータ型。(選択)
• url: このホストのURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: このホストが作成されたときのタイムスタンプ。(日時)
• modified: このホストが最後に変更されたときのタイムスタンプ。(日時)
• name: このホストの名前。(文字列)
• description: このホストのオプションの説明。(文字列)
• inventory: (id)
• enabled: このホストがオンラインで、ジョブの実行に使用できるかどうか。(ブール)
• instance_id: ホストを一意に識別するためにリモート・インベントリ・ソースによって使用される値(文字列)
• variables: JSONまたはYAML形式のホスト変数。(json)
• has_active_failures: (フィールド)
• has_inventory_sources: (フィールド)
• last_job: (id)
• last_job_host_summary: (id)
• ansible_facts_modified: ansible_factsが最後に変更された日時。(日時)

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• id(必須): 文字列

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

本文()

ルート・スキーマ : Host

型: object

ソースを表示

• ansible_facts_modified: 文字列(日付-時間)
  タイトル: Ansible facts modified

  読取り専用: true

  ansible_factsが最後に変更された日時。
• created: 文字列
  タイトル: Created

  読取り専用: true
• description: 文字列
  タイトル: Description
• enabled: ブール
  タイトル: Enabled

  デフォルト値: true

  このホストはオンラインであり、ジョブの実行に使用できますか。
• has_active_failures: 文字列
  タイトル: Has active failures

  読取り専用: true
• has_inventory_sources: 文字列
  タイトル: Has inventory sources

  読取り専用: true
• id: 整数
  タイトル: ID

  読取り専用: true
• instance_id: 文字列
  タイトル: Instance id

  最大長: 1024

  ホストを一意に識別するためにリモート・インベントリ・ソースによって使用される値
• inventory(必須): 整数
  タイトル: Inventory
• last_job: 文字列
  タイトル: Last job

  読取り専用: true
• last_job_host_summary: 整数
  タイトル: Last job host summary

  読取り専用: true
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• related: 文字列
  タイトル: Related

  読取り専用: true
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true
• variables: 文字列
  タイトル: Variables

  JSONまたはYAML形式のホスト変数。

{
    "properties":{
        "ansible_facts_modified":{
            "description":"The date and time ansible_facts was last modified.",
            "format":"date-time",
            "readOnly":true,
            "title":"Ansible facts modified",
            "type":"string",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "enabled":{
            "default":true,
            "description":"Is this host online and available for running jobs?",
            "title":"Enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "has_active_failures":{
            "readOnly":true,
            "title":"Has active failures",
            "type":"string"
        },
        "has_inventory_sources":{
            "readOnly":true,
            "title":"Has inventory sources",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "instance_id":{
            "description":"The value used by the remote inventory source to uniquely identify the host",
            "maxLength":"1024",
            "title":"Instance id",
            "type":"string",
            "x-nullable":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer"
        },
        "last_job":{
            "readOnly":true,
            "title":"Last job",
            "type":"string",
            "x-nullable":true
        },
        "last_job_host_summary":{
            "readOnly":true,
            "title":"Last job host summary",
            "type":"integer",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "variables":{
            "description":"Host variables in JSON or YAML format.",
            "title":"Variables",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name",
        "inventory"
    ],
    "type":"object"
}

先頭に戻る