Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

プロジェクト更新のプロジェクト更新イベントのリスト

get

/api/v2/project_updates/{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: このプロジェクト更新イベントが最後に変更されたときのタイムスタンプ。(日時)
event: (選択)
- runner_on_failed: ホスト失敗
- runner_on_start: ホスト起動済
- runner_on_ok: ホストOK
- runner_on_error: ホスト障害
- runner_on_skipped: ホスト・スキップ済
- runner_on_unreachable: ホスト到達不可
- runner_on_no_hosts: 残りのホストなし
- runner_on_async_poll: ホスト・ポーリング
- runner_on_async_ok: ホスト非同期OK
- runner_on_async_failed: ホスト非同期失敗
- runner_item_on_ok: アイテムOK
- runner_item_on_failed: アイテム失敗
- runner_item_on_skipped: アイテム・スキップ済
- runner_retry: ホスト再試行
- runner_on_file_diff: ファイル差分
- playbook_on_start: プレイブック起動済
- playbook_on_notify: ハンドラの実行中
- playbook_on_include: ファイルの組込み
- playbook_on_no_hosts_matched: 一致するホストなし
- playbook_on_no_hosts_remaining: 残りのホストなし
- playbook_on_task_start: タスク開始済
- playbook_on_vars_prompt: 変数の要求
- playbook_on_setup: ファクトの収集
- playbook_on_import_for_host: 内部: ホストのインポート時
- playbook_on_not_import_for_host: 内部: ホストのインポートなし
- playbook_on_play_start: 再生開始済
- playbook_on_stats: プレイブック完了
- debug: デバッグ
- verbose: 詳細
- deprecated: 非推奨
- warning: 警告
- system_warning: システム警告
- error: エラー
counter: (整数)
event_display: (文字列)
event_data: (json)
event_level: (整数)
failed: (ブール)
changed: (ブール)
uuid: (文字列)
host_name: (フィールド)
playbook: (文字列)
play: (文字列)
task: (文字列)
role: (文字列)
stdout: (フィールド)
start_line: (整数)
end_line: (整数)
verbosity: (整数)
project_update: (id)

ソート

プロジェクト更新イベントが特定の順序で返されるように指定するには、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/ProjectUpdateEvent"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

Array of: object ProjectUpdateEvent

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

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

型: object

ソースを表示

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_start", "runner_on_ok", "runner_on_error", "runner_on_skipped", "runner_on_unreachable", "runner_on_no_hosts", "runner_on_async_poll", "runner_on_async_ok", "runner_on_async_failed", "runner_item_on_ok", "runner_item_on_failed", "runner_item_on_skipped", "runner_retry", "runner_on_file_diff", "playbook_on_start", "playbook_on_notify", "playbook_on_include", "playbook_on_no_hosts_matched", "playbook_on_no_hosts_remaining", "playbook_on_task_start", "playbook_on_vars_prompt", "playbook_on_setup", "playbook_on_import_for_host", "playbook_on_not_import_for_host", "playbook_on_play_start", "playbook_on_stats", "debug", "verbose", "deprecated", "warning", "system_warning", "error" ]
event_data: string

タイトル: Event data

読取り専用: true
event_display: string

タイトル: Event display

読取り専用: true

最小長: 1
event_level: integer

タイトル: Event level

読取り専用: true
failed: boolean

タイトル: Failed

読取り専用: true
host_name: string

タイトル: Host name

読取り専用: true
id: integer

タイトル: ID

読取り専用: true
modified: string

タイトル: Modified

読取り専用: true
play: string

タイトル: Play

読取り専用: true

最小長: 1
playbook: string

タイトル: Playbook

読取り専用: true

最小長: 1
project_update: string

タイトル: Project update

読取り専用: true
related: string

タイトル: Related

読取り専用: true
role: string

タイトル: Role

読取り専用: true

最小長: 1
start_line: integer

タイトル: Start line

読取り専用: true

最小値: 0
stdout: string

タイトル: Stdout

読取り専用: true
summary_fields: string

タイトル: Summary fields

読取り専用: true
task: string

タイトル: Task

読取り専用: true

最小長: 1
type: string

タイトル: Type

読取り専用: true
url: string

タイトル: Url

読取り専用: true
uuid: string

タイトル: Uuid

読取り専用: true

最小長: 1
verbosity: integer

タイトル: Verbosity

読取り専用: true

最小値: 0

{
    "properties":{
        "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_start",
                "runner_on_ok",
                "runner_on_error",
                "runner_on_skipped",
                "runner_on_unreachable",
                "runner_on_no_hosts",
                "runner_on_async_poll",
                "runner_on_async_ok",
                "runner_on_async_failed",
                "runner_item_on_ok",
                "runner_item_on_failed",
                "runner_item_on_skipped",
                "runner_retry",
                "runner_on_file_diff",
                "playbook_on_start",
                "playbook_on_notify",
                "playbook_on_include",
                "playbook_on_no_hosts_matched",
                "playbook_on_no_hosts_remaining",
                "playbook_on_task_start",
                "playbook_on_vars_prompt",
                "playbook_on_setup",
                "playbook_on_import_for_host",
                "playbook_on_not_import_for_host",
                "playbook_on_play_start",
                "playbook_on_stats",
                "debug",
                "verbose",
                "deprecated",
                "warning",
                "system_warning",
                "error"
            ],
            "title":"Event",
            "type":"string",
            "x-nullable":true
        },
        "event_data":{
            "readOnly":true,
            "title":"Event data",
            "type":"string"
        },
        "event_display":{
            "minLength":"1",
            "readOnly":true,
            "title":"Event display",
            "type":"string"
        },
        "event_level":{
            "readOnly":true,
            "title":"Event level",
            "type":"integer"
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "host_name":{
            "readOnly":true,
            "title":"Host name",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "play":{
            "minLength":"1",
            "readOnly":true,
            "title":"Play",
            "type":"string"
        },
        "playbook":{
            "minLength":"1",
            "readOnly":true,
            "title":"Playbook",
            "type":"string"
        },
        "project_update":{
            "readOnly":true,
            "title":"Project update",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "role":{
            "minLength":"1",
            "readOnly":true,
            "title":"Role",
            "type":"string"
        },
        "start_line":{
            "minimum":"0",
            "readOnly":true,
            "title":"Start line",
            "type":"integer"
        },
        "stdout":{
            "readOnly":true,
            "title":"Stdout",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "task":{
            "minLength":"1",
            "readOnly":true,
            "title":"Task",
            "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"
}

先頭に戻る