Documentation

システムジョブリストの API エンドポイント

このリソースに GET リクエストを実行して、システムジョブリストを取得します。

GET /api/v1/system_jobs/
HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, POST, HEAD, OPTIONS
X-API-Time: 0.049s

返されるデータ構造には以下のものが含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

count フィールドはクエリーで見つかったシステムジョブの合計数を示します。next および previous フィールドは、単一ページに収まらない結果がある場合に、それらの結果へのリンクを提供します。results にはシステムジョブレコードが一覧表示されますが、ゼロの場合もあります。

結果

各システムジョブデータ構造には以下のフィールドが含まれます。

  • id: システムジョブのデータベース ID (整数)
  • type: システムジョブのデータタイプ (複数選択)
    • system_job: 管理ジョブ
  • url: システムジョブの URL (文字列)
  • related: 関連リソースの URL のあるデータ構造 (オブジェクト)
  • summary_fields: 関連リソースの名前/説明のあるデータ構造 (オブジェクト)
  • created: システムジョブ作成時のタイムスタンプ (日時)
  • modified: システムジョブの最終更新時のタイムスタンプ (日時)
  • name: (文字列)
  • description: (文字列)
  • unified_job_template: (フィールド)
  • launch_type: (複数選択)
    • manual: 手動
    • callback: コールバック
    • scheduled: スケジュール済み
    • dependency: 依存関係
  • status: (複数選択)
    • new: 新規
    • pending: 保留中
    • waiting: 待機中
    • running: 実行中
    • successful: 成功
    • failed: 失敗
    • error: エラー
    • canceled: キャンセル済み
  • failed: (ブール値)
  • started: (日時)
  • finished: (日時)
  • elapsed: (10 進数)
  • job_explanation: (文字列)
  • system_job_template: (フィールド)
  • job_type: (複数選択)
    • "": ———
    • cleanup_jobs: 特定の日数より前のジョブを削除
    • cleanup_activitystream: 特定の日数より前のアクティビティーストリームのエントリーを削除
    • cleanup_deleted: 削除済みのアイテムをデータベースから完全削除
    • cleanup_facts: システムトラッキングデータを完全削除またはその粒度を削減
  • extra_vars: (文字列)

システムジョブの作成

新規システムジョブを作成するには、以下のシステムジョブフィールドを使ってリソースに POST リクエストを実行します。

  • name: (文字列。必須)
  • description: (文字列。デフォルトは "")
  • system_job_template: (フィールド。デフォルトは None)
  • job_type: (複数選択)
    • "": ——— (デフォルト)
    • cleanup_jobs: 特定の日数より前のジョブを削除
    • cleanup_activitystream: 特定の日数より前のアクティビティーストリームのエントリーを削除
    • cleanup_deleted: 削除済みのアイテムをデータベースから完全削除
    • cleanup_facts: システムトラッキングデータを完全削除またはその粒度を削減
  • extra_vars: (文字列。デフォルトは "")

オプションエンドポイントの確認

オプションエンドポイント テーブルでは、このエンドポイントのオプションを確認できます。ブラウザー表示が可能な API でエンドポイントを表示している場合は、「オプション」ボタンをクリックすると以下の raw JSON が表示されます。

name System Job List
description # List System Jobs: Make a GET request to this resource to retrieve the list of system jobs.
renders
0 application/json
1 text/html
parses
0 application/json
added_in_version 1.2
actions
POST
name
type string
required
true
label name
max_length 512
description
type string
required
false
label description
default (Empty Text)
system_job_template
type field
required
false
default null
job_type
type multiple choice
required
false
label job type
default (Empty Text)
choices
0
0 (Empty Text)
1 ---------
1
0 cleanup_jobs
1 Remove jobs older than a certain number of days
2
0 cleanup_activitystream
1 Remove activity stream entries older than a certain number of days
3
0 cleanup_deleted
1 Purge previously deleted items from the database
4
0 cleanup_facts
1 Purge and/or reduce the granularity of system tracking data
extra_vars
type string
required
false
label extra vars
default (Empty Text)
GET
id
type integer
label ID
help_text Database ID for this system job.
type
type multiple choice
help_text Data type for this system job.
choices
0
0 system_job
1 Management Job
url
type string
help_text URL for this system job.
related
type object
help_text Data structure with URLs of related resources.
summary_fields
type object
help_text Data structure with name/description for related resources.
created
type datetime
help_text Timestamp when this system job was created.
modified
type datetime
help_text Timestamp when this system job was last modified.
name
type string
label name
description
type string
label description
unified_job_template
type field
label unified job template
launch_type
type multiple choice
label launch type
choices
0
0 manual
1 Manual
1
0 callback
1 Callback
2
0 scheduled
1 Scheduled
3
0 dependency
1 Dependency
status
type multiple choice
label status
choices
0
0 new
1 New
1
0 pending
1 Pending
2
0 waiting
1 Waiting
3
0 running
1 Running
4
0 successful
1 Successful
5
0 failed
1 Failed
6
0 error
1 Error
7
0 canceled
1 Canceled
failed
type boolean
label failed
started
type datetime
label started
finished
type datetime
label finished
elapsed
type decimal
label elapsed
job_explanation
type string
label job explanation
system_job_template
type field
job_type
type multiple choice
label job type
choices
0
0 (Empty Text)
1 ---------
1
0 cleanup_jobs
1 Remove jobs older than a certain number of days
2
0 cleanup_activitystream
1 Remove activity stream entries older than a certain number of days
3
0 cleanup_deleted
1 Purge previously deleted items from the database
4
0 cleanup_facts
1 Purge and/or reduce the granularity of system tracking data
extra_vars
type string
label extra vars
types
0 system_job
search_fields
0 description
1 name