Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

プロジェクトのスケジュールのリスト

get

/api/v2/projects/{id}/schedules/

このリソースに対してGETリクエストを行って、選択したプロジェクトに関連付けられたスケジュールのリストを取得します。

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

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

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

結果

それぞれのスケジュールのデータ構造には次のフィールドが含まれます。

rrule: スケジュールのiCal繰返しルールを表す値。(文字列)
id: このスケジュールのデータベースID。(整数)
type: このスケジュールのデータ型。(選択)
url: このスケジュールのURL。(文字列)
related: 関連リソースのURLを含むデータ構造。(オブジェクト)
summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
created: このスケジュールが作成されたときのタイムスタンプ。(日時)
modified: このスケジュールが最後に変更されたときのタイムスタンプ。(日時)
name: このスケジュールの名前。(文字列)
description: このスケジュールのオプションの説明。(文字列)
extra_data: (json)
inventory: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id)
scm_branch: (文字列)
job_type: (選択)
- None: ---------
- "": ---------
- run: 実行
- check: チェック
job_tags: (文字列)
skip_tags: (文字列)
limit: (文字列)
diff_mode: (ブール)
verbosity: (選択)
- None: ---------
- 0: 0 (標準)
- 1: 1 (詳細)
- 2: 2 (より詳細)
- 3: 3 (デバッグ)
- 4: 4 (接続デバッグ)
- 5: 5 (WinRMデバッグ)
execution_environment: 実行に使用されるコンテナ・イメージ。(id)
forks: (整数)
job_slice_count: (integer)
timeout: (integer)
unified_job_template: (id)
enabled: このスケジュールの処理を有効にします。(ブール)
dtstart: 初回のスケジュールはこの時間以降に発生します。(日時)
dtend: 最後のスケジュールはこの時間より前に発生し、これ以降、スケジュールは失効します。(日時)
next_run: スケジュールされたアクションが次に実行される時間。(日時)
timezone: このスケジュールが実行されるタイムゾーン。このフィールドはRRULEから抽出されます。 RRULEのタイムゾーンが別のタイムゾーンへのリンクである場合、リンクはこのフィールドに反映されます。(フィールド)
until: このスケジュールが終了する日付。このフィールドはRRULEから計算されます。スケジュールが終了しない場合、空の文字列が返されます(フィールド)

ソート

スケジュールが特定の順序で返されるように指定するには、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

パス・パラメータ

id(required): string

問合せパラメータ

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/Schedule"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

Array of: object Schedule

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

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

型: object

ソースを表示

created: string

タイトル: Created

読取り専用: true
description: string

タイトル: Description
diff_mode: boolean

タイトル: Diff mode
dtend: string(date-time)

タイトル: Dtend

読取り専用: true

スケジュールの最後の発生はこの時間より前に発生し、多くの場合スケジュールの期限が切れます。
dtstart: string(date-time)

タイトル: Dtstart

読取り専用: true

スケジュールの最初の出現は、この時間以降に発生します。
enabled: boolean

タイトル: Enabled

デフォルト値: true

このスケジュールの処理を使用可能にします。
execution_environment: integer

タイトル: Execution environment

実行に使用するコンテナ・イメージ。
extra_data: object Extra data

タイトル: Extra data
forks: integer

タイトル: Forks

最小値: 0
id: integer

タイトル: ID

読取り専用: true
inventory: integer

タイトル: Inventory

ジョブ・テンプレートがインベントリを要求すると仮定して、プロンプトとして適用されたインベントリ
job_slice_count: integer

タイトル: Job slice count

最小値: 0
job_tags: string

タイトル: Job tags
job_type: string

タイトル: Job type

指定できる値: [ "run", "check" ]
limit: string

タイトル: Limit
modified: string

タイトル: Modified

読取り専用: true
name(required): string

タイトル: Name

最小長: 1

最大長: 512
next_run: string(date-time)

タイトル: Next run

読取り専用: true

スケジュール済アクションが次回実行されるとき。
related: string

タイトル: Related

読取り専用: true
rrule(required): string

タイトル: Rrule

最小長: 1

スケジュールiCal繰返しルールを表す値。
scm_branch: string

タイトル: Scm branch
skip_tags: string

タイトル: Skip tags
summary_fields: string

タイトル: Summary fields

読取り専用: true
timeout: integer

タイトル: Timeout
timezone: string

タイトル: Timezone

読取り専用: true

このスケジュールが実行されるタイムゾーン。このフィールドはRRULEから抽出されます。 RRULEのタイムゾーンが別のタイムゾーンへのリンクである場合、リンクはこのフィールドに反映されます。
type: string

タイトル: Type

読取り専用: true
unified_job_template(required): integer

タイトル: Unified job template
until: string

タイトル: Until

読取り専用: true

このスケジュールが終了する日付。このフィールドはRRULEから計算されます。スケジュールが終了しない場合、空の文字列が返されます
url: string

タイトル: Url

読取り専用: true
verbosity: string

タイトル: Verbosity

指定できる値: [ "0", "1", "2", "3", "4", "5" ]

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "diff_mode":{
            "title":"Diff mode",
            "type":"boolean",
            "x-nullable":true
        },
        "dtend":{
            "description":"The last occurrence of the schedule occurs before this time, aftewards the schedule expires.",
            "format":"date-time",
            "readOnly":true,
            "title":"Dtend",
            "type":"string",
            "x-nullable":true
        },
        "dtstart":{
            "description":"The first occurrence of the schedule occurs on or after this time.",
            "format":"date-time",
            "readOnly":true,
            "title":"Dtstart",
            "type":"string",
            "x-nullable":true
        },
        "enabled":{
            "default":true,
            "description":"Enables processing of this schedule.",
            "title":"Enabled",
            "type":"boolean",
            "x-nullable":true
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "extra_data":{
            "title":"Extra data",
            "type":"object"
        },
        "forks":{
            "minimum":"0",
            "title":"Forks",
            "type":"integer",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "job_slice_count":{
            "minimum":"0",
            "title":"Job slice count",
            "type":"integer",
            "x-nullable":true
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "limit":{
            "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
        },
        "next_run":{
            "description":"The next time that the scheduled action will run.",
            "format":"date-time",
            "readOnly":true,
            "title":"Next run",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "rrule":{
            "description":"A value representing the schedules iCal recurrence rule.",
            "minLength":"1",
            "title":"Rrule",
            "type":"string",
            "x-nullable":true
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "title":"Timeout",
            "type":"integer",
            "x-nullable":true
        },
        "timezone":{
            "description":"The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field.",
            "readOnly":true,
            "title":"Timezone",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "title":"Unified job template",
            "type":"integer"
        },
        "until":{
            "description":"The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned",
            "readOnly":true,
            "title":"Until",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "verbosity":{
            "enum":[
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
            ],
            "title":"Verbosity",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "rrule",
        "name",
        "unified_job_template"
    ],
    "type":"object"
}

ネストされたスキーマ : 追加データ

型: object

タイトル: Extra data

先頭に戻る