移動先

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

ホスト・メトリックのリスト

get

/api/v2/host_metrics/

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

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

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

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

結果

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

• id: このホスト・メトリックのデータベースID。(整数)
• hostname: (文字列)
• url: このホスト・メトリックのURL。(文字列)
• first_automation: ホストが最初に自動化されたとき(日時)
• last_automation: ホストが最後に自動化されたとき(日時)
• last_deleted: ホストが最後に削除されたとき(日時)
• automated_counter: ホストが自動化された回数(整数)
• deleted_counter: ホストが削除された回数(整数)
• deleted: ホストが削除され、その結果サブスクリプションの消費にカウントされなかったかどうかを示すブール・フラグ(ブール)
• used_in_inventories: このホストが含まれるインベントリの数(整数)

ソート

ホスト・メトリックが特定の順序で返されるように指定するには、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: 整数
  ページ区切りが設定された結果セット内のページ番号。
• page_size: 整数
  ページごとに返す結果の数。
• search: 文字列
  検索条件。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ: schema

型: object

ソースを表示

• count(必須): 整数
• next: 文字列(uri)
• previous: 文字列(uri)
• results(必須): 配列 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/HostMetric"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• 配列: オブジェクト HostMetric

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

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

型: object

ソースを表示

• automated_counter: 整数
  タイトル: Automated counter

  ホストが自動化された回数
• deleted: ブール
  タイトル: Deleted

  ホストが削除され、その結果サブスクリプションの消費にカウントされなかったかどうかを示すブール・フラグ
• deleted_counter: 整数
  タイトル: Deleted counter

  ホストが削除された回数
• first_automation: 文字列(日付-時間)
  タイトル: First automation

  読取り専用: true

  ホストが最初に自動化されたとき
• hostname(必須): 文字列
  タイトル: Hostname

  最小長: 1

  最大長: 512
• id: 整数
  タイトル: ID

  読取り専用: true
• last_automation(必須): 文字列(日付-時間)
  タイトル: Last automation

  ホストが最後に自動化されたとき
• last_deleted: 文字列(日付-時間)
  タイトル: Last deleted

  属性が最後に削除されたとき
• url: 文字列
  タイトル: Url

  読取り専用: true
• used_in_inventories: 整数
  タイトル: Used in inventories

  このホストが含まれるインベントリの数

{
    "properties":{
        "automated_counter":{
            "description":"How many times was the host automated",
            "title":"Automated counter",
            "type":"integer"
        },
        "deleted":{
            "description":"Boolean flag saying whether the host is deleted and therefore not counted into the subscription consumption",
            "title":"Deleted",
            "type":"boolean",
            "x-nullable":true
        },
        "deleted_counter":{
            "description":"How many times was the host deleted",
            "title":"Deleted counter",
            "type":"integer"
        },
        "first_automation":{
            "description":"When the host was first automated against",
            "format":"date-time",
            "readOnly":true,
            "title":"First automation",
            "type":"string"
        },
        "hostname":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Hostname",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "last_automation":{
            "description":"When the host was last automated against",
            "format":"date-time",
            "title":"Last automation",
            "type":"string"
        },
        "last_deleted":{
            "description":"When the host was last deleted",
            "format":"date-time",
            "title":"Last deleted",
            "type":"string",
            "x-nullable":true
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "used_in_inventories":{
            "description":"How many inventories contain this host",
            "title":"Used in inventories",
            "type":"integer",
            "x-nullable":true
        }
    },
    "required":[
        "hostname",
        "last_automation"
    ],
    "type":"object"
}

先頭に戻る