カレンダーを取得（Get calendars）

カレンダーAPI

カレンダーの設定情報を取得します。

リクエスト

GET _ml/calendars/<calendar_id>

GET _ml/calendars/_all

前提条件

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

説明

詳細については、カレンダーとスケジュールされたイベントを参照してください。

パスパラメータ

• <calendar_id>
• （必須、文字列）カレンダーを一意に識別する文字列です。
  カンマ区切りのIDリストまたはワイルドカード式を使用することで、単一のAPIリクエストで複数のカレンダーの情報を取得できます。_allを使用することで、すべてのカレンダーの情報を取得することができます。カレンダー識別子として*を指定するか、識別子を省略することも可能です。

クエリパラメータ

• from
• （オプション、整数）指定された数のカレンダーをスキップします。このパラメータは<calendar_id>を省略した場合のみサポートされます。デフォルトは0です。
• size
• （オプション、整数）取得するカレンダーの最大数を指定します。このパラメータは<calendar_id>を省略した場合のみサポートされます。デフォルトは100です。

リクエストボディ

• page

• -   `````from

  • （オプション、整数）指定された数のカレンダーをスキップします。このオブジェクトは<calendar_id>を省略した場合のみサポートされます。デフォルトは0です。
  • size
  • （オプション、整数）取得するカレンダーの最大数を指定します。このオブジェクトは<calendar_id>を省略した場合のみサポートされます。デフォルトは100です。

レスポンスボディ

APIは、次のプロパティを持つカレンダーリソースの配列を返します：

• calendar_id
• （文字列）カレンダーを一意に識別する文字列です。
• job_ids
• （配列）異常検出ジョブ識別子の配列。例えば：["total-requests"]。

例

Python

resp = client.ml.get_calendars(
   calendar_id="planned-outages",
)
print(resp)

Ruby

response = client.ml.get_calendars(
  calendar_id: 'planned-outages'
)
puts response

Js

const response = await client.ml.getCalendars({
  calendar_id: "planned-outages",
});
console.log(response);

コンソール

GET _ml/calendars/planned-outages

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

コンソール-結果

{
  "count": 1,
  "calendars": [
   {
   "calendar_id": "planned-outages",
   "job_ids": [
   "total-requests"
   ]
   }
  ]
}