新しいブラックアウトの作成
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts
このAPIは、新しいブラックアウトを作成します。
リクエスト
この操作にはリクエスト・パラメータはありません。
サポートされているメディア・タイプ
- application/json
ルート・スキーマ: schema
型:
object
新しいブラックアウトを作成するためのペイロード。
ソースの表示
-
description: string
ブラックアウトに関連するコメント。例:
oemrepデータベースの、定期メンテナンスによるスケジュールされたブラックアウト。
-
excludeTargets: array excludeTargets
ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。
-
excludeTypes: array excludeTypes
ブラックアウトから除外する必要がある間接ブラックアウト・メンバー・タイプの名前のリスト。
-
isAllowJobs: boolean
デフォルト値:
false
ターゲット上のジョブの実行をまだ許可することを示します。 -
isFullBlackoutOnHost: boolean
デフォルト値:
false
ホスト上のすべてのターゲットがブラックアウト対象であることを示します。 -
name(必須): string
ブラックアウトの名前
-
reasonId: number
ブラックアウトの理由ID
-
targets(必須): array targets
ブラックアウトするターゲットのリスト。
-
type: string
デフォルト値:
PATCHING
指定可能な値:[ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]
ブラックアウトのタイプ。
すべてに一致
ソースの表示
ネストされたスキーマ: excludeTargets
型:
array
ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。
ソースの表示
- 配列: object TargetIdentifier
ターゲットを名前とtypeNameで特定するかIDで特定します。
ネストされたスキーマ: targets
型:
array
ブラックアウトするターゲットのリスト。
ソースの表示
- 配列: object BlackoutTarget
ブラックアウトに含まれているターゲットの表現。
ネストされたスキーマ: Schedule
型:
object
スケジュールの詳細
ソースの表示
-
isTargetZone: boolean
時間をターゲット・タイムゾーンで解釈するかどうかを示します。時間にタイムゾーンが指定されていて、isTargetZoneがtrueの場合、エラー条件としてレポートされます
-
recurring: string
操作を繰り返し実行する必要がある頻度例:
frequency:weekly;days:2,
-
scheduleType: string
現在、ICAL仕様のデフォルトはICALをサポートしていますが、将来的には、CRONなどの他のタイプに拡張される可能性があります。
-
startGracePeriodInMinutes: integer
開始されていない場合にジョブがスキップとしてマークされるまでの時間(分)。NULLまたは負の値は、猶予期間がないことを意味します。例:
60
-
timeToEnd: string (date-time)
終了時間
-
timeToStart: string (date-time)
開始時間
ネストされたスキーマ: TargetIdentifier
型:
object
ターゲットを名前とtypeNameで特定するかIDで特定します。
ソースの表示
-
id: string
ターゲットID
-
name: string
ターゲット名
-
typeName: string
ターゲット・タイプ名
ネストされたスキーマ: BlackoutTarget
型:
object
ブラックアウトに含まれているターゲットの表現。
ソースの表示
-
id: string
ターゲットID
-
isIncludeMembers: boolean
デフォルト値:
true
そのターゲットのメンバーをブラックアウトに含めるかどうかを示します。 -
name: string
ターゲット名
-
typeName: string
ターゲット・タイプ名
例
先頭に戻る
レスポンス
サポートされているメディア・タイプ
- application/json
201レスポンス
作成されました
ルート・スキーマ: Blackout
型:
object
これはブラックアウトの説明です。
ソースの表示
-
agent: string
ブラックアウトを開始するエージェントの名前。例:
hostName:1838
-
creationTimeToEnd: string
ブラックアウト作成時に指定されたtimeToEnd。
-
creationTimeToStart: string
ブラックアウト作成時に指定されたtimeToStart。
-
description: string
ブラックアウトに関連するコメント。例:
oemrepデータベースの、定期メンテナンスによるスケジュールされたブラックアウト
-
excludeTargets: array excludeTargets
ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。
-
excludeTypes: array excludeTypes
ブラックアウトから除外する必要がある間接ブラックアウト・メンバー・タイプの名前のリスト。
-
id(必須): string
ブラックアウトID例:
D91786E288D35455C3ADA1B329B49BB5
-
isAllowJobs: boolean
デフォルト値:
false
ターゲットでのジョブ実行をブラックアウト中に許可するかどうかを示します。 -
isFullBlackoutOnHost: boolean
デフォルト値:
false
そのブラックアウトに含まれているホスト上のターゲットもすべてブラックアウトするかどうかを示します。 -
links(必須): object links
ブラックアウトに関連するリンク。
-
name(必須): string
ブラックアウト名例:
my_blackout
-
owner(必須): string
ブラックアウトの所有者例:
scott
-
reason: string
ブラックアウト理由例:
Host patching
-
status(必須): string
指定可能な値:
[ "SCHEDULED", "START_PROCESSING", "START_PARTIAL", "START_FAILED", "STARTED", "STOP_PENDING", "STOP_FAILED", "STOP_PARTIAL", "EDIT_FAILED", "EDIT_PARTIAL", "EDIT_PENDING", "STOPPED", "ENDED", "END_PARTIAL" ]
ブラックアウト・ステータス。 -
type(必須): string
デフォルト値:
PATCHING
指定可能な値:[ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]
ブラックアウトのタイプ。
すべてに一致
ソースの表示
ネストされたスキーマ: excludeTargets
型:
array
ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。
ソースの表示
- 配列: object TargetIdentifier
ターゲットを名前とtypeNameで特定するかIDで特定します。
ネストされたスキーマ: Schedule
型:
object
スケジュールの詳細
ソースの表示
-
isTargetZone: boolean
時間をターゲット・タイムゾーンで解釈するかどうかを示します。時間にタイムゾーンが指定されていて、isTargetZoneがtrueの場合、エラー条件としてレポートされます
-
recurring: string
操作を繰り返し実行する必要がある頻度例:
frequency:weekly;days:2,
-
scheduleType: string
現在、ICAL仕様のデフォルトはICALをサポートしていますが、将来的には、CRONなどの他のタイプに拡張される可能性があります。
-
startGracePeriodInMinutes: integer
開始されていない場合にジョブがスキップとしてマークされるまでの時間(分)。NULLまたは負の値は、猶予期間がないことを意味します。例:
60
-
timeToEnd: string (date-time)
終了時間
-
timeToStart: string (date-time)
開始時間
ネストされたスキーマ: TargetIdentifier
型:
object
ターゲットを名前とtypeNameで特定するかIDで特定します。
ソースの表示
-
id: string
ターゲットID
-
name: string
ターゲット名
-
typeName: string
ターゲット・タイプ名
ネストされたスキーマ: Link
型:
object
リンクを表します(self、previous、nextのいずれか)
ソースの表示
-
href: string
リンクのためのURL例:
/em/api/<resources>?page=b2Zmc2V0OjA&limit=0
例
400レスポンス
指定されたパラメータの1つが無効です。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
401レスポンス
クライアントが認証されていません
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
409レスポンス
認可されていないかターゲットがすでに存在します
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
500レスポンス
リクエスト処理中の内部エラー
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列
503レスポンス
必要なサービスが使用不可であることを示しています。
ルート・スキーマ: ErrorResponse
型:
object
エラー・レスポンス
ソースの表示
-
code(必須): string
プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
-
message(必須): string
判読可能なエラー文字列