新しいブラックアウトの作成

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts

このAPIは、新しいブラックアウトを作成します。

リクエスト

この操作にはリクエスト・パラメータはありません。

サポートされているメディア・タイプ
リクエスト本文 - application/json ()
ルート・スキーマ: schema
型: object
新しいブラックアウトを作成するためのペイロード。
ソースの表示
すべてに一致
ソースの表示
ネストされたスキーマ: excludeTargets
型: array
ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。
ソースの表示
ネストされたスキーマ: excludeTypes
型: array
ブラックアウトから除外する必要がある間接ブラックアウト・メンバー・タイプの名前のリスト。
ソースの表示
ネストされたスキーマ: targets
型: array
ブラックアウトするターゲットのリスト。
ソースの表示
ネストされたスキーマ: Schedule
型: object
スケジュールの詳細
ソースの表示
  • 時間をターゲット・タイムゾーンで解釈するかどうかを示します。時間にタイムゾーンが指定されていて、isTargetZoneがtrueの場合、エラー条件としてレポートされます
  • 操作を繰り返し実行する必要がある頻度
    例: frequency:weekly;days:2,
  • 現在、ICAL仕様のデフォルトはICALをサポートしていますが、将来的には、CRONなどの他のタイプに拡張される可能性があります。
  • 開始されていない場合にジョブがスキップとしてマークされるまでの時間(分)。NULLまたは負の値は、猶予期間がないことを意味します。
    例: 60
  • 終了時間
  • 開始時間
ネストされたスキーマ: TargetIdentifier
型: object
ターゲットを名前とtypeNameで特定するかIDで特定します。
ソースの表示
ネストされたスキーマ: BlackoutTarget
型: object
ブラックアウトに含まれているターゲットの表現。
ソースの表示

先頭に戻る

レスポンス

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

201レスポンス

作成されました
本文()
ルート・スキーマ: Blackout
型: object
これはブラックアウトの説明です。
ソースの表示
  • ブラックアウトを開始するエージェントの名前。
    例: hostName:1838
  • ブラックアウト作成時に指定されたtimeToEnd。
  • ブラックアウト作成時に指定されたtimeToStart。
  • ブラックアウトに関連するコメント。
    例: oemrepデータベースの、定期メンテナンスによるスケジュールされたブラックアウト
  • excludeTargets
    ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。
  • excludeTypes
    ブラックアウトから除外する必要がある間接ブラックアウト・メンバー・タイプの名前のリスト。
  • ブラックアウトID
    例:D91786E288D35455C3ADA1B329B49BB5
  • デフォルト値: false
    ターゲットでのジョブ実行をブラックアウト中に許可するかどうかを示します。
  • デフォルト値: false
    そのブラックアウトに含まれているホスト上のターゲットもすべてブラックアウトするかどうかを示します。
  • links
  • ブラックアウト名
    例: my_blackout
  • ブラックアウトの所有者
    例: scott
  • ブラックアウト理由
    例: Host patching
  • 指定可能な値: [ "SCHEDULED", "START_PROCESSING", "START_PARTIAL", "START_FAILED", "STARTED", "STOP_PENDING", "STOP_FAILED", "STOP_PARTIAL", "EDIT_FAILED", "EDIT_PARTIAL", "EDIT_PENDING", "STOPPED", "ENDED", "END_PARTIAL" ]
    ブラックアウト・ステータス。
  • デフォルト値: PATCHING
    指定可能な値: [ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]
    ブラックアウトのタイプ。
すべてに一致
ソースの表示
ネストされたスキーマ: excludeTargets
型: array
ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。
ソースの表示
ネストされたスキーマ: excludeTypes
型: array
ブラックアウトから除外する必要がある間接ブラックアウト・メンバー・タイプの名前のリスト。
ソースの表示
ネストされたスキーマ: Schedule
型: object
スケジュールの詳細
ソースの表示
  • 時間をターゲット・タイムゾーンで解釈するかどうかを示します。時間にタイムゾーンが指定されていて、isTargetZoneがtrueの場合、エラー条件としてレポートされます
  • 操作を繰り返し実行する必要がある頻度
    例: frequency:weekly;days:2,
  • 現在、ICAL仕様のデフォルトはICALをサポートしていますが、将来的には、CRONなどの他のタイプに拡張される可能性があります。
  • 開始されていない場合にジョブがスキップとしてマークされるまでの時間(分)。NULLまたは負の値は、猶予期間がないことを意味します。
    例: 60
  • 終了時間
  • 開始時間
ネストされたスキーマ: TargetIdentifier
型: object
ターゲットを名前とtypeNameで特定するかIDで特定します。
ソースの表示

400レスポンス

指定されたパラメータの1つが無効です。
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー・レスポンス
ソースの表示

401レスポンス

クライアントが認証されていません
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー・レスポンス
ソースの表示

409レスポンス

認可されていないかターゲットがすでに存在します
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー・レスポンス
ソースの表示

500レスポンス

リクエスト処理中の内部エラー
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー・レスポンス
ソースの表示

503レスポンス

必要なサービスが使用不可であることを示しています。
本文()
ルート・スキーマ: ErrorResponse
型: object
エラー・レスポンス
ソースの表示
先頭に戻る