移動先

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

ホスト・メトリック月次サマリーのリスト

get

/api/v2/host_metric_summary_monthly/

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

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

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

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

結果

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

• id: このホスト・メトリック月次サマリーのデータベースID。(整数)
• date: (日付)
• license_consumed: ライセンスから消費される一意のホストの数(整数)
• license_capacity: 一意のホストの最大数としてのライセンス容量(整数)
• hosts_added: 該当月に追加され、消費するライセンス容量を増加させたホストの数(整数)
• hosts_deleted: 該当月に削除され、ライセンス容量を解放させたホストの数(整数)
• indirectly_managed_hosts: 特定の月に間接的に管理されたホストを示す手動入力された数(整数)

ソート

ホスト・メトリック月次サマリーが特定の順序で返されるように指定するには、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/HostMetricSummaryMonthly"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• 配列: オブジェクト HostMetricSummaryMonthly

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

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

型: object

ソースを表示

• date: 文字列(日付)
  タイトル: Date

  読取り専用: true
• hosts_added: 整数
  タイトル: Hosts added

  読取り専用: true

  該当月に追加され、消費するライセンス容量を増加させたホストの数
• hosts_deleted: 整数
  タイトル: Hosts deleted

  読取り専用: true

  該当月に削除され、ライセンス容量を解放させたホストの数
• id: 整数
  タイトル: ID

  読取り専用: true
• indirectly_managed_hosts: 整数
  タイトル: Indirectly managed hosts

  読取り専用: true

  特定の月に間接的に管理されたホストを示す手動入力された数
• license_capacity: 整数
  タイトル: License capacity

  読取り専用: true

  一意のホストの最大数としてのライセンス容量
• license_consumed: 整数
  タイトル: License consumed

  読取り専用: true

  ライセンスから消費される一意のホストの数

{
    "properties":{
        "date":{
            "format":"date",
            "readOnly":true,
            "title":"Date",
            "type":"string"
        },
        "hosts_added":{
            "description":"How many hosts were added in the associated month, consuming more license capacity",
            "readOnly":true,
            "title":"Hosts added",
            "type":"integer"
        },
        "hosts_deleted":{
            "description":"How many hosts were deleted in the associated month, freeing the license capacity",
            "readOnly":true,
            "title":"Hosts deleted",
            "type":"integer"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "indirectly_managed_hosts":{
            "description":"Manually entered number indirectly managed hosts for a certain month",
            "readOnly":true,
            "title":"Indirectly managed hosts",
            "type":"integer"
        },
        "license_capacity":{
            "description":"'License capacity as max. number of unique hosts",
            "readOnly":true,
            "title":"License capacity",
            "type":"integer"
        },
        "license_consumed":{
            "description":"How many unique hosts are consumed from the license",
            "readOnly":true,
            "title":"License consumed",
            "type":"integer"
        }
    },
    "type":"object"
}

先頭に戻る