Oracle Enterprise ManagerのREST API

イメージのリスト

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages

イメージをリストします

リクエスト

問合せパラメータ

createdByMatches: string
イメージの所有者のワイルドカード検索
例:
```
ADMIN
```
descriptionMatches: string
イメージの説明のワイルドカード検索
例:
```
%image%
```
include: string

すべてのイメージ(準備完了および準備未完了のイメージ)を含めます

指定可能な値: [ "all" ]
limit: integer(int32)
レスポンス内のアイテム数を制限します
例:
```
10
```
nameMatches: string
イメージの名前のワイルドカード検索
例:
```
%DB19%
```
page: string
アイテムの次のセット(ページ)を示すマーカー
例:
```
b2Zmc2V0OjA
```
sort: string
フィールドとソート方向(オプション)のカンマ区切りリスト。ソートでサポートされている属性は'name'です。有効なソート方向は'asc'および'desc'です。ソート方向を指定しない場合、デフォルトで'asc'が使用されます。
例:
```
name:desc
```
targetType: string
イメージのターゲット・タイプ
例:
```
oracle_database
```
versionMatches: string
イメージのバージョン名のワイルドカード検索
例:
```
%19%
```

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。イメージのリストが取得されました。

ルート・スキーマ: GoldImageCollection

型: object

イメージのリスト

ソースの表示

items(必須): array items

イメージの配列

{
    "type":"object",
    "description":"List of images",
    "required":[
        "items"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        }
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Array of images",
            "items":{
                "$ref":"#/components/schemas/GoldImageSummary"
            }
        }
    }
}

すべてに一致

ソースの表示

object Pagination

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

{
    "type":"object",
    "description":"List of images",
    "required":[
        "items"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/Pagination"
        }
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"Array of images",
            "items":{
                "$ref":"#/components/schemas/GoldImageSummary"
            }
        }
    }
}

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

型: array

イメージの配列

ソースの表示

配列: GoldImageSummary

イメージのサマリー

{
    "type":"array",
    "description":"Array of images",
    "items":{
        "$ref":"#/components/schemas/GoldImageSummary"
    }
}

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

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

イメージのサマリー

すべてに一致

ソースの表示

object GoldImageCommonSummary

共通イメージ・サマリー

{
    "description":"Summary of the image",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageCommonSummary"
        }
    ]
}

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

型: object

共通イメージ・サマリー

ソースの表示

createdBy: string

イメージの所有者

例: ADMIN
description: string

イメージの説明

例: fm_1914_description
fppServer: string

isFppImageがtrueの場合、このフィールドにはイメージが存在するFPPサーバー名が含まれます

例: xyz0102c
fppUser: string

isFppImageがtrueの場合、このフィールドにはイメージへのアクセス権を持つFPPユーザー名が含まれます

例: restuser
id: string

イメージのID

例: E6C5858BD2B46B37E05380FE4564A69B
isFppImage: boolean

FPPイメージを示すフラグ

例: true
links: object links

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

イメージの名前

例: fm_1914image
platformName: string

イメージのプラットフォーム

例: Linux x86-64
timeCreated: string (date-time)

イメージの作成時間

例: 2022-08-22 00:10:27.0
version: string

イメージのバージョン

例: 19.0.0.0.0

{
    "description":"Common image summary",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the image",
            "type":"string",
            "example":"fm_1914image"
        },
        "id":{
            "description":"ID of the image",
            "type":"string",
            "example":"E6C5858BD2B46B37E05380FE4564A69B"
        },
        "isFppImage":{
            "description":"Flag to indicate FPP image",
            "type":"boolean",
            "example":true
        },
        "fppServer":{
            "description":"If isFppImage is true then this field contains FPP server name, where the image is present",
            "type":"string",
            "example":"xyz0102c"
        },
        "fppUser":{
            "description":"If isFppImage is true then this field contains FPP user name, who has access to the image",
            "type":"string",
            "example":"restuser"
        },
        "description":{
            "description":"Description of the image",
            "type":"string",
            "example":"fm_1914_description"
        },
        "version":{
            "description":"Version of the image",
            "type":"string",
            "example":"19.0.0.0.0"
        },
        "platformName":{
            "description":"Platform of the image",
            "type":"string",
            "example":"Linux x86-64"
        },
        "timeCreated":{
            "description":"Creation time of the image",
            "type":"string",
            "format":"date-time",
            "example":"2022-08-22 00:10:27.0"
        },
        "createdBy":{
            "description":"Owner of the image",
            "type":"string",
            "example":"ADMIN"
        },
        "links":{
            "type":"object",
            "description":"Navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/SelfLink"
                }
            }
        }
    }
}

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

型: object

ナビゲーション・リンク

ソースの表示

self: object SelfLink

セルフリンクを表します

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

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

型: object

セルフリンクを表します

ソースの表示

href: string

セルフリンクのURL

例: /em/api/<resources>/<resourceId>

{
    "type":"object",
    "description":"Represents a self-link",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the self-link",
            "example":"/em/api/<resources>/<resourceId>"
        }
    }
}

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

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

例

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

先頭に戻る