Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

バルク・ジョブの起動

post

/api/v2/bulk/job_launch/

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

リクエスト

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

application/json

ルート・スキーマ : BulkJobLaunch

型: object

ソースを表示

description: 文字列

タイトル: Description

最小長: 1
extra_vars: オブジェクト Extra vars

タイトル: Extra vars
inventory: 整数

タイトル: Inventory
job_tags: 文字列

タイトル: Job tags

最小長: 1
jobs(必須): 配列 jobs

起動するジョブのリスト、JSON。例: [{"unified_job_template": 7}, {"unified_job_template": 10}]
limit: 文字列

タイトル: Limit

最小長: 1
name: 文字列

タイトル: Name

最大長: 512

デフォルト値: Bulk Job Launch
organization: 整数

タイトル: Organization

この組織から権限を継承します。指定しない場合、ユーザーがメンバーである組織が自動的に選択されます。
scm_branch: 文字列

タイトル: Scm branch

最小長: 1
skip_tags: 文字列

タイトル: 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"
}

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

型: object

タイトル: Extra vars

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

型: array

起動するジョブのリスト、JSON。例: [{"unified_job_template": 7}, {"unified_job_template": 10}]

ソースを表示

配列: オブジェクト 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: ブール

タイトル: All parents must converge

有効にした場合、すべての親ノードがこのノードにアクセスするための基準を満たしている場合にのみノードが実行されます
always_nodes: 配列 always_nodes

読取り専用: true

一意のアイテムが必要: true
created: 文字列

タイトル: Created

読取り専用: true
credentials: 配列 credentials
diff_mode: ブール

タイトル: Diff mode
do_not_run: ブール

タイトル: Do not run

Trueの場合、ジョブが作成されないことを示します。ノードが明らかに実行されないパスにある場合、ワークフロー・ランタイム・セマンティクスはこれをTrueとマークします。値Falseは、ノードが実行されないことを意味します。
execution_environment: 整数

タイトル: Execution environment

最小値: 1
extra_data: オブジェクト Extra data

タイトル: Extra data
failure_nodes: 配列 failure_nodes

読取り専用: true

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

タイトル: Forks

最小値: 0
id: 整数

タイトル: ID

読取り専用: true
identifier: 文字列

タイトル: Identifier

最大長: 512

このノードの作成元のワークフロー・ジョブ・テンプレート・ノードに対応する識別子。
instance_groups: 配列 instance_groups
inventory: 整数

タイトル: Inventory

最小値: 1
job: 整数

タイトル: Job
job_slice_count: 整数

タイトル: Job slice count

最小値: 0
job_tags: 文字列

タイトル: Job tags
job_type: 文字列

タイトル: Job type

指定できる値: [ "run", "check" ]
labels: 配列 labels
limit: 文字列

タイトル: Limit
modified: 文字列

タイトル: Modified

読取り専用: true
related: 文字列

タイトル: Related

読取り専用: true
scm_branch: 文字列

タイトル: Scm branch
skip_tags: 文字列

タイトル: Skip tags
success_nodes: 配列 success_nodes

読取り専用: true

一意のアイテムが必要: true
summary_fields: 文字列

タイトル: Summary fields

読取り専用: true
timeout: 整数

タイトル: Timeout
type: 文字列

タイトル: Type

読取り専用: true
unified_job_template(必須): 整数

タイトル: Unified job template

最小値: 1

このジョブのテンプレート(ジョブ・テンプレートまたはインベントリ・ソースの場合がある)の主キー。
url: 文字列

タイトル: Url

読取り専用: true
verbosity: 文字列

タイトル: Verbosity

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

タイトル: 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

ソースを表示

配列: 整数

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

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

型: array

ソースを表示

配列: 整数

最小値: 1

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

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

型: object

タイトル: Extra data

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

型: array

読取り専用: true

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

ソースを表示

配列: 整数

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

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

型: array

ソースを表示

配列: 整数

最小値: 1

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

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

型: array

ソースを表示

配列: 整数

最小値: 1

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

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

型: array

読取り専用: true

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

ソースを表示

配列: 整数

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

先頭に戻る

レスポンス

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

application/json

201レスポンス

ルート・スキーマ : BulkJobLaunch

型: object

ソースを表示

description: 文字列

タイトル: Description

最小長: 1
extra_vars: オブジェクト Extra vars

タイトル: Extra vars
inventory: 整数

タイトル: Inventory
job_tags: 文字列

タイトル: Job tags

最小長: 1
jobs(必須): 配列 jobs

起動するジョブのリスト、JSON。例: [{"unified_job_template": 7}, {"unified_job_template": 10}]
limit: 文字列

タイトル: Limit

最小長: 1
name: 文字列

タイトル: Name

最大長: 512

デフォルト値: Bulk Job Launch
organization: 整数

タイトル: Organization

この組織から権限を継承します。指定しない場合、ユーザーがメンバーである組織が自動的に選択されます。
scm_branch: 文字列

タイトル: Scm branch

最小長: 1
skip_tags: 文字列

タイトル: 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"
}

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

型: object

タイトル: Extra vars

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

型: array

起動するジョブのリスト、JSON。例: [{"unified_job_template": 7}, {"unified_job_template": 10}]

ソースを表示

配列: オブジェクト 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: ブール

タイトル: All parents must converge

有効にした場合、すべての親ノードがこのノードにアクセスするための基準を満たしている場合にのみノードが実行されます
always_nodes: 配列 always_nodes

読取り専用: true

一意のアイテムが必要: true
created: 文字列

タイトル: Created

読取り専用: true
credentials: 配列 credentials
diff_mode: ブール

タイトル: Diff mode
do_not_run: ブール

タイトル: Do not run

Trueの場合、ジョブが作成されないことを示します。ノードが明らかに実行されないパスにある場合、ワークフロー・ランタイム・セマンティクスはこれをTrueとマークします。値Falseは、ノードが実行されないことを意味します。
execution_environment: 整数

タイトル: Execution environment

最小値: 1
extra_data: オブジェクト Extra data

タイトル: Extra data
failure_nodes: 配列 failure_nodes

読取り専用: true

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

タイトル: Forks

最小値: 0
id: 整数

タイトル: ID

読取り専用: true
identifier: 文字列

タイトル: Identifier

最大長: 512

このノードの作成元のワークフロー・ジョブ・テンプレート・ノードに対応する識別子。
instance_groups: 配列 instance_groups
inventory: 整数

タイトル: Inventory

最小値: 1
job: 整数

タイトル: Job
job_slice_count: 整数

タイトル: Job slice count

最小値: 0
job_tags: 文字列

タイトル: Job tags
job_type: 文字列

タイトル: Job type

指定できる値: [ "run", "check" ]
labels: 配列 labels
limit: 文字列

タイトル: Limit
modified: 文字列

タイトル: Modified

読取り専用: true
related: 文字列

タイトル: Related

読取り専用: true
scm_branch: 文字列

タイトル: Scm branch
skip_tags: 文字列

タイトル: Skip tags
success_nodes: 配列 success_nodes

読取り専用: true

一意のアイテムが必要: true
summary_fields: 文字列

タイトル: Summary fields

読取り専用: true
timeout: 整数

タイトル: Timeout
type: 文字列

タイトル: Type

読取り専用: true
unified_job_template(必須): 整数

タイトル: Unified job template

最小値: 1

このジョブのテンプレート(ジョブ・テンプレートまたはインベントリ・ソースの場合がある)の主キー。
url: 文字列

タイトル: Url

読取り専用: true
verbosity: 文字列

タイトル: Verbosity

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

タイトル: 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

ソースを表示

配列: 整数

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

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

型: array

ソースを表示

配列: 整数

最小値: 1

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

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

型: object

タイトル: Extra data

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

型: array

読取り専用: true

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

ソースを表示

配列: 整数

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

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

型: array

ソースを表示

配列: 整数

最小値: 1

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

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

型: array

ソースを表示

配列: 整数

最小値: 1

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

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

型: array

読取り専用: true

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

ソースを表示

配列: 整数

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

先頭に戻る