カレンダーAPIにイベントを追加

カレンダーに予定されたイベントを投稿します。

リクエスト

POST _ml/calendars/<calendar_id>/events

前提条件

manage_ml クラスター権限が必要です。この権限は machine_learning_admin ビルトインロールに含まれています。

説明

このAPIは、各イベントに開始時刻、終了時刻、および説明が必要な 予定されたイベント のリストを受け入れます。

パスパラメータ

  • <calendar_id>
  • (必須、文字列)カレンダーを一意に識別する文字列。

リクエストボディ

  • events
  • (必須、配列)1つ以上の予定されたイベントのリスト。イベントの開始時刻と終了時刻は、エポックからのミリ秒の整数またはISO 8601形式の文字列として指定できます。
    イベントのプロパティ
    • description
    • (オプション、文字列)予定されたイベントの説明。
    • end_time
    • (必須、日付)予定されたイベントの終了時刻のタイムスタンプ(エポックからのミリ秒またはISO 8601形式)。
    • start_time
    • (必須、日付)予定されたイベントの開始時刻のタイムスタンプ(エポックからのミリ秒またはISO 8601形式)。

Python

  1. resp = client.ml.post_calendar_events(
  2. calendar_id="planned-outages",
  3. events=[
  4. {
  5. "description": "event 1",
  6. "start_time": 1513641600000,
  7. "end_time": 1513728000000
  8. },
  9. {
  10. "description": "event 2",
  11. "start_time": 1513814400000,
  12. "end_time": 1513900800000
  13. },
  14. {
  15. "description": "event 3",
  16. "start_time": 1514160000000,
  17. "end_time": 1514246400000
  18. }
  19. ],
  20. )
  21. print(resp)

Ruby

  1. response = client.ml.post_calendar_events(
  2. calendar_id: 'planned-outages',
  3. body: {
  4. events: [
  5. {
  6. description: 'event 1',
  7. start_time: 1_513_641_600_000,
  8. end_time: 1_513_728_000_000
  9. },
  10. {
  11. description: 'event 2',
  12. start_time: 1_513_814_400_000,
  13. end_time: 1_513_900_800_000
  14. },
  15. {
  16. description: 'event 3',
  17. start_time: 1_514_160_000_000,
  18. end_time: 1_514_246_400_000
  19. }
  20. ]
  21. }
  22. )
  23. puts response

Js

  1. const response = await client.ml.postCalendarEvents({
  2. calendar_id: "planned-outages",
  3. events: [
  4. {
  5. description: "event 1",
  6. start_time: 1513641600000,
  7. end_time: 1513728000000,
  8. },
  9. {
  10. description: "event 2",
  11. start_time: 1513814400000,
  12. end_time: 1513900800000,
  13. },
  14. {
  15. description: "event 3",
  16. start_time: 1514160000000,
  17. end_time: 1514246400000,
  18. },
  19. ],
  20. });
  21. console.log(response);

コンソール

  1. POST _ml/calendars/planned-outages/events
  2. {
  3. "events" : [
  4. {"description": "event 1", "start_time": 1513641600000, "end_time": 1513728000000},
  5. {"description": "event 2", "start_time": 1513814400000, "end_time": 1513900800000},
  6. {"description": "event 3", "start_time": 1514160000000, "end_time": 1514246400000}
  7. ]
  8. }

APIは次の結果を返します:

コンソール-結果

  1. {
  2. "events": [
  3. {
  4. "description": "event 1",
  5. "start_time": 1513641600000,
  6. "end_time": 1513728000000,
  7. "calendar_id": "planned-outages"
  8. },
  9. {
  10. "description": "event 2",
  11. "start_time": 1513814400000,
  12. "end_time": 1513900800000,
  13. "calendar_id": "planned-outages"
  14. },
  15. {
  16. "description": "event 3",
  17. "start_time": 1514160000000,
  18. "end_time": 1514246400000,
  19. "calendar_id": "planned-outages"
  20. }
  21. ]
  22. }