子イベントのサマリーの表示
get
/api/v2/jobs/{id}/job_events/children_summary/
UI上でジョブの出力を処理しやすくするための特殊なビュー。イベントとその子イベントを縮小表示するために、UIは特定のイベントにいくつの子イベントが存在するかを把握している必要があります。UIはイベントの順序(0から始まるインデックス)も把握している必要があり、これは通常はカウンタと一致しますが、必ずしもそうとはかぎりません。このビューはJSONオブジェクトを返し、キーはイベント・カウンタを示し、値には子(および孫)イベントの数が含まれます。出力には子のイベントのみが含まれます。
例
例: デモ用ジョブ・テンプレートのジョブ・タプル(イベント・カウンタ, uuid, parent_uuid)
(1, '00000000-0000-0000-0000-000000000000', '')
(2, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')
(3, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')
(4, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')
(5, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')
(6, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')
(7, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')
(8, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')
(9, '00000000-0000-0000-0000-000000000000', '00000000-0000-0000-0000-000000000000')
出力
{
"1": {
"rowNumber": 0,
"numChildren": 8
},
"2": {
"rowNumber": 1,
"numChildren": 6
},
"3": {
"rowNumber": 2,
"numChildren": 2
},
"6": {
"rowNumber": 5,
"numChildren": 2
}
}
"meta_event_nested_parent_uuid": {}
}
カウンタ1はイベント0で子が8つ、カウンタ2はイベント1で子が6つなどです。
UIは"meta"イベントも縮小表示できる必要があります。"meta"イベントとは、詳細レベルまたはプレイ実行時にシステムからの警告によって表示されるものです。これらのイベントは0レベルのイベントであり、親uuidはありません。
playbook_on_start
verbose
playbook_on_play_start
playbook_on_task_start
runner_on_start <- level 3
verbose <- jump to level 0
verbose
runner_on_ok <- jump back to level 3
playbook_on_task_start
runner_on_start
runner_on_ok
verbose
verbose
playbook_on_stats
一連の子イベントの途中にこのようなverbose文が表示されるのは、UIとして問題があります。そのため、このビューではイベント・レベルにジャンプするのではなく、イベントを階層的に配置するようにしています。
playbook_on_start
verbose
playbook_on_play_start
playbook_on_task_start
runner_on_start <- A
verbose <- this maps to the uuid of A
verbose
runner_on_ok
playbook_on_task_start <- B
runner_on_start
runner_on_ok
verbose <- this maps to the uuid of B
verbose
playbook_on_stats
出力にはJSONオブジェクトが含まれ、キーはイベント・カウンタを示し、値は割り当てられたネストuuidを示します。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
先頭に戻る
レスポンス
サポートされているメディア・タイプ
- application/json