Oracle Enterprise ManagerのREST API

イメージのパッチ推奨のレポート

post

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

すべてのイメージの推奨パッチ・レポート

リクエスト

この操作にはリクエスト・パラメータはありません。

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

application/json

ルート・スキーマ: schema

型: object

ソースの表示

excludeList: array excludeList

レスポンスで指定した詳細を除外
limit: number

現在のフェッチの制限(アイテムの合計数のみをフェッチするには、limit=0を設定する必要があります)

例: 10
page: string

Base 64でエンコードされたページ

例: b2Zmc2V0OjA
sort: string

オプションのソート方向に従ってフィールドをソートします。ソートでサポートされる属性は、'imageId'、'imageName'、'imageDescription'、'targetType'、'createdBy'、'timeCreated'、'platform'、'version'、'oracleRecommendedPatchCount'、'subcribedTargetStatistics.total'、'subcribedTargetStatistics.compliantTargetCount'です。有効なソート方向には、ascとdescがあります。ソート方向を指定しない場合、デフォルトでascが使用されます。

例: imageName:asc

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchRecommendationsReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'imageId', 'imageName', 'imageDescription', 'targetType', 'createdBy', 'timeCreated', 'platform', 'version', 'oracleRecommendedPatchCount', 'subcribedTargetStatistics.total', 'subcribedTargetStatistics.compliantTargetCount'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"imageName:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":"10"
        },
        "excludeList":{
            "description":"exclude the given details in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "total"
                ]
            }
        }
    }
}

すべてに一致

ソースの表示

object PatchRecommendationsReportFilter

パッチ推奨レポートのフィルタ

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchRecommendationsReportFilter"
        }
    ],
    "properties":{
        "sort":{
            "description":"Sort field along with an optional sort direction. The supported attributes for sorting are 'imageId', 'imageName', 'imageDescription', 'targetType', 'createdBy', 'timeCreated', 'platform', 'version', 'oracleRecommendedPatchCount', 'subcribedTargetStatistics.total', 'subcribedTargetStatistics.compliantTargetCount'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.",
            "type":"string",
            "example":"imageName:asc"
        },
        "page":{
            "description":"Base 64 encoded page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "limit":{
            "description":"limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)",
            "type":"number",
            "example":"10"
        },
        "excludeList":{
            "description":"exclude the given details in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "total"
                ]
            }
        }
    }
}

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

型: array

レスポンスで指定した詳細を除外

ソースの表示

配列: string

指定可能な値: [ "total" ]

{
    "description":"exclude the given details in response",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "total"
        ]
    }
}

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

型: object

パッチ推奨レポートのフィルタ

ソースの表示

imageDescriptionMatches: string

イメージの説明のワイルドカード検索

例: image%
imageNameMatches: string

イメージ名のワイルドカード検索

例: db19%
isCurrentVersionUptoDate: boolean

推奨パッチがない現在のバージョンのイメージをフィルタするフラグ
isNonCurrentVersionUptodate: boolean

推奨パッチがない現在以外のバージョンのイメージをフィルタするフラグ
platform: string

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

例: linux_x64_86
targetTypeList: array targetTypeList

ターゲット・タイプのリスト
versionMatches: string

イメージ・バージョンのワイルドカード検索

例: 19.14%

{
    "description":"Filters for the patch recommendations report",
    "type":"object",
    "properties":{
        "targetTypeList":{
            "description":"List of target types",
            "type":"array",
            "items":{
                "enum":[
                    "oracle_database",
                    "rac_database",
                    "cluster",
                    "has"
                ]
            }
        },
        "imageNameMatches":{
            "description":"Wildcard search on the image name",
            "type":"string",
            "example":"db19%"
        },
        "imageDescriptionMatches":{
            "description":"Wildcard search on the image description",
            "type":"string",
            "example":"image%"
        },
        "versionMatches":{
            "description":"Wildcard search on the image version",
            "type":"string",
            "example":"19.14%"
        },
        "platform":{
            "description":"Platform of the image",
            "type":"string",
            "example":"linux_x64_86"
        },
        "isCurrentVersionUptoDate":{
            "description":"Flag to filter images, which have current version that do not have any recommended patches",
            "type":"boolean"
        },
        "isNonCurrentVersionUptodate":{
            "description":"Flag to filter images, which have non-current version that do not have any recommended patches",
            "type":"boolean"
        }
    }
}

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

型: array

ターゲット・タイプのリスト

ソースの表示

配列:

指定可能な値: [ "oracle_database", "rac_database", "cluster", "has" ]

{
    "description":"List of target types",
    "type":"array",
    "items":{
        "enum":[
            "oracle_database",
            "rac_database",
            "cluster",
            "has"
        ]
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。パッチ推奨レポートの詳細が取得されました。

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

object GoldImagePatchRecommendationsReport

イメージ詳細

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImagePatchRecommendationsReport"
        }
    ]
}

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

型: object

イメージ詳細

ソースの表示

count: number

現在のフェッチ内のサブスクライブされたターゲットの数

例: 10
currentPage: string

Base 64でエンコードされた現在のページ

例: b2Zmc2V0OjA
items: array items

ターゲットのリスト
nextPage: string

Base 64でエンコードされた次のページ

例: b2Zmc2V0OjA
previousPage: string

Base 64でエンコードされた前のページ

例: b2Zmc2V0OjA
total: number

イメージにサブスクライブしているターゲットの合計数

例: 100

{
    "description":"Image details",
    "type":"object",
    "properties":{
        "currentPage":{
            "description":"Base 64 encoded current page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "previousPage":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "total":{
            "description":"Total count of targets subscribed to images",
            "type":"number",
            "example":"100"
        },
        "count":{
            "description":"count of subscribed targets in the current fetch",
            "type":"number",
            "example":"10"
        },
        "items":{
            "description":"list of targets",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/PatchRecommendationReportSummary"
                    }
                ]
            }
        }
    }
}

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

型: array

ターゲットのリスト

ソースの表示

配列: items

{
    "description":"list of targets",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/PatchRecommendationReportSummary"
            }
        ]
    }
}

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

すべてに一致

ソースの表示

object PatchRecommendationReportSummary

パッチ推奨レポートを含むイメージのサマリー

{
    "allOf":[
        {
            "$ref":"#/components/schemas/PatchRecommendationReportSummary"
        }
    ]
}

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

型: object

パッチ推奨レポートを含むイメージのサマリー

ソースの表示

createdBy: string

ゴールド・イメージの所有者

例: SYSMAN
currentVersionDescription: string

現在のバージョンのイメージの説明

例: 19c RU14 image
currentVersionName: string

現在のバージョンのイメージの名前

例: version05
imageDescription: string

Base 64でエンコードされた前のページ

例: database image with version 19.14
imageId: string

イメージのID

例: F444A18141937212E05380FE4564170A
imageName: string

イメージの名前

例: db19_14
isCurrentVersionUptoDate: boolean

フラグは、現在のバージョンのイメージに推奨パッチがないかどうかを示します
isFppImage: boolean

フラグはイメージがFPPかどうかを示します
isNonCurrentVersionUptodate: boolean

フラグは、現在以外のバージョンのイメージに推奨パッチがないかどうかを示します
platform: string

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

例: linux_x64_86
recommendedPatchCount: number

推奨パッチ数

例: 5
subcribedTargetStatistics: object subcribedTargetStatistics

サブスクライブされたターゲットの統計
targetType: string

イメージのターゲット・タイプ

例: oracle_database
timeCreated: string (date-time)

ゴールド・イメージの作成時間

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

isNonCurrentVersionUptodateフラグがtrueの場合、このフィールドには現在以外のイメージ・バージョン名が含まれています

例: version5
version: string

イメージのバージョン

例: 19.14.0.0.0

{
    "description":"Summary of image with Patch recommendation report",
    "type":"object",
    "properties":{
        "imageId":{
            "description":"Id of the image",
            "type":"string",
            "example":"F444A18141937212E05380FE4564170A"
        },
        "imageName":{
            "description":"Name of the image",
            "type":"string",
            "example":"db19_14"
        },
        "imageDescription":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"database image with version 19.14"
        },
        "isFppImage":{
            "description":"Flag indicate if the image is FPP",
            "type":"boolean"
        },
        "version":{
            "description":"Version the of the image",
            "type":"string",
            "example":"19.14.0.0.0"
        },
        "currentVersionName":{
            "description":"Name of the current version of image",
            "type":"string",
            "example":"version05"
        },
        "currentVersionDescription":{
            "description":"Description of the current version of image",
            "type":"string",
            "example":"19c RU14 image"
        },
        "targetType":{
            "description":"Target type of image",
            "type":"string",
            "example":"oracle_database"
        },
        "platform":{
            "description":"Platform for the image",
            "type":"string",
            "example":"linux_x64_86"
        },
        "timeCreated":{
            "description":"Creation time of the Gold Image",
            "type":"string",
            "format":"date-time",
            "example":"2022-08-22 00:10:27.0"
        },
        "createdBy":{
            "description":"Owner of Gold Image",
            "type":"string",
            "example":"SYSMAN"
        },
        "isCurrentVersionUptoDate":{
            "description":"Flag indicates if the current version of image does not have recommended patches",
            "type":"boolean"
        },
        "isNonCurrentVersionUptodate":{
            "description":"Flag indicates if the non-current version of image does not have recommended patches",
            "type":"boolean"
        },
        "uptodateNonCurrentImageVersionName":{
            "description":"When isNonCurrentVersionUptodate flag is true, this field contains uptodate noncurrent image version name",
            "type":"string",
            "example":"version5"
        },
        "recommendedPatchCount":{
            "description":"Count of recommended patches",
            "type":"number",
            "example":"5"
        },
        "subcribedTargetStatistics":{
            "description":"Statistics of the subscribed targets",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/SubscribedTargetStatistics"
                }
            ]
        }
    }
}

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

型: object

サブスクライブされたターゲットの統計

すべてに一致

ソースの表示

object SubscribedTargetStatistics

サブスクライブされたターゲットの統計

{
    "description":"Statistics of the subscribed targets",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/SubscribedTargetStatistics"
        }
    ]
}

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

型: object

サブスクライブされたターゲットの統計

ソースの表示

compliantTargetCount: number

コンプライアンス・ターゲットの数

例: 95
containedPdbCount: number

含まれているPDB数

例: 20
total: number

サブスクライブされたターゲットの合計数

例: 100

{
    "description":"Statistics of the subscribed targets",
    "type":"object",
    "properties":{
        "total":{
            "description":"Count of total subscribed targets",
            "type":"number",
            "example":"100"
        },
        "containedPdbCount":{
            "description":"Count of contained PDBs count",
            "type":"number",
            "example":"20"
        },
        "compliantTargetCount":{
            "description":"Count of compliant targets",
            "type":"number",
            "example":"95"
        }
    }
}

例

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

先頭に戻る