ジョブ・テンプレートの取得
get
/api/v2/job_templates/{id}/
このリソースに対してGETリクエストを行って、次のフィールドを含む単一のジョブ・テンプレート・レコードを取得します。
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)
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- search: string
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
レスポンスの例(application/json)
{
"allow_simultaneous":false,
"ask_credential_on_launch":false,
"ask_diff_mode_on_launch":false,
"ask_inventory_on_launch":true,
"ask_job_type_on_launch":false,
"ask_limit_on_launch":false,
"ask_scm_branch_on_launch":false,
"ask_skip_tags_on_launch":false,
"ask_tags_on_launch":false,
"ask_variables_on_launch":false,
"ask_verbosity_on_launch":false,
"become_enabled":false,
"created":"2018-02-01T08:00:00.000000Z",
"custom_virtualenv":null,
"description":"",
"diff_mode":false,
"execution_environment":null,
"extra_vars":"",
"force_handlers":false,
"forks":"0",
"host_config_key":"",
"id":"2",
"inventory":null,
"job_slice_count":"1",
"job_tags":"",
"job_type":"run",
"last_job_failed":false,
"last_job_run":null,
"limit":"",
"modified":"2018-02-01T08:00:00.000000Z",
"name":"copy-edit-job-template",
"next_job_run":null,
"organization":"1",
"playbook":"helloworld.yml",
"project":"1",
"related":{
"access_list":"/api/v2/job_templates/2/access_list/",
"activity_stream":"/api/v2/job_templates/2/activity_stream/",
"copy":"/api/v2/job_templates/2/copy/",
"credentials":"/api/v2/job_templates/2/credentials/",
"instance_groups":"/api/v2/job_templates/2/instance_groups/",
"jobs":"/api/v2/job_templates/2/jobs/",
"labels":"/api/v2/job_templates/2/labels/",
"launch":"/api/v2/job_templates/2/launch/",
"notification_templates_error":"/api/v2/job_templates/2/notification_templates_error/",
"notification_templates_started":"/api/v2/job_templates/2/notification_templates_started/",
"notification_templates_success":"/api/v2/job_templates/2/notification_templates_success/",
"object_roles":"/api/v2/job_templates/2/object_roles/",
"organization":"/api/v2/organizations/1/",
"project":"/api/v2/projects/1/",
"schedules":"/api/v2/job_templates/2/schedules/",
"slice_workflow_jobs":"/api/v2/job_templates/2/slice_workflow_jobs/",
"survey_spec":"/api/v2/job_templates/2/survey_spec/",
"webhook_key":"/api/v2/job_templates/2/webhook_key/",
"webhook_receiver":""
},
"scm_branch":"",
"skip_tags":"",
"start_at_task":"",
"status":"never updated",
"summary_fields":{
"credentials":[
],
"labels":{
"count":"0",
"results":[
]
},
"object_roles":{
"admin_role":{
"description":"Can manage all aspects of the job template",
"id":"20",
"name":"Admin"
},
"execute_role":{
"description":"May run the job template",
"id":"21",
"name":"Execute"
},
"read_role":{
"description":"May view settings for the job template",
"id":"22",
"name":"Read"
}
},
"organization":{
"description":"test-org-desc",
"id":"1",
"name":"test-org"
},
"project":{
"allow_override":false,
"description":"test-proj-desc",
"id":"1",
"name":"test-proj",
"scm_type":"git",
"status":"never updated"
},
"recent_jobs":[
],
"user_capabilities":{
"copy":false,
"delete":true,
"edit":true,
"schedule":true,
"start":true
}
},
"survey_enabled":false,
"timeout":"0",
"type":"job_template",
"url":"/api/v2/job_templates/2/",
"use_fact_cache":false,
"verbosity":"0",
"webhook_credential":null,
"webhook_service":""
}