Oracle Enterprise ManagerのREST API

ライフサイクル・メンテナンス履歴の取得

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/lcmOperations/actions/getLcmHistory

更新(パッチ適用)およびアップグレード操作のデータベース・メンテナンス履歴を取得します。

リクエスト

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

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

application/json

ルート・スキーマ: schema

型: object

ソースの表示

limit: number

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

例: 10
page: string

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

例: b2Zmc2V0OjA
sort: string

フィールドとオプションのソート方向。ソートでサポートされる属性は、targetName、targetType、timeStarted、timeEnded、status、taskです。有効なソートの方向は'asc'および'desc'です。ソート方向を指定しない場合、デフォルトで'asc'が使用されます。

例: targetName:asc

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryDetails"
        }
    ],
    "properties":{
        "sort":{
            "description":"Field along with an optional sort direction. The supported attributes of sorting are targetName, targetType, timeStarted, timeEnded, status, task.Valid sort directions are 'asc' and 'desc'. If sort direction is not specified, 'asc' is used by default.",
            "type":"string",
            "example":"targetName: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"
        }
    }
}

すべてに一致

ソースの表示

object allOf LcmHistoryDetails

LCM履歴データを取得するためのリクエスト

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryDetails"
        }
    ],
    "properties":{
        "sort":{
            "description":"Field along with an optional sort direction. The supported attributes of sorting are targetName, targetType, timeStarted, timeEnded, status, task.Valid sort directions are 'asc' and 'desc'. If sort direction is not specified, 'asc' is used by default.",
            "type":"string",
            "example":"targetName: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"
        }
    }
}

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

型: object

LCM履歴データを取得するためのリクエスト

ソースの表示

exclusions: array exclusions

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

{
    "description":"Request to retrieve LCM history data",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryFilter"
        }
    ],
    "properties":{
        "exclusions":{
            "description":"Exclude the given details in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "total"
                ]
            }
        }
    }
}

すべてに一致

ソースの表示

object LcmHistoryFilter

LCM履歴データのフィルタ

{
    "description":"Request to retrieve LCM history data",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryFilter"
        }
    ],
    "properties":{
        "exclusions":{
            "description":"Exclude the given details in response",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "total"
                ]
            }
        }
    }
}

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

型: object

LCM履歴データのフィルタ

ソースの表示

status: string

指定可能な値: [ "SCHEDULED", "RUNNING", "ACTION_REQUIRED", "PAUSED", "FAILED", "COMPLETED", "ABORTED", "SKIPPED", "SAVED", "COMPLETED_WITH_ERROR" ]

タスクのステータス

例: COMPLETED
submittedBy: string

操作を発行したOEMユーザー

例: SYSMAN
targetIds: array targetIds

ターゲットIDのリスト
targetNames: array targetNames

ターゲット名のリスト
targetType: string

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

ターゲット・タイプ
tasks: string

指定可能な値: [ "UPDATE", "UPGRADE" ]

タスクのリスト
timeStartedGreaterThanOrEqualTo: string

指定時間以降

例: 2023-01-30 10:00:00
timeStartedLesserThanOrEqualTo: string

指定時間まで

例: 2023-01-30 10:00:11

{
    "description":"Filter for LCM history data",
    "type":"object",
    "properties":{
        "targetNames":{
            "description":"List of target names",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "Prod DB",
                "HR DB"
            ]
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "enum":[
                "oracle_database",
                "oracle_pdb",
                "cluster",
                "rac_database",
                "has"
            ]
        },
        "targetIds":{
            "description":"List of target IDs",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":[
                "E5B98897FE871AC1E05380FE4564F682",
                "ADB98897FE871AC1E05380FE4564F555"
            ]
        },
        "tasks":{
            "description":"List of tasks",
            "type":"string",
            "enum":[
                "UPDATE",
                "UPGRADE"
            ]
        },
        "timeStartedGreaterThanOrEqualTo":{
            "description":"Since the given time",
            "type":"string",
            "example":"2023-01-30 10:00:00"
        },
        "timeStartedLesserThanOrEqualTo":{
            "description":"Until the given time",
            "type":"string",
            "example":"2023-01-30 10:00:11"
        },
        "status":{
            "description":"status of task",
            "type":"string",
            "enum":[
                "SCHEDULED",
                "RUNNING",
                "ACTION_REQUIRED",
                "PAUSED",
                "FAILED",
                "COMPLETED",
                "ABORTED",
                "SKIPPED",
                "SAVED",
                "COMPLETED_WITH_ERROR"
            ],
            "example":"COMPLETED"
        },
        "submittedBy":{
            "description":"OEM user that submitted the operation",
            "type":"string",
            "example":"SYSMAN"
        }
    }
}

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

型: array

ターゲットIDのリスト

ソースの表示

配列: string

{
    "description":"List of target IDs",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "E5B98897FE871AC1E05380FE4564F682",
        "ADB98897FE871AC1E05380FE4564F555"
    ]
}

例:

[
    "E5B98897FE871AC1E05380FE4564F682",
    "ADB98897FE871AC1E05380FE4564F555"
]

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

型: array

ターゲット名のリスト

ソースの表示

配列: string

{
    "description":"List of target names",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "Prod DB",
        "HR DB"
    ]
}

例:

[
    "Prod DB",
    "HR DB"
]

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。LCM履歴は正常に取得されました。

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

object LcmHistoryCollection

LCM履歴データのリスト

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

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

型: object

LCM履歴データのリスト

ソースの表示

count: integer

現在のフェッチにおけるLCM履歴レコードの数
currentPage: string

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

例: b2Zmc2V0OjA
items(必須): array items

LCM履歴のリスト
nextPage: string

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

例: b2Zmc2V0OjC
previousPage: string

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

例: b2Zmc2V0OjB
timeStartedGreaterThanOrEqualTo: string

指定開始時間以降

例: 2022-08-13 04:36:54
timeStartedLessThanOrEqualTo: string

指定開始時間まで

例: 2022-08-13 04:36:54
total: integer

LCM履歴レコードの合計数

{
    "type":"object",
    "description":"List of LCM history data",
    "required":[
        "items"
    ],
    "properties":{
        "total":{
            "description":"Total count of LCM history records",
            "type":"integer"
        },
        "count":{
            "description":"Count of LCM history records in the current fetch",
            "type":"integer"
        },
        "currentPage":{
            "description":"Base 64 encoded current page",
            "type":"string",
            "example":"b2Zmc2V0OjA"
        },
        "previousPage":{
            "description":"Base 64 encoded previous page",
            "type":"string",
            "example":"b2Zmc2V0OjB"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjC"
        },
        "timeStartedGreaterThanOrEqualTo":{
            "description":"Since the given time of start",
            "type":"string",
            "example":"2022-08-13 04:36:54"
        },
        "timeStartedLessThanOrEqualTo":{
            "description":"Until the given time of start",
            "type":"string",
            "example":"2022-08-13 04:36:54"
        },
        "items":{
            "description":"List of LCM history",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LcmHistorySummary"
            }
        }
    }
}

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

型: array

LCM履歴のリスト

ソースの表示

配列: object LcmHistorySummary

LCM履歴サマリー

{
    "description":"List of LCM history",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LcmHistorySummary"
    }
}

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

型: object

LCM履歴サマリー

ソースの表示

additionalProperties: object additionalProperties

このタスクの追加プロパティ
status: string

指定可能な値: [ "SCHEDULED", "RUNNING", "ACTION_REQUIRED", "PAUSED", "FAILED", "COMPLETED", "ABORTED", "SKIPPED", "SAVED", "COMPLETED_WITH_ERROR" ]

タスクのステータス

例: COMPLETED
submittedBy: string

操作を発行したOEMユーザー

例: SYSMAN
targetDisplayName: string

ターゲット表示名

例: Prod DB
targetId: string

ターゲットID

例: 39D9DA5C367AE68C9087A71B2C46FEAE
targetName: string

ターゲット名

例: Prod DB
targetType: string

ターゲット・タイプ

例: oracle_database
task: string

指定可能な値: [ "UPDATE", "UPGRADE" ]

データベース管理タスク

例: UPDATE
timeEnded: string (date-time)

タスクの終了時間
timeStarted: string (date-time)

タスクの開始時刻

{
    "description":"LCM history summary",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Target name",
            "type":"string",
            "example":"Prod DB"
        },
        "targetDisplayName":{
            "description":"Target display name",
            "type":"string",
            "example":"Prod DB"
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        },
        "targetId":{
            "description":"Target Id",
            "type":"string",
            "example":"39D9DA5C367AE68C9087A71B2C46FEAE"
        },
        "task":{
            "description":"Database management task",
            "type":"string",
            "enum":[
                "UPDATE",
                "UPGRADE"
            ],
            "example":"UPDATE"
        },
        "status":{
            "description":"status of task",
            "type":"string",
            "enum":[
                "SCHEDULED",
                "RUNNING",
                "ACTION_REQUIRED",
                "PAUSED",
                "FAILED",
                "COMPLETED",
                "ABORTED",
                "SKIPPED",
                "SAVED",
                "COMPLETED_WITH_ERROR"
            ],
            "example":"COMPLETED"
        },
        "timeStarted":{
            "description":"Start time of the task",
            "type":"string",
            "format":"date-time"
        },
        "timeEnded":{
            "description":"End time of the task",
            "type":"string",
            "format":"date-time"
        },
        "submittedBy":{
            "description":"OEM user that submitted the operation",
            "type":"string",
            "example":"SYSMAN"
        },
        "additionalProperties":{
            "description":"Additional properties of this task",
            "type":"object",
            "items":{
                "$ref":"#/components/schemas/AdditionalProperties"
            }
        }
    }
}

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

型: object

このタスクの追加プロパティ

ソースの表示

配列: object AdditionalProperties

タスクの追加プロパティ

{
    "description":"Additional properties of this task",
    "type":"object",
    "items":{
        "$ref":"#/components/schemas/AdditionalProperties"
    }
}

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

型: object

タスクの追加プロパティ

ソースの表示

patchIds: array patchIds

パッチIDのリスト

{
    "description":"Additional properties of task",
    "type":"object",
    "properties":{
        "patchIds":{
            "description":"List of patch Ids",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":"2951426, 2950410"
        }
    }
}

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

型: array

パッチIDのリスト

ソースの表示

配列: string

{
    "description":"List of patch Ids",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":"2951426, 2950410"
}

例:

2951426, 2950410

例

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

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

先頭に戻る