Oracle Enterprise ManagerのREST API

パブリック配信不可: 2025-05-14

ブラックアウトのリスト

get

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

このAPIは、指定された基準でブラックアウトのリストを返します。

リクエスト

問合せパラメータ

include: string
結果に追加情報を含めるために使用します。現在は使用可能な値は"total"のみであり、これは、基準に一致するブラックアウトの合計数を計算します。
例:
```
total
```
limit: integer(int32)
最小値: 1

最大値: 2000

返される行の数を制限するため。結果セットがそれより大きい場合は、結果内のpreviousリンクとnextリンクに従います。
例:
```
20
```
name: array[string]

ブラックアウトの名前
nameMatches: array[string]

ブラックアウトの名前パターン
owner: array[string]

ブラックアウトの所有者
page: string

self、nextおよびpreviousリンクにおいて使用されるシステム生成ページ・トークン。
reason: array[string]

ブラックアウトの理由
sort: string
ソート・フィールドと方向。指定可能なソート・フィールドは、"name"、"status"、"id"、"timeToStart"および"timeToEnd"です。指定可能な方向はASCとDESCです。デフォルトは"name:ASC"です。
例:
```
status:ASC,name:DESC
```
status: array[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)
targetId: string
指定されたIDのターゲットを直接ブラックアウト・メンバーとして含んでいるブラックアウトのみをリストするために使用します。
例:
```
ADLKFIDYFSDHFISDOFSDF
```
timeToEndAfter: string
ブラックアウトを終了するようスケジュールされている期間の開始時間。タイムスタンプは分精度であり、タイムゾーンを指定できます。
例:
```
2021-03-01T21:23+01:00
```
timeToEndBefore: string
ブラックアウトを終了するようスケジュールされている期間の終了時間。タイムスタンプは分精度であり、タイムゾーンを指定できます。
例:
```
2021-03-01T21:23+01:00
```
timeToStartAfter: string
ブラックアウトを開始するようスケジュールされている期間の開始時間。タイムスタンプは分精度であり、タイムゾーンを指定できます。
例:
```
2021-03-01T21:23+01:00
```
timeToStartBefore: string
ブラックアウトを開始するようスケジュールされている期間の終了時間。タイムスタンプは分精度であり、タイムゾーンを指定できます。
例:
```
2021-03-01T21:23+01:00
```
type: array[string]

ブラックアウトのタイプ。有効な値は、PATCHING、NOTIFICATIONまたはNOTIFICATION_MAINTENANCEです

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: BlackoutCollection

型: object

これは、ブラックアウト・サマリーのリストの表現です。

ソースの表示

count(必須): integer

このページ内のブラックアウトの数

例: 1
items(必須): array items

ブラックアウト・サマリー
links(必須): object links

結果セットのナビゲーション・リンク。
total: integer

このリクエストでのブラックアウトの合計数。これはリクエストに明示的に含める必要があります。

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of a list of blackout summaries.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of blackouts in this page",
            "example":1
        },
        "total":{
            "type":"integer",
            "description":"Total number of blackouts in this request. This has to be explicitly included in the request."
        },
        "items":{
            "type":"array",
            "description":"Blackout summaries",
            "items":{
                "$ref":"#/components/schemas/BlackoutSummary"
            }
        },
        "links":{
            "type":"object",
            "description":"Result set navigation links.",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the current page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the previous page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts?page=THE_PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the next page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/blackouts?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

型: array

ブラックアウト・サマリー

ソースの表示

配列: object BlackoutSummary

これは、ブラックアウト・サマリーの表現です。

{
    "type":"array",
    "description":"Blackout summaries",
    "items":{
        "$ref":"#/components/schemas/BlackoutSummary"
    }
}

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

型: object

結果セットのナビゲーション・リンク。

ソースの表示

next: next
previous: previous
self: self

{
    "type":"object",
    "description":"Result set navigation links.",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the current page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts?page=THIS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the previous page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts?page=THE_PREVIOUS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the next page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/blackouts?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

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

型: object

これは、ブラックアウト・サマリーの表現です。

ソースの表示

id(必須): string

ブラックアウトID

例:D91786E288D35455C3ADA1B329B49BB5
links(必須): object links

ターゲットに関連するリンク。
name(必須): string

ブラックアウト名

例: my_blackout
owner(必須): string

ブラックアウトの所有者。

例: scott
reason: string

ブラックアウト理由

例: Network Outage
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" ]

ブラックアウト・ステータス。
statusDisplayName: string

クライアント・ロケールでのステータス表示名。
type(必須): string

デフォルト値: PATCHING

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

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

クライアント・ロケールでのブラックアウト・タイプ表示名

例: Benachrichtigungsblackout

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of the Blackout summary.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "links",
        "owner"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Blackout type display name in the client locale",
            "example":"Benachrichtigungsblackout"
        },
        "reason":{
            "type":"string",
            "description":"blackout reason",
            "example":"Network Outage"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "statusDisplayName":{
            "type":"string",
            "description":"Status display name in the cient locale."
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout.",
            "example":"scott"
        },
        "links":{
            "type":"object",
            "description":"Target 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 the representation of the Blackout summary.",
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "status",
        "links",
        "owner"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Blackout ID",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "name":{
            "type":"string",
            "description":"Blackout Name",
            "example":"my_blackout"
        },
        "type":{
            "$ref":"#/components/schemas/BlackoutType"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"Blackout type display name in the client locale",
            "example":"Benachrichtigungsblackout"
        },
        "reason":{
            "type":"string",
            "description":"blackout reason",
            "example":"Network Outage"
        },
        "status":{
            "$ref":"#/components/schemas/BlackoutStatus"
        },
        "statusDisplayName":{
            "type":"string",
            "description":"Status display name in the cient locale."
        },
        "owner":{
            "type":"string",
            "description":"Owner of the blackout.",
            "example":"scott"
        },
        "links":{
            "type":"object",
            "description":"Target 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"
        }
    ]
}

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

型: object

ターゲットに関連するリンク。

ソースの表示

self: self
targets: targets

{
    "type":"object",
    "description":"Target 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
        }
    }
}

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

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

すべてに一致

結果セット内の次ページへのリンク。

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
結果セット内の次ページへのリンク。
例: { "href":"/em/api/blackouts?page=THE_NEXT_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the next page in the result set."
        },
        {
            "example":{
                "href":"/em/api/blackouts?page=THE_NEXT_PAGE_TOKEN"
            }
        }
    ]
}

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

すべてに一致

結果セット内の前ページへのリンク。

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
結果セット内の前ページへのリンク。
例: { "href":"/em/api/blackouts?page=THE_PREVIOUS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the previous page in the result set."
        },
        {
            "example":{
                "href":"/em/api/blackouts?page=THE_PREVIOUS_PAGE_TOKEN"
            }
        }
    ]
}

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

すべてに一致

結果セット内の現在のページへのリンク。

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
結果セット内の現在のページへのリンク。
例: { "href":"/em/api/blackouts?page=THIS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the current page in the result set."
        },
        {
            "example":{
                "href":"/em/api/blackouts?page=THIS_PAGE_TOKEN"
            }
        }
    ]
}

例

400レスポンス

サポートされていないソート方向など、無効な引数の場合

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

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"
        }
    }
}

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"
        }
    }
}

先頭に戻る