このページでは、アプリケーションの正常性ルールの評価タイムフレームを作成、設定、および管理するために使用できる、スケジュール API メソッドについて説明します。正常性ルールに関連するメトリックは、管理しているスケジュールに応じて評価されます。詳細については、正常性ルールのスケジュールを参照してください。

  • JSON ペイロードの構文検証は、スケジュールの作成時に実行されます。
  • [Time Zone List] でタイムゾーンを選択してください。

新しいスケジュールの作成

指定された JSON ペイロードを使用して新しいスケジュールを作成します。「プロパティの詳細を参照してください。

リソースURL

POST <controller_url>/controller/alerting/rest/v1
/applications/<application_id>/schedules

要求/応答の形式

JSON

この例では、正常性ルールを 1 回評価する正常性ルールスケジュールを作成します。「例のダウンロード」を参照してください。

{
    "name": "Daily Schedule",
    "description": "Daily Schedule",
    "timezone": "America/Los_Angeles",
    "scheduleConfiguration": {
        "scheduleFrequency": "DAILY",
        "startTime": "06:00",
        "endTime": "18:00"
    }
}
JSON
{
    "id": 62,
    "name": "Daily Schedule",
    "description": "Daily Schedule",
    "timezone": "America/Los_Angeles",
    "scheduleConfiguration": {
        "scheduleFrequency": "DAILY",
        "startTime": "06:00",
        "endTime": "18:00"
    }
}
JSON


特定のアプリケーションに対するスケジュールリストの取得

指定されたアプリケーション ID に関連付けられている正常性ルールのスケジュールの詳細のリストを返します。この API は、スケジュールのスケジュール ID、名前、および説明を返します。プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/schedules

応答形式

JSON

応答の例

この例では、特定のアプリケーション ID に適用されるスケジュールのリストを返します。

[
    {
        "id": 62,
        "name": "Daily Schedule",
        "description": "Daily Schedule",
        "timezone": "America/Los_Angeles"
    },
    {
        "id": 12,
        "name": "End of Business Hour: 5pm-6pm, Mon-Fri",
        "description": "This schedule is active Monday through Friday, during end of business hour",
        "timezone": "Asia/Kolkata"
    },
    {
        "id": 61,
        "name": "Schedule1",
        "description": "Custom Schedule",
        "timezone": "America/Los_Angeles"
    },
    {
        "id": 11,
        "name": "Weekday lunch: 12pm-1pm, Mon-Fri",
        "description": "This schedule is active Monday through Friday, during lunch hour",
        "timezone": "Asia/Kolkata"
    },
    {
        "id": 10,
        "name": "Weekday mornings: 8am-12pm, Mon-Fri",
        "description": "This schedule is active Monday through Friday, during morning hours",
        "timezone": "Asia/Kolkata"
    },
    {
        "id": 7,
        "name": "Weekdays: 8am-5pm, Mon-Fri",
        "description": "This schedule is active Monday through Friday, during business hours",
        "timezone": "Asia/Kolkata"
    },
    {
        "id": 9,
        "name": "Weekends: 12am-11pm, Sat-Sun",
        "description": "This schedule is active all day and night on the weekend",
        "timezone": "Asia/Kolkata"
    },
    {
        "id": 8,
        "name": "Weeknights: 11pm-6am, Mon-Fri",
        "description": "This schedule is active Monday through Friday, during night time batch runs",
        "timezone": "Asia/Kolkata"
    }
]
JSON


指定されたスケジュールの詳細の取得

指定された ID を持つスケジュールを取得します。「プロパティの詳細」を参照してください。

リソースURL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/schedules/{schedule-id}

応答形式

JSON

応答の例

この例では、スケジュールの詳細を取得します。例のダウンロードを参照してください。

{
    "id": 12,
    "name": "End of Business Hour: 5pm-6pm, Mon-Fri",
    "description": "This schedule is active Monday through Friday, during end of business hour",
    "timezone": "Asia/Kolkata",
    "scheduleConfiguration": {
        "scheduleFrequency": "WEEKLY",
        "days": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY"
        ],
        "startTime": "17:00",
        "endTime": "18:00"
    }
}
JSON


スケジュールの更新

指定された JSON ペイロードを使用して既存のスケジュールを更新します。プロパティの詳細」を参照してください。

リソースURL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/schedules/{schedule-id}

要求/応答の形式

JSON

この例では、正常性ルールを 1 回評価するスケジュールを更新します。例のダウンロードを参照してください。

{
    "name": "One Time Schedule",
    "description": "One Time Schedule",
    "timezone": "America/Los_Angeles",
    "scheduleConfiguration": {
        "scheduleFrequency": "ONE_TIME",
        "startTime": "06:00",
        "endTime": "18:00",
        "startDate": "01/01/2019",
        "endDate": "01/01/2019"
    }
}
JSON

この例では、スケジュールが正常に更新されたことを確認します。

{
    "id": 62,
    "name": "One Time Schedule",
    "description": "One Time Schedule",
    "timezone": "America/Los_Angeles",
    "scheduleConfiguration": {
        "scheduleFrequency": "ONE_TIME",
        "startDate": "01/01/2019",
        "startTime": "06:00",
        "endDate": "01/01/2019",
        "endTime": "18:00"
    }
}
JSON


スケジュールの削除

指定された ID を持つスケジュールを削除します。プロパティの詳細」を参照してください。

リソースURL

DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/schedules/{schedule-id}

応答コード

コード

説明

200正常に取得されました
201正常に作成されました
204正常に削除されました
400Bad request
401Unauthorized
403Forbidden
404リソースが見つかりません
409すでに存在します

Property Details

スケジュール

正常性ルールスケジュールのペイロードの詳細。

プロパティ名

タイプ

説明と有効な値

id 整数

システムによって自動生成され、応答で返されます。

これは ReadOnly 値です。

name*

string

評価のために正常性ルールに関連付けられるスケジュールの名前。

最小長:1

descriptionstring

評価の詳細を含むスケジュールの説明。

例:正常性ルールは毎日昼 12 時に評価されます。

デフォルト値: true

timezone*

string

Timezone Id:タイムゾーンの固有識別子。「タイムゾーン」を参照してください。

例:America/Los_Angeles

scheduleConfiguration*


プロパティ名タイプ説明
scheduleFrequencystring

スケジュールで指定された正常性ルールの評価頻度。

Enums:

ONE_TIME

DAILY

WEEKLY

MONTHLY_SPECIFIC_DATE

MONTHLY_SPECIFIC_DAY

CUSTOM

OneTimeSchedule

このスケジュールは、正常性ルールを 1 回評価します。

プロパティ名タイプ説明
scheduleFrequency*string正常性ルールを評価する頻度。「Enums」を参照してください。
startDate*string

スケジュールされた開始日(DD/MM/YYYY 形式)。

パターン:

^(?:(?:31(\/|-|\.)(?:0?[13578]|1[02]))\1|(?:(?:29|30)(\/|-|\.)(?:0?[13-9]|1[0-2])\2))(?:(?:1[6-9]|[2-9]\d)?\d{2})$|^(?:29(\/|-|\.)0?2\3(?:(?:(?:1[6-9]|[2-9]\d)?(?:0[48]|[2468][048]|[13579][26])|(?:(?:16|[2468][048]|[3579][26])00))))$|^(?:0?[1-9]|1\d|2[0-8])(\/|-|\.)(?:(?:0?[1-9])|(?:1[0-2]))\4(?:(?:1[6-9]|[2-9]\d)?\d{2})$

startTime*string

スケジュールされた開始時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

endDate*string

スケジュールされた終了日(DD/MM/YYYY 形式)。

パターン:

^(?:(?:31(\/|-|\.)(?:0?[13578]|1[02]))\1|(?:(?:29|30)(\/|-|\.)(?:0?[13-9]|1[0-2])\2))(?:(?:1[6-9]|[2-9]\d)?\d{2})$|^(?:29(\/|-|\.)0?2\3(?:(?:(?:1[6-9]|[2-9]\d)?(?:0[48]|[2468][048]|[13579][26])|(?:(?:16|[2468][048]|[3579][26])00))))$|^(?:0?[1-9]|1\d|2[0-8])(\/|-|\.)(?:(?:0?[1-9])|(?:1[0-2]))\4(?:(?:1[6-9]|[2-9]\d)?\d{2})$

endTime*string

スケジュールされた終了時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

DailySchedule

1 日ごとに正常性ルールを評価するための定期スケジュール。

プロパティ名タイプ説明
scheduleFrequency*string正常性ルールを評価する頻度。「Enums」を参照してください。
startTime*string

スケジュールされた開始時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

endTime*string

スケジュールされた終了時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

WeeklySchedule

1 週間ごとに正常性ルールを評価するための定期スケジュール。

プロパティ名タイプ説明
scheduleFrequency*string正常性ルールを評価する頻度。「Enums」を参照してください。
days*string

正常性ルールを評価する曜日。

minItems:1

maxItems:7

プロパティ名タイプ説明
DayOfWeekstring

Enums

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

startTime*string

スケジュールされた開始時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

endTime*string

スケジュール終了時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

MonthlySpecificDateSchedule

1 ヵ月ごとの特定日に正常性ルールを評価するための定期スケジュール。

プロパティ名タイプ説明
scheduleFrequency*string正常性ルールを評価する頻度。「Enums」を参照してください。
startDate*string

スケジュール開始日(DD/MM/YYYY 形式)。

パターン:

^(?:(?:31(\/|-|\.)(?:0?[13578]|1[02]))\1|(?:(?:29|30)(\/|-|\.)(?:0?[13-9]|1[0-2])\2))(?:(?:1[6-9]|[2-9]\d)?\d{2})$|^(?:29(\/|-|\.)0?2\3(?:(?:(?:1[6-9]|[2-9]\d)?(?:0[48]|[2468][048]|[13579][26])|(?:(?:16|[2468][048]|[3579][26])00))))$|^(?:0?[1-9]|1\d|2[0-8])(\/|-|\.)(?:(?:0?[1-9])|(?:1[0-2]))\4(?:(?:1[6-9]|[2-9]\d)?\d{2})$

startTime*string

スケジュールされた開始時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

endDate*string

スケジュールされた終了日(DD/MM/YYYY 形式)。

パターン:

^(?:(?:31(\/|-|\.)(?:0?[13578]|1[02]))\1|(?:(?:29|30)(\/|-|\.)(?:0?[13-9]|1[0-2])\2))(?:(?:1[6-9]|[2-9]\d)?\d{2})$|^(?:29(\/|-|\.)0?2\3(?:(?:(?:1[6-9]|[2-9]\d)?(?:0[48]|[2468][048]|[13579][26])|(?:(?:16|[2468][048]|[3579][26])00))))$|^(?:0?[1-9]|1\d|2[0-8])(\/|-|\.)(?:(?:0?[1-9])|(?:1[0-2]))\4(?:(?:1[6-9]|[2-9]\d)?\d{2})$

endTime*string

スケジュールされた終了時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

MonthlySpecificDaySchedule

1 ヵ月ごとの特定日に正常性ルールを評価するための定期スケジュール。

プロパティ名タイプ説明
scheduleFrequency*string正常性ルールを評価する頻度。「Enums」を参照してください。
startTime*string

スケジュールされた開始時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

endTime*string

スケジュールされた終了時刻(24 時間形式)。

パターン:

^([01]\d|2[0-3]):([0-5]\d)$

day*string

正常性ルールを評価する曜日。

minItems:1

maxItems:7

Property Name

タイプ

説明

DayOfWeekstring

Enums

SUNDAY

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

occurrence*string

1 ヵ月の特定日に発生。

Enums:

FIRST

SECOND

THIRD

FOURTH

LAST 

CustomSchedule

特定の要件とタイムゾーンに基づいて正常性ルールを評価するためのカスタムスケジュール。UNIX cron 式を使用してプロパティを定義します。

プロパティ名タイプ説明
scheduleFrequency*string正常性ルールを評価する頻度。「Enums」を参照してください。
startCron*string

UNIX cron 式の開始。

endCron*stringUNIX cron 式の終了。

ScheduleSummaryElement

スケジュール API を取得するときに返される、定義済みスケジュールの詳細。

プロパティ名タイプ説明
id 整数

システムによって自動生成され、応答で返されます。

name*

string

評価のために正常性ルールに関連付けられるスケジュールの名前。

descriptionstring

スケジュールと評価の詳細の説明。

timezone*string

タイムゾーン ID:タイムゾーンの固有識別子。

*This property is required (mandatory).

例のダウンロード

スケジュール Schedule Examples.zip を設定するのに役立つ一連の例をダウンロードします。

SWAGGER YAML ファイルのダウンロード

Swagger YAML 仕様 schedule_openapi.yml をダウンロードします。