機械翻訳について

移動先

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

ホストのリスト

get

/api/v2/hosts/

このリソースに対してGETリクエストを行って、ホストのリストを取得します。

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

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

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

結果

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

• 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が最後に変更された日時。(日時)

ソート

ホストが特定の順序で返されるように指定するには、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

リクエスト

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

• application/json

問合せパラメータ

• page: integer
  ページ区切りが設定された結果セット内のページ番号。
• page_size: integer
  ページごとに返す結果の数。
• search: string
  検索条件。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/Host"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

ネストされたスキーマ: results

型: array

ソースを表示

• Array of: object Host

{
    "items":{
        "$ref":"#/definitions/Host"
    },
    "type":"array"
}

ネストされたスキーマ : ホスト

型: object

ソースを表示

• ansible_facts_modified: string(date-time)
  タイトル: Ansible facts modified

  読取り専用: true

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

  読取り専用: true
• description: string
  タイトル: Description
• enabled: boolean
  タイトル: Enabled

  デフォルト値: true

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

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

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

  読取り専用: true
• instance_id: string
  タイトル: Instance id

  最大長: 1024

  ホストを一意に識別するためにリモート・インベントリ・ソースで使用される値
• inventory(required): integer
  タイトル: Inventory
• last_job: string
  タイトル: Last job

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

  読取り専用: true
• modified: string
  タイトル: Modified

  読取り専用: true
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 512
• related: string
  タイトル: Related

  読取り専用: true
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• type: string
  タイトル: Type

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true
• variables: string
  タイトル: 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"
}

先頭に戻る