Oracle Enterprise ManagerのREST API

イメージおよびサブスクリプションのサマリーの取得

post

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

イメージおよびターゲットおよびサブスクリプションの統計、コンプライアンスを取得します

リクエスト

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

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

application/json

ルート・スキーマ: schema

型: object

ソースの表示

excludeList: array excludeList

指定されたサマリーを除外

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GlobalTargetFilter"
        }
    ],
    "properties":{
        "excludeList":{
            "description":"exclude the given summaries",
            "type":"array",
            "items":{
                "enum":[
                    "subscriptions",
                    "images",
                    "targets"
                ]
            }
        }
    }
}

すべてに一致

ソースの表示

object GlobalTargetFilter

グローバル・ターゲット・プロパティのフィルタ

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GlobalTargetFilter"
        }
    ],
    "properties":{
        "excludeList":{
            "description":"exclude the given summaries",
            "type":"array",
            "items":{
                "enum":[
                    "subscriptions",
                    "images",
                    "targets"
                ]
            }
        }
    }
}

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

型: array

指定されたサマリーを除外

ソースの表示

配列:

指定可能な値: [ "subscriptions", "images", "targets" ]

{
    "description":"exclude the given summaries",
    "type":"array",
    "items":{
        "enum":[
            "subscriptions",
            "images",
            "targets"
        ]
    }
}

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

型: object

グローバル・ターゲット・プロパティのフィルタ

ソースの表示

dbMachineType: string

デフォルト値: BOTH

指定可能な値: [ "BOTH", "STAND_ALONE", "EXADATA" ]

データベースが存在するマシン・タイプ
targetProperties: targetProperties

ターゲットのプロパティ
targetTypeList: array targetTypeList

ターゲット・タイプ

{
    "description":"Global target property filters",
    "type":"object",
    "properties":{
        "targetTypeList":{
            "description":"Target type",
            "type":"array",
            "items":{
                "enum":[
                    "oracle_database",
                    "rac_database",
                    "cluster",
                    "has"
                ]
            }
        },
        "targetProperties":{
            "description":"Properties of target",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TargetPropertyFilter"
                }
            ]
        },
        "dbMachineType":{
            "description":"Machine type on which the database is present",
            "type":"string",
            "enum":[
                "BOTH",
                "STAND_ALONE",
                "EXADATA"
            ],
            "default":"BOTH"
        }
    }
}

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

ターゲットのプロパティ

すべてに一致

ソースの表示

object TargetPropertyFilter

ターゲット・プロパティのフィルタ

{
    "description":"Properties of target",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetPropertyFilter"
        }
    ]
}

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

型: array

ターゲット・タイプ

ソースの表示

配列:

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

{
    "description":"Target type",
    "type":"array",
    "items":{
        "enum":[
            "oracle_database",
            "rac_database",
            "cluster",
            "has"
        ]
    }
}

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

型: object

ターゲット・プロパティのフィルタ

ソースの表示

contactList: array contactList

連絡先のリスト
costCenterList: array costCenterList

コスト・センターのリスト
departmentList: array departmentList

部門のリスト
downtimeContactList: array downtimeContactList

停止時の連絡先のリスト
lifecycleStatusList: array lifecycleStatusList

ライフサイクルステータスのリスト
lineOfBusinessList: array lineOfBusinessList

ライン・オブ・ビジネスのリスト
locationList: array locationList

場所のリスト
siteList: array siteList

サイトのリスト

{
    "description":"Target property filters",
    "type":"object",
    "properties":{
        "contactList":{
            "description":"List of contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "downtimeContactList":{
            "description":"List of downtime contacts",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "costCenterList":{
            "description":"List of cost centers",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "departmentList":{
            "description":"List of departments",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lineOfBusinessList":{
            "description":"List of line of business",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "locationList":{
            "description":"List of locations",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "siteList":{
            "description":"List of sites",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "lifecycleStatusList":{
            "description":"List of lifecyclestatus",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

連絡先のリスト

ソースの表示

配列: string

{
    "description":"List of contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

コスト・センターのリスト

ソースの表示

配列: string

{
    "description":"List of cost centers",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

部門のリスト

ソースの表示

配列: string

{
    "description":"List of departments",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

停止時の連絡先のリスト

ソースの表示

配列: string

{
    "description":"List of downtime contacts",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ライフサイクルステータスのリスト

ソースの表示

配列: string

{
    "description":"List of lifecyclestatus",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ライン・オブ・ビジネスのリスト

ソースの表示

配列: string

{
    "description":"List of line of business",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

場所のリスト

ソースの表示

配列: string

{
    "description":"List of locations",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

サイトのリスト

ソースの表示

配列: string

{
    "description":"List of sites",
    "type":"array",
    "items":{
        "type":"string"
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。サマリー詳細が取得されました。

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

object GoldImageAndSubscriptionSummary

イメージおよびサブスクリプションの統計

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

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

型: object

イメージおよびサブスクリプションの統計

ソースの表示

images: array images

イメージ・ステータス別にグループ化されたイメージの統計(uptodate、uptodateVersionNotCurrent、needOracleRecommendedPatches)
subscriptions: array subscriptions

ターゲット・タイプ別にグループ化されたサブスクリプションの統計
targets: array targets

パッチレベル別にグループ化されたターゲットの統計(現在/現在以外)

{
    "description":"Image and Subscription statistics",
    "type":"object",
    "properties":{
        "subscriptions":{
            "description":"Statistics of subscriptions grouped by target type",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/SubscriptionStatistics"
                    }
                ]
            }
        },
        "images":{
            "description":"Statistics of images grouped by image status (uptodate, uptodateVersionNotCurrent, needOracleRecommendedPatches)",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/ImageStatistics"
                    }
                ]
            }
        },
        "targets":{
            "description":"Statistics of targets grouped by patchlevel (current/non-current)",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetStatistics"
                    }
                ]
            }
        }
    }
}

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

型: array

イメージ・ステータス別にグループ化されたイメージの統計(uptodate、uptodateVersionNotCurrent、needOracleRecommendedPatches)

ソースの表示

配列: items

{
    "description":"Statistics of images grouped by image status (uptodate, uptodateVersionNotCurrent, needOracleRecommendedPatches)",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/ImageStatistics"
            }
        ]
    }
}

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

型: array

ターゲット・タイプ別にグループ化されたサブスクリプションの統計

ソースの表示

配列: items

{
    "description":"Statistics of subscriptions grouped by target type",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/SubscriptionStatistics"
            }
        ]
    }
}

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

型: array

パッチレベル別にグループ化されたターゲットの統計(現在/現在以外)

ソースの表示

配列: items

{
    "description":"Statistics of targets grouped by patchlevel (current/non-current)",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetStatistics"
            }
        ]
    }
}

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

すべてに一致

ソースの表示

object ImageStatistics

イメージの統計

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

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

型: object

イメージの統計

ソースの表示

categories: array categories

uptodateおよびneedOracleRecommendedPatchesであるイメージ数が含まれます
total: number

イメージの合計数

例: 100

{
    "description":"Statistics of the images",
    "type":"object",
    "properties":{
        "total":{
            "description":"Total number of images",
            "type":"number",
            "example":"100"
        },
        "categories":{
            "description":"Includes the count of images, which are uptodate and needOracleRecommendedPatches",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/ImageCategoryStatistics"
                    }
                ]
            }
        }
    }
}

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

型: array

uptodateおよびneedOracleRecommendedPatchesであるイメージ数が含まれます

ソースの表示

配列: items

{
    "description":"Includes the count of images, which are uptodate and needOracleRecommendedPatches",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/ImageCategoryStatistics"
            }
        ]
    }
}

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

すべてに一致

ソースの表示

object ImageCategoryStatistics

イメージ・カテゴリの統計

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

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

型: object

イメージ・カテゴリの統計

ソースの表示

count: number

イメージ数

例: 50
name: string

指定可能な値: [ "uptodate", "needOracleRecommendedPatches" ]

イメージ・カテゴリの名前

{
    "description":"Statistics of image category",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the image category",
            "type":"string",
            "enum":[
                "uptodate",
                "needOracleRecommendedPatches"
            ]
        },
        "count":{
            "description":"Count of images",
            "type":"number",
            "example":"50"
        }
    }
}

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

すべてに一致

ソースの表示

object SubscriptionStatistics

サブスクリプションの統計

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

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

型: object

サブスクリプションの統計

ソースの表示

targetType: string

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

ターゲット・タイプ
total: number

ターゲット数

例: 100
unsubscribedCount: number

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

例: 50

{
    "description":"Statistics of the subscriptions",
    "type":"object",
    "properties":{
        "targetType":{
            "description":"Target type",
            "type":"string",
            "enum":[
                "oracle_database",
                "rac_database",
                "cluster",
                "has"
            ]
        },
        "total":{
            "description":"Count of targets",
            "type":"number",
            "example":"100"
        },
        "unsubscribedCount":{
            "description":"Count of unsubscribed targets",
            "type":"number",
            "example":"50"
        }
    }
}

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

すべてに一致

ソースの表示

object TargetStatistics

ターゲットの統計

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

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

型: object

ターゲットの統計

ソースの表示

categories: array categories

現在のイメージ・バージョンおよび現在以外のイメージ・バージョンにサブスクライブされているターゲットの数が含まれます
total: number

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

例: 100

{
    "description":"Statistics of the targets",
    "type":"object",
    "properties":{
        "total":{
            "description":"Total number of subscribed targets",
            "type":"number",
            "example":"100"
        },
        "categories":{
            "description":"Includes the count of the targets subscribed to current and non-current image version",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/components/schemas/TargetCategoryStatistics"
                    }
                ]
            }
        }
    }
}

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

型: array

現在のイメージ・バージョンおよび現在以外のイメージ・バージョンにサブスクライブされているターゲットの数が含まれます

ソースの表示

配列: items

{
    "description":"Includes the count of the targets subscribed to current and non-current image version",
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/components/schemas/TargetCategoryStatistics"
            }
        ]
    }
}

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

すべてに一致

ソースの表示

object TargetCategoryStatistics

ターゲット・カテゴリの統計

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

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

型: object

ターゲット・カテゴリの統計

ソースの表示

count: number

イメージ・カテゴリにサブスクライブされているターゲットの数

例: 70
name: string

指定可能な値: [ "current", "notCurrent" ]

イメージのカテゴリ名
targetType: string

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

ターゲット・タイプ

{
    "description":"Statistics of the target category",
    "type":"object",
    "properties":{
        "targetType":{
            "description":"Target type",
            "type":"string",
            "enum":[
                "oracle_database",
                "rac_database",
                "cluster",
                "has"
            ]
        },
        "name":{
            "description":"Category name of the image",
            "type":"string",
            "enum":[
                "current",
                "notCurrent"
            ]
        },
        "count":{
            "description":"Count of the targets subscribed to the image category",
            "type":"number",
            "example":"70"
        }
    }
}

例

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

先頭に戻る