Oracle Enterprise ManagerのREST API

ライフサイクル・メンテナンス履歴のエクスポート

post

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

更新(パッチ適用)およびアップグレード操作のデータベース・メンテナンス履歴をCSV形式でエクスポートします。

リクエスト

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

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

application/json

ルート・スキーマ: schema

型: object

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

ソースの表示

csvFileLocation: string

CSVのエクスポート先となるファイルの場所

例: /scratch/lcmhistory
csvFileName: string

CSVファイル名

例: lcmHistory_04122024T10_10_10.csv
destinationHostCredential: string

接続先ホストのターゲット資格証明

例: HOST_CRED:ADMIN
destinationHostName: string

宛先ホストのターゲット名

例: myhost

{
    "description":"Request to export LCM history data",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryDetails"
        }
    ],
    "properties":{
        "destinationHostName":{
            "description":"Destination host target name",
            "type":"string",
            "example":"myhost"
        },
        "destinationHostCredential":{
            "description":"Destination host target credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "csvFileLocation":{
            "description":"File location where the CSV to be exported",
            "type":"string",
            "example":"/scratch/lcmhistory"
        },
        "csvFileName":{
            "description":"CSV file name",
            "type":"string",
            "example":"lcmHistory_04122024T10_10_10.csv"
        }
    }
}

すべてに一致

ソースの表示

object allOf LcmHistoryDetails

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

{
    "description":"Request to export LCM history data",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/LcmHistoryDetails"
        }
    ],
    "properties":{
        "destinationHostName":{
            "description":"Destination host target name",
            "type":"string",
            "example":"myhost"
        },
        "destinationHostCredential":{
            "description":"Destination host target credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "csvFileLocation":{
            "description":"File location where the CSV to be exported",
            "type":"string",
            "example":"/scratch/lcmhistory"
        },
        "csvFileName":{
            "description":"CSV file name",
            "type":"string",
            "example":"lcmHistory_04122024T10_10_10.csv"
        }
    }
}

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

LCM履歴のエクスポートのレスポンス

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

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

型: object

LCM履歴のエクスポートのレスポンス

ソースの表示

message: string

成功メッセージ

例: CSV file exported successfully to /scratch/lcmhistory/exportlcmhistory.csv
nextPage: string

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

例: b2Zmc2V0OjC

{
    "description":"Export LCM history response",
    "type":"object",
    "properties":{
        "message":{
            "description":"Success message",
            "type":"string",
            "example":"CSV file exported successfully to /scratch/lcmhistory/exportlcmhistory.csv"
        },
        "nextPage":{
            "description":"Base 64 encoded next page",
            "type":"string",
            "example":"b2Zmc2V0OjC"
        }
    }
}

例

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

先頭に戻る