機械翻訳について

移動先

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

ジョブの一括起動

get

/api/v2/bulk/job_launch/

このエンドポイントにより、クライアントは、起動時に通常設定される起動時パラメータとともに、一度に複数のUnifiedJobTemplatesを起動できます。

リクエスト

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

• application/json

問合せパラメータ

• page: integer
  ページ区切り結果セット内のページ番号。
• page_size: integer
  ページ当たりに返す結果の数。
• search: string
  検索条件。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/BulkJobLaunch"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• Array of: object BulkJobLaunch

{
    "items":{
        "$ref":"#/definitions/BulkJobLaunch"
    },
    "type":"array"
}

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

型: object

ソースを表示

• description: string
  タイトル: Description

  最小長: 1
• extra_vars: object Extra vars
  タイトル: Extra vars
• inventory: integer
  タイトル: Inventory
• job_tags: string
  タイトル: Job tags

  最小長: 1
• jobs(required): array jobs
  起動するジョブのリスト(JSONなど)。[{"unified_job_template": 7}, {"unified_job_template": 10}]
• limit: string
  タイトル: Limit

  最小長: 1
• name: string
  タイトル: Name

  最大長: 512

  デフォルト値: Bulk Job Launch
• organization: integer
  タイトル: Organization

  この組織から権限を継承します。 指定しない場合、ユーザーがメンバーである組織は自動的に選択されます。
• scm_branch: string
  タイトル: Scm branch

  最小長: 1
• skip_tags: string
  タイトル: Skip tags

  最小長: 1

{
    "properties":{
        "description":{
            "minLength":"1",
            "title":"Description",
            "type":"string"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"object"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer"
        },
        "job_tags":{
            "minLength":"1",
            "title":"Job tags",
            "type":"string"
        },
        "jobs":{
            "description":"List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]",
            "items":{
                "$ref":"#/definitions/BulkJobNode"
            },
            "type":"array"
        },
        "limit":{
            "minLength":"1",
            "title":"Limit",
            "type":"string"
        },
        "name":{
            "default":"Bulk Job Launch",
            "maxLength":"512",
            "title":"Name",
            "type":"string"
        },
        "organization":{
            "description":"Inherit permissions from this organization. If not provided, a organization the user is a member of will be selected automatically.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "scm_branch":{
            "minLength":"1",
            "title":"Scm branch",
            "type":"string"
        },
        "skip_tags":{
            "minLength":"1",
            "title":"Skip tags",
            "type":"string"
        }
    },
    "required":[
        "jobs"
    ],
    "type":"object"
}

ネストされたスキーマ : 追加バー

型: object

タイトル: Extra vars

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

型: array

起動するジョブのリスト(JSONなど)。[{"unified_job_template": 7}, {"unified_job_template": 10}]

ソースを表示

• Array of: object BulkJobNode
  起動するジョブのリスト(JSONなど)。[{"unified_job_template": 7}, {"unified_job_template": 10}]

{
    "description":"List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]",
    "items":{
        "$ref":"#/definitions/BulkJobNode"
    },
    "type":"array"
}

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

型: object

起動するジョブのリスト(JSONなど)。[{"unified_job_template": 7}, {"unified_job_template": 10}]

ソースを表示

• all_parents_must_converge: boolean
  タイトル: All parents must converge

  有効にすると、すべての親ノードがこのノードに到達するための基準を満たしている場合にのみノードが実行されます
• always_nodes: array always_nodes
  読取り専用: true

  一意のアイテムが必要: true
• created: string
  タイトル: Created

  読取り専用: true
• credentials: array credentials
• diff_mode: boolean
  タイトル: Diff mode
• do_not_run: boolean
  タイトル: Do not run

  Trueの場合、ジョブが作成されないことを示します。 ワークフロー・ランタイム・セマンティクスでは、ノードが実行されないことが決定されたパスにある場合、このTrueがマークされます。 Falseの値は、ノードが実行されないことを意味します。
• execution_environment: integer
  タイトル: Execution environment

  最小値: 1
• extra_data: object Extra data
  タイトル: Extra data
• failure_nodes: array failure_nodes
  読取り専用: true

  一意のアイテムが必要: true
• forks: integer
  タイトル: Forks

  最小値: 0
• id: integer
  タイトル: ID

  読取り専用: true
• identifier: string
  タイトル: Identifier

  最大長: 512

  このノードの作成元となったワークフロー・ジョブ・テンプレート・ノードへの識別子コアスポンディング。
• instance_groups: array instance_groups
• inventory: integer
  タイトル: Inventory

  最小値: 1
• job: integer
  タイトル: Job
• job_slice_count: integer
  タイトル: Job slice count

  最小値: 0
• job_tags: string
  タイトル: Job tags
• job_type: string
  タイトル: Job type

  指定できる値: [ "run", "check" ]
• labels: array labels
• limit: string
  タイトル: Limit
• modified: string
  タイトル: Modified

  読取り専用: true
• related: string
  タイトル: Related

  読取り専用: true
• scm_branch: string
  タイトル: Scm branch
• skip_tags: string
  タイトル: Skip tags
• success_nodes: array success_nodes
  読取り専用: true

  一意のアイテムが必要: true
• summary_fields: string
  タイトル: Summary fields

  読取り専用: true
• timeout: integer
  タイトル: Timeout
• type: string
  タイトル: Type

  読取り専用: true
• unified_job_template(required): integer
  タイトル: Unified job template

  最小値: 1

  このジョブのテンプレートの主キーは、ジョブ・テンプレートまたは在庫ソースにできます。
• url: string
  タイトル: Url

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

  指定できる値: [ "0", "1", "2", "3", "4", "5" ]
• workflow_job: string
  タイトル: Workflow job

{
    "description":"List of jobs to be launched, JSON. e.g. [{\"unified_job_template\": 7}, {\"unified_job_template\": 10}]",
    "properties":{
        "all_parents_must_converge":{
            "description":"If enabled then the node will only run if all of the parent nodes have met the criteria to reach this node",
            "title":"All parents must converge",
            "type":"boolean",
            "x-nullable":true
        },
        "always_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credentials":{
            "items":{
                "minimum":"1",
                "type":"integer"
            },
            "type":"array"
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "do_not_run":{
            "description":"Indicates that a job will not be created when True. Workflow runtime semantics will mark this True if the node is in a path that will decidedly not be ran. A value of False means the node may not run.",
            "title":"Do not run",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "minimum":"1",
            "title":"Execution environment",
            "type":"integer"
        },
        "extra_data":{
            "title":"Extra data",
            "type":"object"
        },
        "failure_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "identifier":{
            "description":"An identifier coresponding to the workflow job template node that this node was created from.",
            "maxLength":"512",
            "title":"Identifier",
            "type":"string",
            "x-nullable":true
        },
        "instance_groups":{
            "items":{
                "minimum":"1",
                "type":"integer"
            },
            "type":"array"
        },
        "inventory":{
            "minimum":"1",
            "title":"Inventory",
            "type":"integer"
        },
        "job":{
            "title":"Job",
            "type":"integer",
            "x-nullable":true
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "labels":{
            "items":{
                "minimum":"1",
                "type":"integer"
            },
            "type":"array"
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "success_nodes":{
            "items":{
                "type":"integer"
            },
            "readOnly":true,
            "type":"array",
            "uniqueItems":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "description":"Primary key of the template for this job, can be a job template or inventory source.",
            "minimum":"1",
            "title":"Unified job template",
            "type":"integer"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"string",
            "x-nullable":true
        },
        "workflow_job":{
            "title":"Workflow job",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "unified_job_template"
    ],
    "type":"object"
}

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

型: array

読取り専用: true

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

ソースを表示

• 配列: integer

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

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

型: array

ソースを表示

• 配列: integer
  最小値: 1

{
    "items":{
        "minimum":"1",
        "type":"integer"
    },
    "type":"array"
}

ネストされたスキーマ : 追加データ

型: object

タイトル: Extra data

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

型: array

読取り専用: true

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

ソースを表示

• 配列: integer

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

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

型: array

ソースを表示

• 配列: integer
  最小値: 1

{
    "items":{
        "minimum":"1",
        "type":"integer"
    },
    "type":"array"
}

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

型: array

ソースを表示

• 配列: integer
  最小値: 1

{
    "items":{
        "minimum":"1",
        "type":"integer"
    },
    "type":"array"
}

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

型: array

読取り専用: true

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

ソースを表示

• 配列: integer

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

先頭に戻る