移動先

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

インベントリ更新の取得

get

/api/v2/inventory_updates/{id}/

このリソースに対してGETリクエストを行って、次のフィールドを含む単一のインベントリ更新レコードを取得します。

• id: このインベントリ更新のデータベースID。(整数)
• type: このインベントリ更新のデータ型。(選択)
• url: このインベントリ更新のURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: このインベントリ更新が作成されたときのタイムスタンプ。(日時)
• modified: このインベントリ更新が最後に変更されたときのタイムスタンプ。(日時)
• name: このインベントリ更新の名前。(文字列)
• description: このインベントリ更新のオプションの説明。(文字列)
• source: (選択)
  • file: ファイル、ディレクトリまたはスクリプト
  • constructed: 実行時の追加のグループとホスト変数用のテンプレート
  • scm: プロジェクトからのソーシング
  • ec2: Amazon EC2
  • gce: Google Compute Engine
  • azure_rm: Microsoft Azure Resource Manager
  • vmware: VMware vCenter
  • satellite6: Red Hat Satellite 6
  • openstack: OpenStack
  • rhv: Red Hat Virtualization
  • controller: Red Hat Ansible Automation Platform
  • insights: Red Hat Insights
• source_path: (文字列)
• source_vars: YAMLまたはJSON形式のインベントリ・ソース変数。(文字列)
• scm_branch: インベントリ・ソースのSCMブランチ。空白の場合に使用されるプロジェクトのデフォルト。プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。(文字列)
• credential: インベントリの更新に使用するクラウド資格証明。(整数)
• enabled_var: 対象となるホスト変数のディクショナリから有効状態を取得します。有効化された変数は「foo.bar」のように指定でき、この場合は、ネストされた辞書を横断してルックアップが行われ、from_dict.get("foo", {}).get("bar", default)と同等になります(文字列)
• enabled_value: enabled_varが設定されている場合にのみ使用されます。ホストが有効とみなされるときの値。たとえば、enabled_var="status.power_state"およびenabled_value="powered_on"でホスト変数{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}を使用すると、ホストが有効とマークされます。power_stateがpowered_on以外の値である場合、インポートされるときにホストは無効になります。キーが見つからない場合、ホストは有効になります(文字列)
• host_filter: このフィールドは非推奨であり、今後のリリースで削除される予定です。一致するホストのみがインポートされる正規表現。(文字列)
• overwrite: リモート・インベントリ・ソースからローカル・グループおよびホストを上書きします。(ブール)
• overwrite_vars: リモート・インベントリ・ソースからローカル変数を上書きします。(ブール)
• custom_virtualenv: (文字列)
• timeout: タスクが取り消されるまでの実行時間(秒)。(整数)
• verbosity: (選択)
  • 0: 0 (警告)
  • 1: 1 (情報)
  • 2: 2 (デバッグ)
• limit: ホスト、グループまたはパターン一致を入力します(文字列)
• unified_job_template: (id)
• launch_type: (選択)
  • manual: 手動
  • relaunch: 再起動
  • callback: コールバック
  • scheduled: スケジュール済
  • dependency: 依存性
  • workflow: ワークフロー
  • webhook: Webフック
  • sync: 同期
  • scm: SCM更新
• status: (選択)
  • new: 新規
  • pending: 保留中
  • waiting: 待機中
  • running: 実行中
  • successful: 成功
  • failed: 失敗
  • error: エラー
  • canceled: 取消し済
• execution_environment: 実行に使用されるコンテナ・イメージ。(id)
• failed: (ブール)
• started: ジョブが開始のためにキューに入れられた日時。(日時)
• finished: ジョブの実行が終了した日時。(日時)
• canceled_on: 取消しリクエストが送信された日時。(日時)
• elapsed: ジョブが実行された経過時間(秒)。(10進)
• job_args: (文字列)
• job_cwd: (文字列)
• job_env: (json)
• job_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)
• execution_node: ジョブが実行されたノード。(文字列)
• controller_node: 実行環境を管理していたインスタンス。(文字列)
• result_traceback: (文字列)
• event_processing_finished: この統合ジョブによって生成されたすべてのイベントがデータベースに保存されたかどうかを示します。(ブール)
• launched_by: (フィールド)
• work_unit_id: このジョブに関連付けられているレセプタの作業単位ID。(文字列)
• inventory: (id)
• inventory_source: (id)
• license_error: (ブール)
• org_host_limit_error: (ブール)
• source_project_update: このプロジェクト更新のインベントリ・ファイルがインベントリ更新に使用されました。(id)
• instance_group: ジョブが実行されたインスタンス・グループ(id)
• scm_revision: このインベントリの更新に使用される、プロジェクトのSCMリビジョン。SCMからのインベントリ・ソースにのみ適用可能(文字列)
• source_project: このジョブに使用されたプロジェクト。(フィールド)

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : InventoryUpdateDetail

型: object

ソースを表示

• canceled_on: 文字列(日付-時間)
  タイトル: Canceled on

  読取り専用: true

  取消しリクエストが送信された日時。
• controller_node: 文字列
  タイトル: Controller node

  読取り専用: true

  最小長: 1

  実行環境を管理していたインスタンス。
• created: 文字列
  タイトル: Created

  読取り専用: true
• credential: 整数
  タイトル: Credential

  最小値: 1

  インベントリ更新に使用するクラウド資格証明。
• custom_virtualenv: 文字列
  タイトル: Custom virtualenv

  読取り専用: true
• description: 文字列
  タイトル: Description
• elapsed: 文字列(10進)
  タイトル: Elapsed

  読取り専用: true

  ジョブが実行された経過時間(秒)。
• enabled_value: 文字列
  タイトル: Enabled value

  enabled_varが設定されている場合にのみ使用されます。ホストが有効とみなされるときの値。たとえば、enabled_var="status.power_state"およびenabled_value="powered_on"でホスト変数{ "status": { "power_state": "powered_on", "created": "2018-02-01T08:00:00.000000Z:00", "healthy": true }, "name": "foobar", "ip_address": "192.168.2.1"}を使用すると、ホストが有効とマークされます。power_stateがpowered_on以外の値である場合、インポートされるときにホストは無効になります。キーが見つからない場合、ホストは有効になります
• enabled_var: 文字列
  タイトル: Enabled var

  対象となるホスト変数の辞書から有効状態を取得します。有効化された変数は「foo.bar」のように指定でき、この場合は、ネストされた辞書を横断してルックアップが行われ、from_dict.get("foo", {}).get("bar", default)と同等になります
• event_processing_finished: ブール
  タイトル: Event processing finished

  読取り専用: true

  この統合ジョブによって生成されたすべてのイベントがデータベースに保存されたかどうかを示します。
• execution_environment: 整数
  タイトル: Execution environment

  実行に使用されるコンテナ・イメージ。
• execution_node: 文字列
  タイトル: Execution node

  読取り専用: true

  最小長: 1

  ジョブが実行されるノード。
• failed: ブール
  タイトル: Failed

  読取り専用: true
• finished: 文字列(日付-時間)
  タイトル: Finished

  読取り専用: true

  ジョブの実行が終了たした日時。
• host_filter: 文字列
  タイトル: Host filter

  このフィールドは非推奨であり、今後のリリースで削除される予定です。一致するホストのみがインポートされる正規表現。
• id: 整数
  タイトル: ID

  読取り専用: true
• instance_group: 整数
  タイトル: Instance group

  ジョブが実行されたインスタンス・グループ
• inventory: 整数
  タイトル: Inventory
• inventory_source: 文字列
  タイトル: Inventory source

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

  読取り専用: true

  最小長: 1
• job_cwd: 文字列
  タイトル: Job cwd

  読取り専用: true

  最小長: 1
• job_env: オブジェクト job_env
  タイトル: job_env

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

  読取り専用: true

  最小長: 1

  ジョブを実行できず、stdoutを取得できなかった場合に、そのジョブの状態を示すステータス・フィールド(文字列)
• launch_type: 文字列
  タイトル: Launch type

  読取り専用: true

  指定できる値: [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
• launched_by: 文字列
  タイトル: Launched by

  読取り専用: true
• license_error: ブール
  タイトル: License error

  読取り専用: true
• limit: 文字列
  タイトル: Limit

  ホスト、グループまたはパターン一致を入力します
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• org_host_limit_error: ブール
  タイトル: Org host limit error

  読取り専用: true
• overwrite: ブール
  タイトル: Overwrite

  リモート・インベントリ・ソースからローカル・グループおよびホストを上書きします。
• overwrite_vars: ブール
  タイトル: Overwrite vars

  リモート・インベントリ・ソースからローカル変数を上書きします。
• related: 文字列
  タイトル: Related

  読取り専用: true
• result_traceback: 文字列
  タイトル: Result traceback

  読取り専用: true

  最小長: 1
• scm_branch: 文字列
  タイトル: Scm branch

  最大長: 1024

  インベントリ・ソースのSCMブランチ。空白の場合に使用されるプロジェクトのデフォルト。プロジェクトのallow_overrideフィールドがtrueに設定されている場合にのみ許可されます。
• scm_revision: 文字列
  タイトル: SCM Revision

  読取り専用: true

  最小長: 1

  このインベントリの更新に使用される、プロジェクトのSCMリビジョン。SCMからのインベントリ・ソースにのみ適用可能
• source: 文字列
  タイトル: Source

  指定できる値: [ "file", "constructed", "scm", "ec2", "gce", "azure_rm", "vmware", "satellite6", "openstack", "rhv", "controller", "insights" ]
• source_path: 文字列
  タイトル: Source path

  最大長: 1024
• source_project: 文字列
  タイトル: Source project

  読取り専用: true

  このジョブに使用されたプロジェクト。
• source_project_update: 文字列
  タイトル: Source project update

  このプロジェクト更新のインベントリ・ファイルがインベントリ更新に使用されました。
• source_vars: 文字列
  タイトル: Source vars

  YAMLまたはJSON形式のインベントリ・ソース変数。
• started: 文字列(日付-時間)
  タイトル: Started

  読取り専用: true

  ジョブが開始のためにキューに入れられた日時。
• status: 文字列
  タイトル: Status

  読取り専用: true

  指定できる値: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• timeout: 整数
  タイトル: Timeout

  タスクが取り消されるまでの実行時間(秒)。
• type: 文字列
  タイトル: Type

  読取り専用: true
• unified_job_template: 文字列
  タイトル: unified job template

  読取り専用: true
• url: 文字列
  タイトル: Url

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

  デフォルト値: 1

  指定できる値: [ "0", "1", "2" ]
• work_unit_id: 文字列
  タイトル: Work unit id

  読取り専用: true

  最小長: 1

  このジョブに関連付けられているレセプタの作業単位ID。

{
    "properties":{
        "canceled_on":{
            "description":"The date and time when the cancel request was sent.",
            "format":"date-time",
            "readOnly":true,
            "title":"Canceled on",
            "type":"string",
            "x-nullable":true
        },
        "controller_node":{
            "description":"The instance that managed the execution environment.",
            "minLength":"1",
            "readOnly":true,
            "title":"Controller node",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "description":"Cloud credential to use for inventory updates.",
            "minimum":"1",
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "custom_virtualenv":{
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "enabled_value":{
            "description":"Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var=\"status.power_state\"and enabled_value=\"powered_on\" with host variables:{   \"status\": {     \"power_state\": \"powered_on\",     \"created\": \"2018-02-01T08:00:00.000000Z:00\",     \"healthy\": true    },    \"name\": \"foobar\",    \"ip_address\": \"192.168.2.1\"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled",
            "title":"Enabled value",
            "type":"string",
            "x-nullable":true
        },
        "enabled_var":{
            "description":"Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as \"foo.bar\", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get(\"foo\", {}).get(\"bar\", default)",
            "title":"Enabled var",
            "type":"string",
            "x-nullable":true
        },
        "event_processing_finished":{
            "description":"Indicates whether all of the events generated by this unified job have been saved to the database.",
            "readOnly":true,
            "title":"Event processing finished",
            "type":"boolean"
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "execution_node":{
            "description":"The node the job executed on.",
            "minLength":"1",
            "readOnly":true,
            "title":"Execution node",
            "type":"string"
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "finished":{
            "description":"The date and time the job finished execution.",
            "format":"date-time",
            "readOnly":true,
            "title":"Finished",
            "type":"string",
            "x-nullable":true
        },
        "host_filter":{
            "description":"This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.",
            "title":"Host filter",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "instance_group":{
            "description":"The Instance group the job was run under",
            "title":"Instance group",
            "type":"integer",
            "x-nullable":true
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "inventory_source":{
            "readOnly":true,
            "title":"Inventory source",
            "type":"string"
        },
        "job_args":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job args",
            "type":"string"
        },
        "job_cwd":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job cwd",
            "type":"string"
        },
        "job_env":{
            "readOnly":true,
            "title":"job_env",
            "type":"object"
        },
        "job_explanation":{
            "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout",
            "minLength":"1",
            "readOnly":true,
            "title":"Job explanation",
            "type":"string"
        },
        "launch_type":{
            "enum":[
                "manual",
                "relaunch",
                "callback",
                "scheduled",
                "dependency",
                "workflow",
                "webhook",
                "sync",
                "scm"
            ],
            "readOnly":true,
            "title":"Launch type",
            "type":"string"
        },
        "launched_by":{
            "readOnly":true,
            "title":"Launched by",
            "type":"string"
        },
        "license_error":{
            "readOnly":true,
            "title":"License error",
            "type":"boolean"
        },
        "limit":{
            "description":"Enter host, group or pattern match",
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "org_host_limit_error":{
            "readOnly":true,
            "title":"Org host limit error",
            "type":"boolean"
        },
        "overwrite":{
            "description":"Overwrite local groups and hosts from remote inventory source.",
            "title":"Overwrite",
            "type":"boolean",
            "x-nullable":true
        },
        "overwrite_vars":{
            "description":"Overwrite local variables from remote inventory source.",
            "title":"Overwrite vars",
            "type":"boolean",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "result_traceback":{
            "minLength":"1",
            "readOnly":true,
            "title":"Result traceback",
            "type":"string"
        },
        "scm_branch":{
            "description":"Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.",
            "maxLength":"1024",
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "scm_revision":{
            "description":"The SCM Revision from the Project used for this inventory update.  Only applicable to inventories source from scm",
            "minLength":"1",
            "readOnly":true,
            "title":"SCM Revision",
            "type":"string"
        },
        "source":{
            "enum":[
                "file",
                "constructed",
                "scm",
                "ec2",
                "gce",
                "azure_rm",
                "vmware",
                "satellite6",
                "openstack",
                "rhv",
                "controller",
                "insights"
            ],
            "title":"Source",
            "type":"string",
            "x-nullable":true
        },
        "source_path":{
            "maxLength":"1024",
            "title":"Source path",
            "type":"string",
            "x-nullable":true
        },
        "source_project":{
            "description":"The project used for this job.",
            "readOnly":true,
            "title":"Source project",
            "type":"string"
        },
        "source_project_update":{
            "description":"Inventory files from this Project Update were used for the inventory update.",
            "title":"Source project update",
            "type":"string",
            "x-nullable":true
        },
        "source_vars":{
            "description":"Inventory source variables in YAML or JSON format.",
            "title":"Source vars",
            "type":"string",
            "x-nullable":true
        },
        "started":{
            "description":"The date and time the job was queued for starting.",
            "format":"date-time",
            "readOnly":true,
            "title":"Started",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "title":"Timeout",
            "type":"integer"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "readOnly":true,
            "title":"unified job template",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "default":"1",
            "enum":[
                "0",
                "1",
                "2"
            ],
            "title":"Verbosity",
            "type":"integer"
        },
        "work_unit_id":{
            "description":"The Receptor work unit ID associated with this job.",
            "minLength":"1",
            "readOnly":true,
            "title":"Work unit id",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

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

型: object

タイトル: job_env

読取り専用: true

先頭に戻る