Oracle Enterprise ManagerのREST API

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

ブラックアウトに含まれているターゲットの取得

get

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

このAPIは、ブラックアウトに含まれているターゲットを返します。

リクエスト

パス・パラメータ

blackoutId(必須): string

ブラックアウトID

問合せパラメータ

limit: integer(int32)
最小値: 1

最大値: 2000

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

ターゲットの名前。
nameMatches: array[string]

ターゲットの名前一致。
page: string

self、nextおよびpreviousリンクにおいて使用されるシステム生成ページ・トークン。
sort: string
ソート・フィールドと方向。指定可能なソート・フィールドはnameとidです。指定可能な方向はASCとDESCです。
例:
```
id:ASC
```
typeName: array[string]

ターゲットのタイプ名。
typeNameMatches: array[string]

ターゲットのタイプ名一致。

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: TargetCollection

型: object

これはターゲット参照のリストを表すものです。

ソースの表示

count(必須): integer

このページにあるアイテムの数

例: 20
items(必須): array items

ターゲット参照
links(必須): object links

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

結果の合計数

例: 42

{
    "x-em-sdk-level":"emSDK",
    "description":"This is the representation of list of target references.",
    "type":"object",
    "required":[
        "items",
        "links",
        "count"
    ],
    "properties":{
        "count":{
            "type":"integer",
            "description":"the number of items in this page",
            "example":20
        },
        "total":{
            "type":"integer",
            "description":"the total number of results",
            "example":42
        },
        "items":{
            "type":"array",
            "description":"the target references",
            "items":{
                "$ref":"#/components/schemas/TargetSummary"
            }
        },
        "links":{
            "type":"object",
            "description":"the result set navigation links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the curent page in the result set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the previous page in the result set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets?page=THE_PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the next page in the result set"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

型: array

ターゲット参照

ソースの表示

配列: object TargetSummary

これはターゲット参照です。

{
    "type":"array",
    "description":"the target references",
    "items":{
        "$ref":"#/components/schemas/TargetSummary"
    }
}

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

型: object

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

ソースの表示

next: next
previous: previous
self: self

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

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

型: object

これはターゲット参照です。

ソースの表示

displayName(必須): string

ターゲットの表示

例: My Database Instance
id(必須): string

ターゲットID

例:D91786E288D35455C3ADA1B329B49BB5
links: object links

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

ターゲット名

例: my_database
owner(必須): string

ターゲットの所有者

例: scott
status: string

指定可能な値: [ "DOWN", "UP", "METRIC_ERROR", "AGENT_DOWN", "UNREACHABLE", "BLACKOUT", "PENDING", "REMOTE_HOST_UNREACHABLE" ]

これはターゲット・ステータスを表すものです。
typeDisplayName(必須): string

ターゲットのタイプ表示名

例: Datenbankinstanz
typeName: string

ターゲット・タイプ名

例: oracle_database

{
    "x-em-sdk-level":"emSDK",
    "description":"This is a target reference.",
    "type":"object",
    "required":[
        "type",
        "name",
        "id",
        "displayName",
        "typeDisplayName",
        "owner"
    ],
    "properties":{
        "typeName":{
            "type":"string",
            "description":"the target type name",
            "example":"oracle_database"
        },
        "name":{
            "type":"string",
            "description":"the target name",
            "example":"my_database"
        },
        "id":{
            "type":"string",
            "description":"the target if",
            "example":"D91786E288D35455C3ADA1B329B49BB5"
        },
        "displayName":{
            "type":"string",
            "description":"the display of the target",
            "example":"My Database Instance"
        },
        "typeDisplayName":{
            "type":"string",
            "description":"the type display name of the target",
            "example":"Datenbankinstanz"
        },
        "owner":{
            "type":"string",
            "description":"the owner of the target",
            "example":"scott"
        },
        "status":{
            "$ref":"#/components/schemas/TargetStatus"
        },
        "links":{
            "type":"object",
            "description":"the target related links",
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"The link to the target"
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

型: object

ターゲット関連リンク

ソースの表示

self: self

{
    "type":"object",
    "description":"the target related links",
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"The link to the target"
                },
                {
                    "example":{
                        "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5"
                    }
                }
            ]
        }
    }
}

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

すべてに一致

ターゲットへのリンク

ソースの表示

object Link

リンクを表します(self、previous、nextのいずれか)
ターゲットへのリンク
例: { "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"The link to the target"
        },
        {
            "example":{
                "href":"/em/api/targets/D91786E288D35455C3ADA1B329B49BB5"
            }
        }
    ]
}

ネストされたスキーマ: 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/targets?page=THE_NEXT_PAGE_TOKEN" }

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

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

すべてに一致

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

ソースの表示

object Link

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

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

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

すべてに一致

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

ソースの表示

object Link

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

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

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

先頭に戻る