機械翻訳について

移動先

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

アドホック・コマンドの取得

get

/api/v2/ad_hoc_commands/{id}/

このリソースに対してGETリクエストを行って、次のフィールドを含む単一のアドホック・コマンド・レコードを取得します。

• id: このアドホック・コマンドのデータベースID。(整数)
• type: このアドホック・コマンドのデータ型。(選択)
• url: このアドホック・コマンドのURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: このアドホック・コマンドが作成されたときのタイムスタンプ。(日時)
• modified: このアドホック・コマンドが最後に変更されたときのタイムスタンプ。(日時)
• name: このアドホック・コマンドの名前。(文字列)
• 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。(文字列)
• job_type: (選択)
  • run: 実行
  • check: チェック
• inventory: (id)
• limit: (文字列)
• credential: (id)
• module_name: (選択)
  • command
  • shell
  • yum
  • apt
  • apt_key
  • apt_repository
  • apt_rpm
  • service
  • group
  • user
  • mount
  • ping
  • selinux
  • setup
  • win_ping
  • win_service
  • win_updates
  • win_group
  • win_user
• module_args: (文字列)
• forks: (整数)
• verbosity: (選択)
  • 0: 0 (標準)
  • 1: 1 (詳細)
  • 2: 2 (より詳細)
  • 3: 3 (デバッグ)
  • 4: 4 (接続デバッグ)
  • 5: 5 (WinRMデバッグ)
• extra_vars: (文字列)
• become_enabled: (ブール)
• diff_mode: (ブール)
• host_status_counts: Ansible playbook_on_statsイベントからのPlaybook統計。(json)

リクエスト

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

• application/json

パス・パラメータ

• id(required): string

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : AdHocCommandDetail

型: object

ソースを表示

• become_enabled: boolean
  タイトル: Become enabled
• canceled_on: string(date-time)
  タイトル: Canceled on

  読取り専用: true

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

  読取り専用: true

  最小長: 1

  実行環境を管理したインスタンス。
• created: string
  タイトル: Created

  読取り専用: true
• credential: integer
  タイトル: Credential
• diff_mode: boolean
  タイトル: Diff mode
• elapsed: string(decimal)
  タイトル: Elapsed

  読取り専用: true

  ジョブが実行された経過時間(秒)。
• event_processing_finished: boolean
  タイトル: Event processing finished

  読取り専用: true

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

  実行に使用するコンテナ・イメージ。
• execution_node: string
  タイトル: Execution node

  読取り専用: true

  最小長: 1

  ジョブが実行されたノード。
• extra_vars: string
  タイトル: Extra vars
• failed: boolean
  タイトル: Failed

  読取り専用: true
• finished: string(date-time)
  タイトル: Finished

  読取り専用: true

  ジョブの実行が終了した日時。
• forks: integer
  タイトル: Forks

  最小値: 0
• host_status_counts: object Host status counts
  タイトル: Host status counts

  読取り専用: true

  Ansible playbook_on_statsイベントからのPlaybook統計。
• id: integer
  タイトル: ID

  読取り専用: true
• inventory: integer
  タイトル: Inventory
• job_args: string
  タイトル: Job args

  読取り専用: true

  最小長: 1
• job_cwd: string
  タイトル: Job cwd

  読取り専用: true

  最小長: 1
• job_env: object Job env
  タイトル: Job env

  読取り専用: true
• job_explanation: string
  タイトル: Job explanation

  読取り専用: true

  最小長: 1

  ジョブが実行および取得できなかった場合にジョブの状態を示すステータス・フィールド
• job_type: string
  タイトル: Job type

  デフォルト値: run

  指定できる値: [ "run", "check" ]
• launch_type: string
  タイトル: Launch type

  読取り専用: true

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

  読取り専用: true
• limit: string
  タイトル: Limit
• modified: string
  タイトル: Modified

  読取り専用: true
• module_args: string
  タイトル: Module args
• module_name: string
  タイトル: Module name

  デフォルト値: command

  指定できる値: [ "command", "shell", "yum", "apt", "apt_key", "apt_repository", "apt_rpm", "service", "group", "user", "mount", "ping", "selinux", "setup", "win_ping", "win_service", "win_updates", "win_group", "win_user" ]
• name: string
  タイトル: Name

  読取り専用: true

  最小長: 1
• related: string
  タイトル: Related

  読取り専用: true
• result_traceback: string
  タイトル: Result traceback

  読取り専用: true

  最小長: 1
• started: string(date-time)
  タイトル: Started

  読取り専用: true

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

  読取り専用: true

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

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

  読取り専用: true
• url: string
  タイトル: Url

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

  指定できる値: [ "0", "1", "2", "3", "4", "5" ]
• work_unit_id: string
  タイトル: Work unit id

  読取り専用: true

  最小長: 1

  このジョブに関連付けられた受容体作業ユニットID。

{
    "properties":{
        "become_enabled":{
            "title":"Become enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "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":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "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"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "x-nullable":true
        },
        "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
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer"
        },
        "host_status_counts":{
            "description":"Playbook stats from the Ansible playbook_on_stats event.",
            "readOnly":true,
            "title":"Host status counts",
            "type":"object",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "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"
        },
        "job_type":{
            "default":"run",
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "module_args":{
            "title":"Module args",
            "type":"string",
            "x-nullable":true
        },
        "module_name":{
            "default":"command",
            "enum":[
                "command",
                "shell",
                "yum",
                "apt",
                "apt_key",
                "apt_repository",
                "apt_rpm",
                "service",
                "group",
                "user",
                "mount",
                "ping",
                "selinux",
                "setup",
                "win_ping",
                "win_service",
                "win_updates",
                "win_group",
                "win_user"
            ],
            "title":"Module name",
            "type":"string"
        },
        "name":{
            "minLength":"1",
            "readOnly":true,
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "result_traceback":{
            "minLength":"1",
            "readOnly":true,
            "title":"Result traceback",
            "type":"string"
        },
        "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"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "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
        }
    },
    "type":"object"
}

ネストされたスキーマ : ホスト・ステータス数

型: object

タイトル: Host status counts

読取り専用: true

Ansible playbook_on_statsイベントからのPlaybook統計。

ネストされたスキーマ : ジョブ環境

型: object

タイトル: Job env

読取り専用: true

先頭に戻る