Oracle Enterprise ManagerのREST API

イメージのエクスポート

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/actions/export

指定されたバージョンのイメージをエクスポートします。イメージのインポートの詳細は、「イメージ・バージョンの作成」を参照してください。

リクエスト

パス・パラメータ

goldImageId(必須): string

イメージのID

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

application/json

ルート・スキーマ: schema

型: object

イメージ・エクスポートの詳細

ソースの表示

destinationHostCredential(必須): string

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

例: HOST_CRED:ADMIN
destinationHostName(必須): string

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

例: myhost
imageBundleLocation(必須): string

イメージ・バンドルの場所

例: /scratch/images/exportedimages
imageBundleName: string

イメージ・バンドル名

例: exportedImage_18c.zip
versionId: string

イメージ・バージョンのID

例: E5B98897FE871AC1E05380FE4564F682
versionName: string

イメージ・バージョンの名前

例: fm_version_1
workingDirectory: string

デフォルト値: /u01/scratch/workDir

ステージング/作業ディレクトリの場所

例: /u01/workdir

{
    "description":"Image export details",
    "type":"object",
    "required":[
        "destinationHostName",
        "destinationHostCredential",
        "imageBundleLocation"
    ],
    "properties":{
        "destinationHostName":{
            "description":"Destination host target name",
            "type":"string",
            "example":"myhost"
        },
        "destinationHostCredential":{
            "description":"Destination host target credential",
            "type":"string",
            "example":"HOST_CRED:ADMIN"
        },
        "imageBundleLocation":{
            "description":"Image bundle location",
            "type":"string",
            "example":"/scratch/images/exportedimages"
        },
        "imageBundleName":{
            "description":"Image bundle name",
            "type":"string",
            "example":"exportedImage_18c.zip"
        },
        "workingDirectory":{
            "description":"Staging/Working directory location",
            "type":"string",
            "default":"/u01/scratch/workDir",
            "example":"/u01/workdir"
        },
        "versionName":{
            "description":"Name of the image version",
            "type":"string",
            "example":"fm_version_1"
        },
        "versionId":{
            "description":"ID of the image version",
            "type":"string",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        }
    }
}

例

先頭に戻る

レスポンス

202レスポンス

長時間実行/非同期APIです。デプロイメント・プロシージャを発行します。

ヘッダー

Location:
デプロイメント・プロシージャのAPIのステータスを追跡するためのURLリンク
例:
```
/deploymentProcedureInstances/{deploymentProcedureInstanceId}
```

ルート・スキーマ: schema

型: object

ソースの表示

links: object links

リンク
message: string

メッセージ

例: It is a long running/async API. It submits a deployment procedure.

{
    "type":"object",
    "properties":{
        "message":{
            "description":"message",
            "type":"string",
            "example":"It is a long running/async API. It submits a deployment procedure."
        },
        "links":{
            "description":"links",
            "type":"object",
            "properties":{
                "tracking":{
                    "type":"object",
                    "description":"Represents a link to the REST API to track the status of the submitted deployment procedure",
                    "properties":{
                        "href":{
                            "type":"string",
                            "description":"URL for the link",
                            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
                        }
                    }
                }
            }
        }
    }
}

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

型: object

リンク

ソースの表示

tracking: object tracking

発行されたデプロイメント・プロシージャのステータスを追跡するためのREST APIへのリンクを表します

{
    "description":"links",
    "type":"object",
    "properties":{
        "tracking":{
            "type":"object",
            "description":"Represents a link to the REST API to track the status of the submitted deployment procedure",
            "properties":{
                "href":{
                    "type":"string",
                    "description":"URL for the link",
                    "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
                }
            }
        }
    }
}

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

型: object

発行されたデプロイメント・プロシージャのステータスを追跡するためのREST APIへのリンクを表します

ソースの表示

href: string

リンクのURL

例: /deploymentProcedureInstances/{deploymentProcedureInstanceId}

{
    "type":"object",
    "description":"Represents a link to the REST API to track the status of the submitted deployment procedure",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the link",
            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
        }
    }
}

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

先頭に戻る