Oracle Enterprise ManagerのREST API

FPPサーバーのリスト

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fppServers

Enterprise Managerに登録されたFPPサーバーをリストします

リクエスト

問合せパラメータ

limit: integer(int32)
レスポンス内のアイテム数を制限します
例:
```
10
```
page: string
アイテムの次のセット(ページ)を示すマーカー
例:
```
b2Zmc2V0OjA
```
sort: string
フィールドとソート方向(オプション)のカンマ区切りリスト。ソートでサポートされている属性は'targetName'です。有効なソート方向にはascとdescがあります。ソート方向を指定しない場合、デフォルトでascが使用されます。
例:
```
targetName:asc
```

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。FPPサーバーのリストが取得されました。

ルート・スキーマ: FppServerCollection

型: object

FPPサーバーのリスト

ソースの表示

items: array items

FPPサーバーの詳細の配列

{
    "description":"List of the FPP servers",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        }
    ],
    "properties":{
        "items":{
            "description":"Array of the FPP server details",
            "type":"array",
            "items":{
                "description":"FPP server details",
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "targetId":{
                        "description":"ID of the target",
                        "type":"string"
                    },
                    "links":{
                        "type":"object",
                        "description":"Navigation links",
                        "properties":{
                            "self":{
                                "$ref":"#/components/schemas/Link"
                            }
                        }
                    }
                }
            }
        }
    }
}

すべてに一致

ソースの表示

object Pagination

リンク付きのアイテムのコレクション

{
    "description":"List of the FPP servers",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        }
    ],
    "properties":{
        "items":{
            "description":"Array of the FPP server details",
            "type":"array",
            "items":{
                "description":"FPP server details",
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "targetId":{
                        "description":"ID of the target",
                        "type":"string"
                    },
                    "links":{
                        "type":"object",
                        "description":"Navigation links",
                        "properties":{
                            "self":{
                                "$ref":"#/components/schemas/Link"
                            }
                        }
                    }
                }
            }
        }
    }
}

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

型: array

FPPサーバーの詳細の配列

ソースの表示

配列: object items

FPPサーバーの詳細

{
    "description":"Array of the FPP server details",
    "type":"array",
    "items":{
        "description":"FPP server details",
        "type":"object",
        "allOf":[
            {
                "$ref":"#/components/schemas/Target"
            }
        ],
        "properties":{
            "targetId":{
                "description":"ID of the target",
                "type":"string"
            },
            "links":{
                "type":"object",
                "description":"Navigation links",
                "properties":{
                    "self":{
                        "$ref":"#/components/schemas/Link"
                    }
                }
            }
        }
    }
}

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

型: object

リンク付きのアイテムのコレクション

ソースの表示

count: integer

このフェッチの数

例: 40
links: object Links

リンクの配列を表します
total: integer

合計数

例: 40

{
    "description":"Collection of items with links",
    "properties":{
        "total":{
            "type":"integer",
            "description":"total count",
            "example":"40"
        },
        "count":{
            "type":"integer",
            "description":"Count of this fetch",
            "example":"40"
        },
        "links":{
            "$ref":"#/components/schemas/Links"
        }
    }
}

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

型: object

FPPサーバーの詳細

ソースの表示

links: object links

ナビゲーション・リンク
targetId: string

ターゲットのID

{
    "description":"FPP server details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the target",
            "type":"string"
        },
        "links":{
            "type":"object",
            "description":"Navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

すべてに一致

ソースの表示

object schema

ターゲットの詳細

{
    "description":"FPP server details",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the target",
            "type":"string"
        },
        "links":{
            "type":"object",
            "description":"Navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

ナビゲーション・リンク

ソースの表示

self: object Link

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

{
    "type":"object",
    "description":"Navigation links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

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

型: object

ターゲットの詳細

ソースの表示

targetName: string

ターゲットの名前

例: sales_db1
targetType: string

ターゲットのタイプ

例: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

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

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

型: object

リンクの配列を表します

ソースの表示

next: object Link

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

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

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

{
    "description":"Represents the array of links",
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

例

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

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

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

ルート・スキーマ: 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レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

ルート・スキーマ: 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レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

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

先頭に戻る