移動先

• リクエスト
• レスポンス

ジョブ・テンプレートの起動

post

/api/v2/job_templates/{id}/launch/

job_templateを起動するには、このリソースに対してPOSTリクエストを行います。パスワード、インベントリまたは追加変数(extra_vars)が必要な場合は、extra_varsをYAMLまたはJSON文字列として指定し、カッコをエスケープして、POSTデータで渡す必要があります。inventory_needed_to_startがTrueの場合は、inventoryが必要です。

成功した場合、レスポンス・ステータス・コードは201になります。必要なパスワードが指定されていない場合は、400ステータス・コードが返されます。ジョブを起動できない場合は、405ステータス・コードが返されます。指定された資格証明またはインベントリの使用をユーザーが許可されていない場合は、403ステータス・コードが返されます。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : JobLaunch

型: object

ソースを表示

• ask_credential_on_launch: ブール
  タイトル: Ask credential on launch

  読取り専用: true
• ask_diff_mode_on_launch: ブール
  タイトル: Ask diff mode on launch

  読取り専用: true
• ask_execution_environment_on_launch: ブール
  タイトル: Ask execution environment on launch

  読取り専用: true
• ask_forks_on_launch: ブール
  タイトル: Ask forks on launch

  読取り専用: true
• ask_instance_groups_on_launch: ブール
  タイトル: Ask instance groups on launch

  読取り専用: true
• ask_inventory_on_launch: ブール
  タイトル: Ask inventory on launch

  読取り専用: true
• ask_job_slice_count_on_launch: ブール
  タイトル: Ask job slice count on launch

  読取り専用: true
• ask_job_type_on_launch: ブール
  タイトル: Ask job type on launch

  読取り専用: true
• ask_labels_on_launch: ブール
  タイトル: Ask labels on launch

  読取り専用: true
• ask_limit_on_launch: ブール
  タイトル: Ask limit on launch

  読取り専用: true
• ask_scm_branch_on_launch: ブール
  タイトル: Ask scm branch on launch

  読取り専用: true
• ask_skip_tags_on_launch: ブール
  タイトル: Ask skip tags on launch

  読取り専用: true
• ask_tags_on_launch: ブール
  タイトル: Ask tags on launch

  読取り専用: true
• ask_timeout_on_launch: ブール
  タイトル: Ask timeout on launch

  読取り専用: true
• ask_variables_on_launch: ブール
  タイトル: Ask variables on launch

  読取り専用: true
• ask_verbosity_on_launch: ブール
  タイトル: Ask verbosity on launch

  読取り専用: true
• can_start_without_user_input: ブール
  タイトル: Can start without user input

  読取り専用: true
• credential_needed_to_start: 文字列
  タイトル: Credential needed to start

  読取り専用: true
• credential_passwords: 文字列
  タイトル: Credential passwords
• credentials: 配列 credentials
  一意のアイテムが必要: true
• defaults: 文字列
  タイトル: Defaults

  読取り専用: true
• diff_mode: ブール
  タイトル: Diff mode
• execution_environment: 整数
  タイトル: Execution environment
• extra_vars: オブジェクト Extra vars
  タイトル: Extra vars
• forks: 整数
  タイトル: Forks

  最小値: 0
• instance_groups: 配列 instance_groups
  一意のアイテムが必要: true
• inventory: 整数
  タイトル: Inventory
• inventory_needed_to_start: 文字列
  タイトル: Inventory needed to start

  読取り専用: true
• job_slice_count: 整数
  タイトル: Job slice count

  最小値: 0
• job_tags: 文字列
  タイトル: Job tags
• job_template_data: 文字列
  タイトル: Job template data

  読取り専用: true
• job_type: 文字列
  タイトル: Job type

  指定できる値: [ "run", "check" ]
• labels: 配列 labels
  一意のアイテムが必要: true
• limit: 文字列
  タイトル: Limit
• passwords_needed_to_start: 文字列
  タイトル: Passwords needed to start

  読取り専用: true
• scm_branch: 文字列
  タイトル: Scm branch
• skip_tags: 文字列
  タイトル: Skip tags
• survey_enabled: 文字列
  タイトル: Survey enabled

  読取り専用: true
• timeout: 整数
  タイトル: Timeout
• variables_needed_to_start: 文字列
  タイトル: Variables needed to start

  読取り専用: true
• verbosity: 整数
  タイトル: Verbosity

  指定できる値: [ "0", "1", "2", "3", "4", "5" ]

{
    "properties":{
        "ask_credential_on_launch":{
            "readOnly":true,
            "title":"Ask credential on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_diff_mode_on_launch":{
            "readOnly":true,
            "title":"Ask diff mode on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_execution_environment_on_launch":{
            "readOnly":true,
            "title":"Ask execution environment on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_forks_on_launch":{
            "readOnly":true,
            "title":"Ask forks on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_instance_groups_on_launch":{
            "readOnly":true,
            "title":"Ask instance groups on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "readOnly":true,
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_slice_count_on_launch":{
            "readOnly":true,
            "title":"Ask job slice count on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_type_on_launch":{
            "readOnly":true,
            "title":"Ask job type on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "readOnly":true,
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "readOnly":true,
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "readOnly":true,
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "readOnly":true,
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "readOnly":true,
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_timeout_on_launch":{
            "readOnly":true,
            "title":"Ask timeout on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "readOnly":true,
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_verbosity_on_launch":{
            "readOnly":true,
            "title":"Ask verbosity on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "can_start_without_user_input":{
            "readOnly":true,
            "title":"Can start without user input",
            "type":"boolean"
        },
        "credential_needed_to_start":{
            "readOnly":true,
            "title":"Credential needed to start",
            "type":"string"
        },
        "credential_passwords":{
            "title":"Credential passwords",
            "type":"string"
        },
        "credentials":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "defaults":{
            "readOnly":true,
            "title":"Defaults",
            "type":"string"
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean"
        },
        "execution_environment":{
            "title":"Execution environment",
            "type":"integer"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"object"
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "instance_groups":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer"
        },
        "inventory_needed_to_start":{
            "readOnly":true,
            "title":"Inventory needed to start",
            "type":"string"
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string"
        },
        "job_template_data":{
            "readOnly":true,
            "title":"Job template data",
            "type":"string"
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string"
        },
        "labels":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "limit":{
            "title":"Limit",
            "type":"string"
        },
        "passwords_needed_to_start":{
            "readOnly":true,
            "title":"Passwords needed to start",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string"
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string"
        },
        "survey_enabled":{
            "readOnly":true,
            "title":"Survey enabled",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer"
        },
        "variables_needed_to_start":{
            "readOnly":true,
            "title":"Variables needed to start",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"integer"
        }
    },
    "type":"object"
}

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

型: array

一意のアイテムが必要: true

ソースを表示

• 配列: 整数

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

ネストされたスキーマ : Extra vars

型: object

タイトル: Extra vars

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

型: array

一意のアイテムが必要: true

ソースを表示

• 配列: 整数

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

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

型: array

一意のアイテムが必要: true

ソースを表示

• 配列: 整数

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

201レスポンス

本文()

ルート・スキーマ : JobLaunch

型: object

ソースを表示

• ask_credential_on_launch: ブール
  タイトル: Ask credential on launch

  読取り専用: true
• ask_diff_mode_on_launch: ブール
  タイトル: Ask diff mode on launch

  読取り専用: true
• ask_execution_environment_on_launch: ブール
  タイトル: Ask execution environment on launch

  読取り専用: true
• ask_forks_on_launch: ブール
  タイトル: Ask forks on launch

  読取り専用: true
• ask_instance_groups_on_launch: ブール
  タイトル: Ask instance groups on launch

  読取り専用: true
• ask_inventory_on_launch: ブール
  タイトル: Ask inventory on launch

  読取り専用: true
• ask_job_slice_count_on_launch: ブール
  タイトル: Ask job slice count on launch

  読取り専用: true
• ask_job_type_on_launch: ブール
  タイトル: Ask job type on launch

  読取り専用: true
• ask_labels_on_launch: ブール
  タイトル: Ask labels on launch

  読取り専用: true
• ask_limit_on_launch: ブール
  タイトル: Ask limit on launch

  読取り専用: true
• ask_scm_branch_on_launch: ブール
  タイトル: Ask scm branch on launch

  読取り専用: true
• ask_skip_tags_on_launch: ブール
  タイトル: Ask skip tags on launch

  読取り専用: true
• ask_tags_on_launch: ブール
  タイトル: Ask tags on launch

  読取り専用: true
• ask_timeout_on_launch: ブール
  タイトル: Ask timeout on launch

  読取り専用: true
• ask_variables_on_launch: ブール
  タイトル: Ask variables on launch

  読取り専用: true
• ask_verbosity_on_launch: ブール
  タイトル: Ask verbosity on launch

  読取り専用: true
• can_start_without_user_input: ブール
  タイトル: Can start without user input

  読取り専用: true
• credential_needed_to_start: 文字列
  タイトル: Credential needed to start

  読取り専用: true
• credential_passwords: 文字列
  タイトル: Credential passwords
• credentials: 配列 credentials
  一意のアイテムが必要: true
• defaults: 文字列
  タイトル: Defaults

  読取り専用: true
• diff_mode: ブール
  タイトル: Diff mode
• execution_environment: 整数
  タイトル: Execution environment
• extra_vars: オブジェクト Extra vars
  タイトル: Extra vars
• forks: 整数
  タイトル: Forks

  最小値: 0
• instance_groups: 配列 instance_groups
  一意のアイテムが必要: true
• inventory: 整数
  タイトル: Inventory
• inventory_needed_to_start: 文字列
  タイトル: Inventory needed to start

  読取り専用: true
• job_slice_count: 整数
  タイトル: Job slice count

  最小値: 0
• job_tags: 文字列
  タイトル: Job tags
• job_template_data: 文字列
  タイトル: Job template data

  読取り専用: true
• job_type: 文字列
  タイトル: Job type

  指定できる値: [ "run", "check" ]
• labels: 配列 labels
  一意のアイテムが必要: true
• limit: 文字列
  タイトル: Limit
• passwords_needed_to_start: 文字列
  タイトル: Passwords needed to start

  読取り専用: true
• scm_branch: 文字列
  タイトル: Scm branch
• skip_tags: 文字列
  タイトル: Skip tags
• survey_enabled: 文字列
  タイトル: Survey enabled

  読取り専用: true
• timeout: 整数
  タイトル: Timeout
• variables_needed_to_start: 文字列
  タイトル: Variables needed to start

  読取り専用: true
• verbosity: 整数
  タイトル: Verbosity

  指定できる値: [ "0", "1", "2", "3", "4", "5" ]

{
    "properties":{
        "ask_credential_on_launch":{
            "readOnly":true,
            "title":"Ask credential on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_diff_mode_on_launch":{
            "readOnly":true,
            "title":"Ask diff mode on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_execution_environment_on_launch":{
            "readOnly":true,
            "title":"Ask execution environment on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_forks_on_launch":{
            "readOnly":true,
            "title":"Ask forks on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_instance_groups_on_launch":{
            "readOnly":true,
            "title":"Ask instance groups on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_inventory_on_launch":{
            "readOnly":true,
            "title":"Ask inventory on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_slice_count_on_launch":{
            "readOnly":true,
            "title":"Ask job slice count on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_job_type_on_launch":{
            "readOnly":true,
            "title":"Ask job type on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_labels_on_launch":{
            "readOnly":true,
            "title":"Ask labels on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_limit_on_launch":{
            "readOnly":true,
            "title":"Ask limit on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_scm_branch_on_launch":{
            "readOnly":true,
            "title":"Ask scm branch on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_skip_tags_on_launch":{
            "readOnly":true,
            "title":"Ask skip tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_tags_on_launch":{
            "readOnly":true,
            "title":"Ask tags on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_timeout_on_launch":{
            "readOnly":true,
            "title":"Ask timeout on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_variables_on_launch":{
            "readOnly":true,
            "title":"Ask variables on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "ask_verbosity_on_launch":{
            "readOnly":true,
            "title":"Ask verbosity on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "can_start_without_user_input":{
            "readOnly":true,
            "title":"Can start without user input",
            "type":"boolean"
        },
        "credential_needed_to_start":{
            "readOnly":true,
            "title":"Credential needed to start",
            "type":"string"
        },
        "credential_passwords":{
            "title":"Credential passwords",
            "type":"string"
        },
        "credentials":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "defaults":{
            "readOnly":true,
            "title":"Defaults",
            "type":"string"
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean"
        },
        "execution_environment":{
            "title":"Execution environment",
            "type":"integer"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"object"
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "instance_groups":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer"
        },
        "inventory_needed_to_start":{
            "readOnly":true,
            "title":"Inventory needed to start",
            "type":"string"
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string"
        },
        "job_template_data":{
            "readOnly":true,
            "title":"Job template data",
            "type":"string"
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string"
        },
        "labels":{
            "items":{
                "type":"integer"
            },
            "type":"array",
            "uniqueItems":true
        },
        "limit":{
            "title":"Limit",
            "type":"string"
        },
        "passwords_needed_to_start":{
            "readOnly":true,
            "title":"Passwords needed to start",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string"
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string"
        },
        "survey_enabled":{
            "readOnly":true,
            "title":"Survey enabled",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer"
        },
        "variables_needed_to_start":{
            "readOnly":true,
            "title":"Variables needed to start",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"integer"
        }
    },
    "type":"object"
}

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

型: array

一意のアイテムが必要: true

ソースを表示

• 配列: 整数

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

ネストされたスキーマ : Extra vars

型: object

タイトル: Extra vars

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

型: array

一意のアイテムが必要: true

ソースを表示

• 配列: 整数

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

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

型: array

一意のアイテムが必要: true

ソースを表示

• 配列: 整数

{
    "items":{
        "type":"integer"
    },
    "type":"array",
    "uniqueItems":true
}

先頭に戻る