機械翻訳について

移動先

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

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

get

/api/v2/host_metrics/

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

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

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

countフィールドは、指定された問合せで検出されたホスト・メトリックの合計数を示します。 nextフィールドとpreviousフィールドには、単一ページに収まる以上の結果へのリンクが表示されます。 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タワー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/HostMetric"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• Array of: object HostMetric

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

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

型: object

ソースを表示

• automated_counter: integer
  タイトル: Automated counter

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

  ホストが削除されてサブスクリプション消費にカウントされないかどうかを示すブール・フラグ
• deleted_counter: integer
  タイトル: Deleted counter

  ホストが削除された回数
• first_automation: string(date-time)
  タイトル: First automation

  読取り専用: true

  ホストが最初に自動化されたとき
• hostname(required): string
  タイトル: Hostname

  最小長: 1

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

  読取り専用: true
• last_automation(required): string(date-time)
  タイトル: Last automation

  ホストが最後に自動化されたとき
• last_deleted: string(date-time)
  タイトル: Last deleted

  ホストが最後に削除されたとき
• url: string
  タイトル: Url

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

先頭に戻る