アドホック・コマンドのアドホック・コマンド・イベントのリスト
get
/api/v2/ad_hoc_commands/{id}/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
: ホストOKrunner_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
パス・パラメータ
問合せパラメータ
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"count":1,
"next":null,
"previous":null,
"results":[
{
"ad_hoc_command":1,
"changed":false,
"counter":0,
"created":"2018-02-01T08:00:00.000000Z",
"end_line":0,
"event":"runner_on_start",
"event_data":{
},
"event_display":"runner_on_start",
"failed":false,
"host":null,
"host_name":"",
"id":1,
"modified":"2018-02-01T08:00:00.000000Z",
"related":{
"ad_hoc_command":"/api/v2/ad_hoc_commands/1/"
},
"start_line":0,
"stdout":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"summary_fields":{
},
"type":"ad_hoc_command_event",
"url":"/api/v2/ad_hoc_command_events/1/",
"uuid":"abc123",
"verbosity":0
}
]
}