Oracle Enterprise ManagerのREST API

FPPサーバーの詳細の取得

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/fppServers/{fppServerId}

クライアントおよびRESTユーザーを含め、FPPサーバーの詳細を取得します

リクエスト

パス・パラメータ

fppServerId(必須): string

FPPサーバーのID

問合せパラメータ

expand: string

restUsers、clients、propertiesが使用可能な値です

指定可能な値: [ "restUsers", "clients", "properties" ]

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。FPPサーバー登録の詳細が取得されました。

ルート・スキーマ: FppServer

型: object

FPPサーバー登録のサマリー

ソースの表示

clients: array clients

FPPサーバーに登録されたクライアントの詳細
links: object FppServerLinks

FPPサーバーの詳細のサブリソース・リンク
properties: array properties

FPPサーバーに登録されたプロパティの詳細
restUsers: array restUsers

FPPサーバーに登録されたRESTユーザーの詳細
targetId: string

FPPサーバーが実行されているクラスタ・ターゲットのID
totalClients: integer

FPPサーバーに登録されたクライアントの合計数
totalProperties: integer

FPPサーバーに登録されたプロパティの合計数
totalRestUsers: integer

FPPサーバーに登録されたRESTユーザーの合計数

{
    "description":"FPP server registration summary",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the cluster target, where the FPP server is running",
            "type":"string"
        },
        "totalRestUsers":{
            "description":"Total count of REST users registered with the FPP server",
            "type":"integer"
        },
        "totalClients":{
            "description":"Total count of clients registered with the FPP server",
            "type":"integer"
        },
        "totalProperties":{
            "description":"Total count of properties registered with the FPP server",
            "type":"integer"
        },
        "links":{
            "$ref":"#/components/schemas/FppServerLinks"
        },
        "restUsers":{
            "description":"REST user details registered with the FPP server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CreateRestUserDetails"
            }
        },
        "clients":{
            "description":"Client details registered with the FPP server",
            "type":"array",
            "items":{
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "targetId":{
                        "description":"ID of the FPP client target",
                        "type":"string"
                    }
                }
            }
        },
        "properties":{
            "description":"Property details registered with the FPP server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertySummary"
            }
        }
    }
}

すべてに一致

ソースの表示

object schema

ターゲットの詳細

{
    "description":"FPP server registration summary",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the cluster target, where the FPP server is running",
            "type":"string"
        },
        "totalRestUsers":{
            "description":"Total count of REST users registered with the FPP server",
            "type":"integer"
        },
        "totalClients":{
            "description":"Total count of clients registered with the FPP server",
            "type":"integer"
        },
        "totalProperties":{
            "description":"Total count of properties registered with the FPP server",
            "type":"integer"
        },
        "links":{
            "$ref":"#/components/schemas/FppServerLinks"
        },
        "restUsers":{
            "description":"REST user details registered with the FPP server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CreateRestUserDetails"
            }
        },
        "clients":{
            "description":"Client details registered with the FPP server",
            "type":"array",
            "items":{
                "type":"object",
                "allOf":[
                    {
                        "$ref":"#/components/schemas/Target"
                    }
                ],
                "properties":{
                    "targetId":{
                        "description":"ID of the FPP client target",
                        "type":"string"
                    }
                }
            }
        },
        "properties":{
            "description":"Property details registered with the FPP server",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertySummary"
            }
        }
    }
}

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

型: array

FPPサーバーに登録されたクライアントの詳細

ソースの表示

配列: object items

{
    "description":"Client details registered with the FPP server",
    "type":"array",
    "items":{
        "type":"object",
        "allOf":[
            {
                "$ref":"#/components/schemas/Target"
            }
        ],
        "properties":{
            "targetId":{
                "description":"ID of the FPP client target",
                "type":"string"
            }
        }
    }
}

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

型: object

FPPサーバーの詳細のサブリソース・リンク

ソースの表示

clients(必須): object Link

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

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

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

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

{
    "description":"Subresource links for the FPP server details",
    "type":"object",
    "required":[
        "self",
        "restUsers",
        "clients",
        "properties"
    ],
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "restUsers":{
            "$ref":"#/components/schemas/Link"
        },
        "clients":{
            "$ref":"#/components/schemas/Link"
        },
        "properties":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

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

型: array

FPPサーバーに登録されたプロパティの詳細

ソースの表示

配列: object PropertySummary

プロパティの詳細

{
    "description":"Property details registered with the FPP server",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PropertySummary"
    }
}

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

型: array

FPPサーバーに登録されたRESTユーザーの詳細

ソースの表示

配列: object CreateRestUserDetails

RESTユーザーの詳細

{
    "description":"REST user details registered with the FPP server",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CreateRestUserDetails"
    }
}

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

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

型: object

ソースの表示

targetId: string

FPPクライアント・ターゲットのID

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the FPP client target",
            "type":"string"
        }
    }
}

すべてに一致

ソースの表示

object schema

ターゲットの詳細

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/Target"
        }
    ],
    "properties":{
        "targetId":{
            "description":"ID of the FPP client target",
            "type":"string"
        }
    }
}

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

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

型: object

プロパティの詳細

ソースの表示

name(必須): string

プロパティの名前
value(必須): string

プロパティの値

{
    "description":"Details of the property",
    "type":"object",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "description":"Name of the property",
            "type":"string"
        },
        "value":{
            "description":"Value of the property",
            "type":"string"
        }
    }
}

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

型: object

RESTユーザーの詳細

ソースの表示

password(必須): string (password)

FPP REST URLをコールするために必要なREST資格証明をEMで作成するためのパスワード

例: welcome1
username(必須): string

FPPサーバーに登録するRESTユーザー名

{
    "description":"Details of REST user",
    "required":[
        "username",
        "password"
    ],
    "properties":{
        "username":{
            "description":"REST username to be registered with the FPP server",
            "type":"string"
        },
        "password":{
            "description":"Password to create the REST credential in EM, which is required to make a call to the FPP REST URL",
            "type":"string",
            "format":"password",
            "example":"welcome1"
        }
    }
}

例

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

先頭に戻る