このページでは、ワークフロー自動化アクションカタログで利用可能なansible.job.getStatusアクションのリファレンスを提供します。このアクションを使用して、Ansible Automation プラットフォーム(Automation Controller)ジョブのステータスと詳細を取得します。ansible.job.launchによって作成されたジョブをポーリングするには、このアクションを使用します。このアクションは、http.getベースアクションに基づいています。
エンドポイント: GET https://{host}/api/controller/v2/jobs/{jobId}/
前提条件
ワークフローの自動化でこのアクションを使用する前に、以下が準備されていることを確認してください:
- HTTPS経由でアクセス可能なAnsible Automation プラットフォーム(Automation Controller)インスタンス。
- 書き込みスコープを持つOAuth2トークン(Automation Controller → ユーザー → トークンで作成してください)
- ポーリングする数値ジョブID(通常は
ansible.job.launchによって返されるidフィールド)。
ジョブステータスの取得
Automation Controllerジョブのステータスと詳細を取得します。http.getベースアクションを基に構築されています。
ジョブのステータスは、pendingからwaiting、runningへと進み、最終状態:successful、failed、error、またはcanceledに達します。
入力フィールド | オプション性 | タイプ | 例 |
|---|
ホスト | 必須 | 弦 | ${{ :secrets:host }}
スキームなしのAutomation Controllerのホスト名(およびオプションのポート)。例:aap.example.com。 |
authToken | 必須 | 弦 | ${{ :secrets:ansibleControllerToken }}
Authorization: Bearer <token>として送信されるOAuth2トークン。
|
jobId | 必須 | Int | 128
数値のジョブID。通常、ansible.job.launchによって返されるidです。 |
セレクター | オプション | リスト | [{"name": "status", "expression": ".status"}, {"name": "finished", "expression": ".finished"}, {"name": "failed", "expression": ".failed"}]
|
出力フィールド | タイプ | 例 |
|---|
成功 | ブール値 | success: true | false
|
response | オブジェクト | "started": "2026-07-08T10:00:00Z", "finished": "2026-07-08T10:02:13Z",
|
エラーメッセージ | 弦 | { "detail": "Not found." }
|
ワークフローの例 |
|---|
description: 'Fetches the status of a previously launched Ansible job.' action: ansible.job.getStatus host: ${{ :secrets:host }} authToken: ${{ :secrets:ansibleControllerToken }}
|