機械翻訳について

移動先

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

システム・ジョブ・テンプレートのリスト

get

/api/v2/system_job_templates/

このリソースに対してGETリクエストを行って、システム・ジョブ・テンプレートのリストを取得します。

結果のデータ構造には次が含まれます。

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

countフィールドは、対象となる問合せで見つかったシステム・ジョブ・テンプレートの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上のシステム・ジョブ・テンプレート・レコードが含まれます。

結果

それぞれのシステム・ジョブ・テンプレート・データ構造には次のフィールドが含まれます。

• id: このシステム・ジョブ・テンプレートのデータベースID。(整数)
• type: このシステム・ジョブ・テンプレートのデータ型。(選択)
• url: このシステム・ジョブ・テンプレートのURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: このシステム・ジョブ・テンプレートが作成されたときのタイムスタンプ。(日時)
• modified: このシステム・ジョブ・テンプレートが最後に変更されたときのタイムスタンプ。(日時)
• name: このシステム・ジョブ・テンプレートの名前。(文字列)
• description: このシステム・ジョブ・テンプレートのオプションの説明。(文字列)
• last_job_run: (日時)
• last_job_failed: (ブール)
• next_job_run: (日時)
• status: (選択)
  • new: 新規
  • pending: 保留中
  • waiting: 待機中
  • running: 実行中
  • successful: 成功
  • failed: 失敗
  • error: エラー
  • canceled: 取消し済
  • never updated: 更新なし
  • ok: OK
  • missing: 不明
  • none: 外部ソースなし
  • updating: 更新中
• execution_environment: 実行に使用されるコンテナ・イメージ。(id)
• job_type: (選択)
  • "": ---------
  • cleanup_jobs: 特定の日数より前のジョブを削除します
  • cleanup_activitystream: 特定の日数より前のアクティビティ・ストリーム・エントリを削除します
  • cleanup_sessions: 期限切れのブラウザ・セッションをデータベースから削除します
  • cleanup_tokens: 期限切れのOAuth 2アクセス・トークンおよびリフレッシュ・トークンを削除します

ソート

システム・ジョブ・テンプレートが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。

?order_by=name

フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。

?order_by=-name

フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。

?order_by=name,some_other_field

ページ区切り

リクエストごとに返される結果の数を変更するには、page_size問合せ文字列パラメータを使用します。 特定のページの結果を取得するには、page問合せ文字列パラメータを使用します。

?page_size=100&page=2

結果で返されるpreviousリンクおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。

検索

モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search問合せ文字列パラメータを使用します。

?search=findme

(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。

?related__search=findme

リクエスト

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

• application/json

問合せパラメータ

• page: integer
  ページ区切りが設定された結果セット内のページ番号。
• page_size: integer
  ページごとに返す結果の数。
• search: string
  検索条件。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : schema

型: object

ソースを表示

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/SystemJobTemplate"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• Array of: object SystemJobTemplate

{
    "items":{
        "$ref":"#/definitions/SystemJobTemplate"
    },
    "type":"array"
}

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

型: object

ソースを表示

• created: string
  タイトル: Created

  読取り専用: true
• description: string
  タイトル: Description
• execution_environment: integer
  タイトル: Execution environment

  実行に使用するコンテナ・イメージ。
• id: integer
  タイトル: ID

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

  指定できる値: [ "cleanup_jobs", "cleanup_activitystream", "cleanup_sessions", "cleanup_tokens" ]
• last_job_failed: boolean
  タイトル: Last job failed

  読取り専用: true
• last_job_run: string(date-time)
  タイトル: Last job run

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

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

  最小長: 1

  最大長: 512
• next_job_run: string(date-time)
  タイトル: Next job run

  読取り専用: true
• related: string
  タイトル: Related

  読取り専用: true
• status: string
  タイトル: Status

  読取り専用: true

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

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

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

  読取り専用: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "job_type":{
            "enum":[
                "cleanup_jobs",
                "cleanup_activitystream",
                "cleanup_sessions",
                "cleanup_tokens"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated",
                "ok",
                "missing",
                "none",
                "updating"
            ],
            "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"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る