Oracle Enterprise ManagerのREST API

既存のブラックアウトの編集

patch

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/blackouts/{blackoutId}

このAPIは、既存のブラックアウトを編集します。

リクエスト

パス・パラメータ

blackoutId(必須): string

ブラックアウトID

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

application/json

ルート・スキーマ: schema

型: object

既存のブラックアウトを編集するためのペイロード。

ソースの表示

description: string

ブラックアウトに関連するコメント。

例: oemrepデータベースの、定期メンテナンスによるスケジュールされたブラックアウト。
excludeTargets: array excludeTargets

ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。
excludeTypes: array excludeTypes

ブラックアウトから除外する必要がある間接ブラックアウト・メンバー・タイプの名前のリスト。
isAllowJobs: boolean

デフォルト値: false

ターゲット上のジョブの実行をまだ許可することを示します。
isFullBlackoutOnHost: boolean

デフォルト値: false

ホスト上のすべてのターゲットがブラックアウト対象であることを示します。
reasonId: number

ブラックアウトの理由ID
targets: array targets

ブラックアウトするターゲットのリスト。
type: string

デフォルト値: PATCHING

指定可能な値: [ "PATCHING", "NOTIFICATION", "NOTIFICATION_MAINTENANCE" ]

ブラックアウトのタイプ。

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to edit an existing blackout.",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database."
        },
        "targets":{
            "type":"array",
            "description":"List of targets to be blacked out.",
            "items":{
                "$ref":"#/components/schemas/BlackoutTarget"
            }
        },
        "reasonId":{
            "type":"number",
            "description":"reason id for the blackout"
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicate of jobs on targets are still allowed to be executed.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicate that all targets on host are under blackout.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

すべてに一致

ソースの表示

object Schedule

スケジュールの詳細

{
    "x-em-sdk-level":"emSDK",
    "description":"Payload to edit an existing blackout.",
    "properties":{
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database."
        },
        "targets":{
            "type":"array",
            "description":"List of targets to be blacked out.",
            "items":{
                "$ref":"#/components/schemas/BlackoutTarget"
            }
        },
        "reasonId":{
            "type":"number",
            "description":"reason id for the blackout"
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicate of jobs on targets are still allowed to be executed.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicate that all targets on host are under blackout.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

ネストされたスキーマ: excludeTargets

型: array

ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。

ソースの表示

配列: object TargetIdentifier

ターゲットを名前とtypeNameで特定するかIDで特定します。

{
    "type":"array",
    "description":"List of indirect blackout members which should be excluded from blackout.",
    "items":{
        "$ref":"#/components/schemas/TargetIdentifier"
    }
}

ネストされたスキーマ: excludeTypes

型: array

ブラックアウトから除外する必要がある間接ブラックアウト・メンバー・タイプの名前のリスト。

ソースの表示

配列: string

{
    "type":"array",
    "description":"List of indirect blackout member type names which should be excluded from blackout.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: targets

型: array

ブラックアウトするターゲットのリスト。

ソースの表示

配列: object BlackoutTarget

ブラックアウトに含まれているターゲットの表現。

{
    "type":"array",
    "description":"List of targets to be blacked out.",
    "items":{
        "$ref":"#/components/schemas/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)

開始時間

{
    "description":"Schedule details",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time",
            "format":"date-time"
        },
        "timeToEnd":{
            "type":"string",
            "description":"End time",
            "format":"date-time"
        },
        "isTargetZone":{
            "type":"boolean",
            "description":"To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition"
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"frequency:weekly;days:2,"
        },
        "startGracePeriodInMinutes":{
            "type":"integer",
            "description":"Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.",
            "example":"60"
        }
    }
}

ネストされたスキーマ: TargetIdentifier

型: object

ターゲットを名前とtypeNameで特定するかIDで特定します。

ソースの表示

id: string

ターゲットID
name: string

ターゲット名
typeName: string

ターゲット・タイプ名

{
    "type":"object",
    "description":"Identifies a target either by name and typeName or by id.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Target ID"
        },
        "name":{
            "type":"string",
            "description":"Target Name"
        },
        "typeName":{
            "type":"string",
            "description":"Target Type Name"
        }
    }
}

ネストされたスキーマ: BlackoutTarget

型: object

ブラックアウトに含まれているターゲットの表現。

ソースの表示

id: string

ターゲットID
isIncludeMembers: boolean

デフォルト値: true

そのターゲットのメンバーをブラックアウトに含めるかどうかを示します。
name: string

ターゲット名
typeName: string

ターゲット・タイプ名

{
    "x-em-sdk-level":"emSDK",
    "description":"Representation of a target contained in a blackout.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Target Name"
        },
        "typeName":{
            "type":"string",
            "description":"Target Type Name"
        },
        "id":{
            "type":"string",
            "description":"target id"
        },
        "isIncludeMembers":{
            "type":"boolean",
            "description":"Indicates if members of the target should be included in the blackout.",
            "default":true
        }
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: 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" ]

ブラックアウトのタイプ。

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a blackout description.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "owner",
        "links"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout",
            "example":"scott"
        },
        "reason":{
            "type":"string",
            "description":"Blackout reason",
            "example":"Host patching"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database"
        },
        "agent":{
            "type":"string",
            "description":"Name of the agent starting the blackout.",
            "example":"hostName:1838"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicates if job executions on targets are allowed during blackout.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicates if all targets on hosts in the blackout are blacked out too.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        },
        "creationTimeToStart":{
            "type":"string",
            "description":"The timeToStart given at blackout creation time."
        },
        "creationTimeToEnd":{
            "type":"string",
            "description":"The timeToEnd given at blackout creation time."
        },
        "links":{
            "type":"object",
            "description":"Blackout related links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                },
                "targets":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the targets under blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                            }
                        }
                    ]
                }
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

すべてに一致

ソースの表示

object Schedule

スケジュールの詳細

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a blackout description.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "owner",
        "links"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout",
            "example":"scott"
        },
        "reason":{
            "type":"string",
            "description":"Blackout reason",
            "example":"Host patching"
        },
        "description":{
            "type":"string",
            "description":"Blackout related comments.",
            "example":"A regular maintenance scheduled blackouts for oemrep database"
        },
        "agent":{
            "type":"string",
            "description":"Name of the agent starting the blackout.",
            "example":"hostName:1838"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "isAllowJobs":{
            "type":"boolean",
            "description":"Indicates if job executions on targets are allowed during blackout.",
            "default":false
        },
        "isFullBlackoutOnHost":{
            "type":"boolean",
            "description":"Indicates if all targets on hosts in the blackout are blacked out too.",
            "default":false
        },
        "excludeTypes":{
            "type":"array",
            "description":"List of indirect blackout member type names which should be excluded from blackout.",
            "items":{
                "type":"string"
            }
        },
        "excludeTargets":{
            "type":"array",
            "description":"List of indirect blackout members which should be excluded from blackout.",
            "items":{
                "$ref":"#/components/schemas/TargetIdentifier"
            }
        },
        "creationTimeToStart":{
            "type":"string",
            "description":"The timeToStart given at blackout creation time."
        },
        "creationTimeToEnd":{
            "type":"string",
            "description":"The timeToEnd given at blackout creation time."
        },
        "links":{
            "type":"object",
            "description":"Blackout related links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                },
                "targets":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the targets under blackout."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                            }
                        }
                    ]
                }
            }
        }
    },
    "allOf":[
        {
            "$ref":"#/components/schemas/Schedule"
        }
    ]
}

ネストされたスキーマ: excludeTargets

型: array

ブラックアウトから除外する必要がある間接ブラックアウト・メンバーのリスト。

ソースの表示

配列: object TargetIdentifier

ターゲットを名前とtypeNameで特定するかIDで特定します。

{
    "type":"array",
    "description":"List of indirect blackout members which should be excluded from blackout.",
    "items":{
        "$ref":"#/components/schemas/TargetIdentifier"
    }
}

ネストされたスキーマ: excludeTypes

型: array

ブラックアウトから除外する必要がある間接ブラックアウト・メンバー・タイプの名前のリスト。

ソースの表示

配列: string

{
    "type":"array",
    "description":"List of indirect blackout member type names which should be excluded from blackout.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: links

型: object

ブラックアウトに関連するリンク。

ソースの表示

self: self
targets: targets

{
    "type":"object",
    "description":"Blackout related links.",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the blackout."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
                    }
                }
            ]
        },
        "targets":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the targets under blackout."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
                    }
                }
            ]
        }
    }
}

ネストされたスキーマ: 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)

開始時間

{
    "description":"Schedule details",
    "type":"object",
    "properties":{
        "timeToStart":{
            "type":"string",
            "description":"Start time",
            "format":"date-time"
        },
        "timeToEnd":{
            "type":"string",
            "description":"End time",
            "format":"date-time"
        },
        "isTargetZone":{
            "type":"boolean",
            "description":"To indicate if the time should be interpreted in the target timezone or not. If timezone is specified in time and isTargetZone is true, it will be reported as an ERROR condition"
        },
        "scheduleType":{
            "type":"string",
            "description":"Currently we support ICAL specification default is ICAL, in the future it can be extended to other types e.g CRON."
        },
        "recurring":{
            "type":"string",
            "description":"Frequency at which the operation must be executed repeatedly",
            "example":"frequency:weekly;days:2,"
        },
        "startGracePeriodInMinutes":{
            "type":"integer",
            "description":"Time in minutes after which the job will be marked as skipped if not started. Null or Negative value means no grace period.",
            "example":"60"
        }
    }
}

ネストされたスキーマ: TargetIdentifier

型: object

ターゲットを名前とtypeNameで特定するかIDで特定します。

ソースの表示

id: string

ターゲットID
name: string

ターゲット名
typeName: string

ターゲット・タイプ名

{
    "type":"object",
    "description":"Identifies a target either by name and typeName or by id.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Target ID"
        },
        "name":{
            "type":"string",
            "description":"Target Name"
        },
        "typeName":{
            "type":"string",
            "description":"Target Type Name"
        }
    }
}

ネストされたスキーマ: self

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
そのブラックアウトへのリンク。
例: { "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the blackout."
        },
        {
            "example":{
                "href":"/em/api/blackouts/D91786E288D35455C3ADA1B329B49BB5"
            }
        }
    ]
}

ネストされたスキーマ: targets

すべてに一致

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
ブラックアウト対象のターゲットへのリンク。
例: { "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the targets under blackout."
        },
        {
            "example":{
                "href":"/em/api/blackouts/D91786E288DFSE2323ADA1B329B49BB5/targets"
            }
        }
    ]
}

ネストされたスキーマ: Link

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

href: string

リンクのためのURL

例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

例

401レスポンス

クライアントが認証されていません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404レスポンス

ターゲットが見つからないか、権限がありません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

リクエスト処理中の内部エラー

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

必要なサービスが使用不可であることを示しています。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る