組織のジョブ・テンプレートのリスト
get
/api/v2/organizations/{id}/job_templates/
このリソースに対して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: このジョブ・テンプレートが最後に変更されたときのタイムスタンプ。(日時)name: このジョブ・テンプレートの名前。(文字列)description: このジョブ・テンプレートのオプションの説明。(文字列)job_type: (選択)run: 実行check: チェック
inventory: (id)project: (id)playbook: (文字列)scm_branch: ジョブ実行で使用するブランチ。 空白の場合に使用されるプロジェクトのデフォルト。 プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。(文字列)forks: (整数)limit: (文字列)verbosity: (選択)0: 0 (標準)1: 1 (詳細)2: 2 (より詳細)3: 3 (デバッグ)4: 4 (接続デバッグ)5: 5 (WinRMデバッグ)
extra_vars: (json)job_tags: (文字列)force_handlers: (ブール)skip_tags: (文字列)start_at_task: (文字列)timeout: タスクが取り消されるまでの実行時間(秒)。(整数)use_fact_cache: 有効にすると、サービスはAnsibleファクト・キャッシュ・プラグインとして機能します。プレイブック実行の最後にファクトを永続化し、Ansibleで使用するファクトをキャッシュします。(ブール)organization: このテンプレートへのアクセス権を決定するために使用される組織。(id)last_job_run: (日時)last_job_failed: (ブール)next_job_run: (日時)status: (選択)new: 新規pending: 保留中waiting: 待機中running: 実行中successful: 成功failed: 失敗error: エラーcanceled: 取消し済never updated: 更新なし
execution_environment: 実行に使用されるコンテナ・イメージ。(id)host_config_key: (文字列)ask_scm_branch_on_launch: (ブール)ask_diff_mode_on_launch: (ブール)ask_variables_on_launch: (ブール)ask_limit_on_launch: (ブール)ask_tags_on_launch: (ブール)ask_skip_tags_on_launch: (ブール)ask_job_type_on_launch: (ブール)ask_verbosity_on_launch: (ブール)ask_inventory_on_launch: (ブール)ask_credential_on_launch: (ブール)survey_enabled: (ブール)become_enabled: (ブール)diff_mode: 有効にすると、ホスト上のテンプレート化されたファイルに加えられたテキストの変更が標準出力に表示されます(ブール)allow_simultaneous: (ブール)custom_virtualenv: 使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス(文字列)job_slice_count: 実行時にスライスするジョブの数。 値が1より大きい場合は、ジョブ・テンプレートによってワークフローが起動されます。(整数)webhook_service: Webフック・リクエストを受け入れるサービス(選択)"": ---------github: GitHubgitlab: GitLab
webhook_credential: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(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
( 「Oracle Linux Automation Manaerに追加」)関連フィールド全体を検索します:
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page(オプション): 整数
ページ区切りが設定された結果セット内のページ番号。
- page_size(オプション): 整数
ページごとに返す結果の数。
- search(オプション): 文字列
検索条件。