機械翻訳について

移動先

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

ホストのアドホック・コマンド・イベントのリスト

get

/api/v2/hosts/{id}/ad_hoc_command_events/

このリソースに対して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: このアドホック・コマンド・イベントが最後に変更されたときのタイムスタンプ。(日時)
• ad_hoc_command: (id)
• event: (選択)
  • runner_on_failed: ホスト失敗
  • runner_on_ok: ホストOK
  • runner_on_unreachable: ホスト到達不可
  • runner_on_skipped: ホスト・スキップ済
  • debug: デバッグ
  • verbose: 詳細
  • deprecated: 非推奨
  • warning: 警告
  • system_warning: システム警告
  • error: エラー
• counter: (整数)
• event_display: (文字列)
• event_data: (json)
• failed: (ブール)
• changed: (ブール)
• uuid: (文字列)
• host: (id)
• host_name: (文字列)
• stdout: (文字列)
• start_line: (整数)
• end_line: (整数)
• verbosity: (整数)

ソート

アドホック・コマンド・イベントが特定の順序で返されるように指定するには、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

パス・パラメータ

• id(required): string

問合せパラメータ

• 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/AdHocCommandEvent"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• Array of: object AdHocCommandEvent

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

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

型: object

ソースを表示

• ad_hoc_command: string
  タイトル: Ad hoc command

  読取り専用: true
• changed: boolean
  タイトル: Changed

  読取り専用: true
• counter: integer
  タイトル: Counter

  読取り専用: true

  最小値: 0
• created: string
  タイトル: Created

  読取り専用: true
• end_line: integer
  タイトル: End line

  読取り専用: true

  最小値: 0
• event(required): string
  タイトル: Event

  指定できる値: [ "runner_on_failed", "runner_on_ok", "runner_on_unreachable", "runner_on_skipped", "debug", "verbose", "deprecated", "warning", "system_warning", "error" ]
• event_data: object Event data
  タイトル: Event data
• event_display: string
  タイトル: Event display

  読取り専用: true

  最小長: 1
• failed: boolean
  タイトル: Failed

  読取り専用: true
• host: integer
  タイトル: Host

  読取り専用: true
• host_name: string
  タイトル: Host name

  読取り専用: true

  最小長: 1
• id: integer
  タイトル: ID

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

  読取り専用: true
• related: string
  タイトル: Related

  読取り専用: true
• start_line: integer
  タイトル: Start line

  読取り専用: true

  最小値: 0
• stdout: string
  タイトル: Stdout

  読取り専用: true

  最小長: 1
• summary_fields: string
  タイトル: Summary fields

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

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

  読取り専用: true
• uuid: string
  タイトル: Uuid

  読取り専用: true

  最小長: 1
• verbosity: integer
  タイトル: Verbosity

  読取り専用: true

  最小値: 0

{
    "properties":{
        "ad_hoc_command":{
            "readOnly":true,
            "title":"Ad hoc command",
            "type":"string"
        },
        "changed":{
            "readOnly":true,
            "title":"Changed",
            "type":"boolean"
        },
        "counter":{
            "minimum":"0",
            "readOnly":true,
            "title":"Counter",
            "type":"integer"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "end_line":{
            "minimum":"0",
            "readOnly":true,
            "title":"End line",
            "type":"integer"
        },
        "event":{
            "enum":[
                "runner_on_failed",
                "runner_on_ok",
                "runner_on_unreachable",
                "runner_on_skipped",
                "debug",
                "verbose",
                "deprecated",
                "warning",
                "system_warning",
                "error"
            ],
            "title":"Event",
            "type":"string",
            "x-nullable":true
        },
        "event_data":{
            "title":"Event data",
            "type":"object"
        },
        "event_display":{
            "minLength":"1",
            "readOnly":true,
            "title":"Event display",
            "type":"string"
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "host":{
            "readOnly":true,
            "title":"Host",
            "type":"integer",
            "x-nullable":true
        },
        "host_name":{
            "minLength":"1",
            "readOnly":true,
            "title":"Host name",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "start_line":{
            "minimum":"0",
            "readOnly":true,
            "title":"Start line",
            "type":"integer"
        },
        "stdout":{
            "minLength":"1",
            "readOnly":true,
            "title":"Stdout",
            "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"
        },
        "uuid":{
            "minLength":"1",
            "readOnly":true,
            "title":"Uuid",
            "type":"string"
        },
        "verbosity":{
            "minimum":"0",
            "readOnly":true,
            "title":"Verbosity",
            "type":"integer"
        }
    },
    "required":[
        "event"
    ],
    "type":"object"
}

ネストされたスキーマ : イベント・データ

型: object

タイトル: Event data

先頭に戻る