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

機械翻訳について

ジョブ・テンプレートのスケジュールの作成

post

/api/v2/job_templates/{id}/schedules/

次のスケジュール・フィールドを指定してこのリソースに対してPOSTリクエストを行って、このジョブ・テンプレートに関連付けられた新しいスケジュールを作成します。

rrule: スケジュールのiCal繰返しルールを表す値。(文字列、必須)
name: このスケジュールの名前。(文字列、必須)
description: このスケジュールのオプションの説明。(文字列、デフォルト="")
extra_data: (json、デフォルト={})
inventory: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id、デフォルト=``)
scm_branch: (文字列、デフォルト="")
job_type: (選択)
- None: --------- (デフォルト)
- "": ---------
- run: 実行
- check: チェック
job_tags: (文字列、デフォルト="")
skip_tags: (文字列、デフォルト="")
limit: (文字列、デフォルト="")
diff_mode: (ブール、デフォルト=None)
verbosity: (選択)
- None: --------- (デフォルト)
- 0: 0 (標準)
- 1: 1 (詳細)
- 2: 2 (より詳細)
- 3: 3 (デバッグ)
- 4: 4 (接続デバッグ)
- 5: 5 (WinRMデバッグ)
enabled: このスケジュールの処理を有効にします。(ブール、デフォルト=True)

このリソースに対するPOSTリクエストには、特定の形式に従い、許可されたルールのサブセットに準拠した適切なrrule値が含まれている必要があります。

次に、rruleで想定される形式と詳細を示します。

DTSTARTは必須であり、DTSTART:YYYYMMDDTHHMMSSZという形式に従う必要があります
DTSTARTはUTCであると想定されます
INTERVALは必須です
SECONDLYはサポートされていません
TZIDはサポートされていません
ルール文の前にRRULEが必要です
BYDAYはサポートされていますが、数値接頭辞が付いたBYDAYはサポートされていません
BYYEARDAYおよびBYWEEKNOはサポートされていません
スケジュールごとに1つのrrule文のみがサポートされています
COUNTは< 1000である必要があります

次に、rruleの例をいくつか示します。

"DTSTART:20500331T055000Z RRULE:FREQ=MINUTELY;INTERVAL=10;COUNT=5"
"DTSTART:20240331T075000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1"
"DTSTART:20140331T075000Z RRULE:FREQ=MINUTELY;INTERVAL=1;UNTIL=20230401T075000Z"
"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;BYDAY=MO,WE,FR"
"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=5;BYDAY=MO"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=6"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=4;BYDAY=SU"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR"
"DTSTART:20140331T075000Z RRULE:FREQ=MONTHLY;INTERVAL=1;BYSETPOS=-1;BYDAY=MO,TU,WE,TH,FR,SA,SU"
"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=4;BYMONTHDAY=1"
"DTSTART:20140331T075000Z RRULE:FREQ=YEARLY;INTERVAL=1;BYSETPOS=-1;BYMONTH=8;BYDAY=SU"
"DTSTART:20140331T075000Z RRULE:FREQ=WEEKLY;INTERVAL=1;UNTIL=20230401T075000Z;BYDAY=MO,WE,FR"
"DTSTART:20140331T075000Z RRULE:FREQ=HOURLY;INTERVAL=1;UNTIL=20230610T075000Z"

リクエスト

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

application/json

パス・パラメータ

id: 文字列

ルート・スキーマ : schema

例:

{
    "extra_data":"{\"var1\": \"foo\"}",
    "name":"test sch",
    "rrule":"DTSTART:20151117T050000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1"
}

先頭に戻る

レスポンス

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

application/json

201レスポンス

レスポンスの例(application/json)

{
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"",
    "diff_mode":null,
    "dtend":"2015-11-17T05:00:00Z",
    "dtstart":"2015-11-17T05:00:00Z",
    "enabled":true,
    "extra_data":{
        "var1":"$encrypted$"
    },
    "id":1,
    "inventory":null,
    "job_tags":null,
    "job_type":null,
    "limit":null,
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"test sch",
    "next_run":null,
    "related":{
        "credentials":"/api/v2/schedules/1/credentials/",
        "inventory":"/api/v2/inventories/1/",
        "project":"/api/v2/projects/1/",
        "unified_job_template":"/api/v2/job_templates/2/",
        "unified_jobs":"/api/v2/schedules/1/jobs/"
    },
    "rrule":"DTSTART:20151117T050000Z RRULE:FREQ=DAILY;INTERVAL=1;COUNT=1",
    "scm_branch":null,
    "skip_tags":null,
    "summary_fields":{
        "inventory":{
            "description":"",
            "has_active_failures":false,
            "has_inventory_sources":false,
            "hosts_with_active_failures":0,
            "id":1,
            "insights_credential_id":null,
            "inventory_sources_with_failures":0,
            "kind":"",
            "name":"test-inv",
            "organization_id":1,
            "total_groups":0,
            "total_hosts":0,
            "total_inventory_sources":0
        },
        "unified_job_template":{
            "description":"",
            "id":2,
            "name":"test-jt",
            "unified_job_type":"job"
        },
        "user_capabilities":{
            "delete":true,
            "edit":true
        }
    },
    "timezone":"UTC",
    "type":"schedule",
    "unified_job_template":2,
    "until":"",
    "url":"/api/v2/schedules/1/",
    "verbosity":null
}

400レスポンス

レスポンスの例(application/json)

{
    "rrule":[
        "DTSTART cannot be a naive datetime.  Specify ;TZINFO= or YYYYMMDDTHHMMSSZZ."
    ]
}

先頭に戻る