機械翻訳について

移動先

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

システム・ジョブの取得

get

/api/v2/system_jobs/{id}/

このリソースに対してGETリクエストを行って、次のフィールドを含む単一のシステム・ジョブ・レコードを取得します。

• id: このシステム・ジョブのデータベースID。(整数)
• type: このシステム・ジョブのデータ型。(選択)
• url: このシステム・ジョブのURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: このシステム・ジョブが作成されたときのタイムスタンプ。(日時)
• modified: このシステム・ジョブが最後に変更されたときのタイムスタンプ。(日時)
• name: このシステム・ジョブの名前。(文字列)
• description: このシステム・ジョブのオプションの説明。(文字列)
• 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: ジョブが実行されたノード。(文字列)
• result_traceback: (文字列)
• event_processing_finished: この統合ジョブによって生成されたすべてのイベントがデータベースに保存されたかどうかを示します。(ブール)
• launched_by: (フィールド)
• work_unit_id: このジョブに関連付けられた受信者作業ユニットID。(文字列)
• system_job_template: (id)
• job_type: (選択)
  • "": ---------
  • cleanup_jobs: 特定の日数より前のジョブを削除します
  • cleanup_activitystream: 特定の日数より前のアクティビティ・ストリーム・エントリを削除します
  • cleanup_sessions: 期限切れのブラウザ・セッションをデータベースから削除します
  • cleanup_tokens: 期限切れのOAuth 2アクセス・トークンおよびリフレッシュ・トークンを削除します
• extra_vars: (文字列)
• result_stdout: (フィールド)

リクエスト

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

• application/json

パス・パラメータ

• id(required): string

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : SystemJob

型: object

ソースを表示

• canceled_on: string(date-time)
  タイトル: Canceled on

  読取り専用: true

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

  読取り専用: true
• description: string
  タイトル: Description
• 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

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

  読取り専用: true
• 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

  指定できる値: [ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens" ]
• launch_type: string
  タイトル: Launch type

  読取り専用: true

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

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

  読取り専用: true
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 512
• related: string
  タイトル: Related

  読取り専用: true
• result_stdout: string
  タイトル: Result stdout

  読取り専用: 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
• system_job_template: string
  タイトル: System job template
• type: string
  タイトル: Type

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

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

  読取り専用: true
• work_unit_id: string
  タイトル: 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
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "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"
        },
        "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
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "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":{
            "enum":[
                "cleanup_jobs",
                "cleanup_activitystream",
                "cleanup_sessions",
                "cleanup_tokens"
            ],
            "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"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "result_stdout":{
            "readOnly":true,
            "title":"Result stdout",
            "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"
        },
        "system_job_template":{
            "title":"System job template",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "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

先頭に戻る