Oracle Enterprise ManagerのREST API

イメージ・バージョンの作成

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/versions

既存のイメージの新しいバージョンを作成します。これは、このタスクを実行するデプロイメント・プロシージャを発行する非同期操作です。

リクエスト

パス・パラメータ

goldImageId(必須): string

イメージのID

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

application/json

ルート・スキーマ: schema

型: object

1つのスキーマに一致

ソースの表示

object DatabaseGoldImageVersionInputDetails

イメージ・バージョンを作成するための入力
object ExapatchGoldImageVersionInputDetails

Exapatchゴールド・イメージ・バージョンを作成するためのリクエスト詳細

{
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInputDetails"
        },
        {
            "$ref":"#/components/schemas/ExapatchGoldImageVersionInputDetails"
        }
    ]
}

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

型: object

イメージ・バージョンを作成するための入力

すべてに一致

ソースの表示

object DatabaseGoldImageVersionDetails

イメージ・バージョンを作成するための入力

{
    "description":"Input to create image version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionDetails"
        }
    ]
}

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

型: object

Exapatchゴールド・イメージ・バージョンを作成するためのリクエスト詳細

すべてに一致

ソースの表示

object ExapatchGoldImageVersionDetails

Exapatchゴールド・イメージ・バージョンを作成するための入力

{
    "description":"Request details to create an Exapatch Gold Image Version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExapatchGoldImageVersionDetails"
        }
    ]
}

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

型: object

イメージ・バージョンを作成するための入力

1つのスキーマに一致

ソースの表示

object DatabaseGoldImageVersionReferenceHomeInput

参照Oracleホームからイメージを作成するための入力
object DatabaseGoldImageVersionReferenceHomePatchingInput

参照Oracleホームにパッチを適用してイメージ・バージョンを作成するための入力
object DatabaseGoldImageVersionNewReferenceHomePatchingInput

新規Oracleホームにパッチ適用およびプロビジョニングしてイメージ・バージョンを作成するための入力
object DatabaseGoldImageVersionDeployNewHomePatchingInput

パッチを適用した指定された宛先Oracleホームにイメージをデプロイしてイメージ・バージョンを作成するためのリクエスト
object DatabaseGoldImageVersionFPPInput

指定されたソフトウェア・ホーム(Oracleデータベース、グリッド・インフラストラクチャまたはその他のソフトウェア・ホーム)からイメージを作成するための入力

{
    "description":"Input to create image version",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionReferenceHomeInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionReferenceHomePatchingInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionNewReferenceHomePatchingInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionDeployNewHomePatchingInput"
        },
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionFPPInput"
        }
    ]
}

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

型: object

参照Oracleホームからイメージを作成するための入力

ソースの表示

referenceHostCredential: string

参照Oracleホームのホスト資格証明

例: TESTSUPERADMIN:ADMIN
referenceTargetName(必須): string

参照Oracleホームのターゲット

例: myoraclehome_4661

{
    "description":"Input to create image from a reference Oracle home",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInput"
        }
    ],
    "type":"object",
    "properties":{
        "referenceTargetName":{
            "description":"Reference Oracle Home target",
            "type":"string",
            "example":"myoraclehome_4661"
        },
        "referenceHostCredential":{
            "description":"Reference Oracle home host credential",
            "type":"string",
            "example":"TESTSUPERADMIN:ADMIN"
        }
    }
}

すべてに一致

ソースの表示

object allOf DatabaseGoldImageVersionInput

イメージの新しいバージョンを作成するための共通入力

{
    "description":"Input to create image from a reference Oracle home",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInput"
        }
    ],
    "type":"object",
    "properties":{
        "referenceTargetName":{
            "description":"Reference Oracle Home target",
            "type":"string",
            "example":"myoraclehome_4661"
        },
        "referenceHostCredential":{
            "description":"Reference Oracle home host credential",
            "type":"string",
            "example":"TESTSUPERADMIN:ADMIN"
        }
    }
}

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

型: object

参照Oracleホームにパッチを適用してイメージ・バージョンを作成するための入力

ソースの表示

isCleanupDestinationHome: boolean

宛先ホームのクリーン・アップを示すフラグ

例: false
patchList(必須): string

適用するパッチ

例: 31504723
referenceHostPrivilegeCredential: string

参照Oracleホームのターゲットの特権ホスト資格証明

例: TESTPRIVADMIN:ADMIN

{
    "description":"Input to create the image version by patching the reference Oracle Home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList"
    ],
    "properties":{
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential of the reference Oracle Home target",
            "type":"string",
            "example":"TESTPRIVADMIN:ADMIN"
        },
        "isCleanupDestinationHome":{
            "description":"Flag to indicate cleanup destination home",
            "type":"boolean",
            "example":false
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string",
            "example":"31504723"
        }
    }
}

すべてに一致

ソースの表示

object allOf DatabaseGoldImageVersionReferenceHomeInput

参照Oracleホームからイメージを作成するための入力

{
    "description":"Input to create the image version by patching the reference Oracle Home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList"
    ],
    "properties":{
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential of the reference Oracle Home target",
            "type":"string",
            "example":"TESTPRIVADMIN:ADMIN"
        },
        "isCleanupDestinationHome":{
            "description":"Flag to indicate cleanup destination home",
            "type":"boolean",
            "example":false
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string",
            "example":"31504723"
        }
    }
}

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

型: object

新規Oracleホームにパッチ適用およびプロビジョニングしてイメージ・バージョンを作成するための入力

ソースの表示

destinationOracleHomeLocation(必須): string

宛先Oracleホームの場所

例: /u01/oracle/newhome

{
    "description":"Input to create the image version by patching and provisioning new Oracle Home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomePatchingInput"
        }
    ],
    "type":"object",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList",
        "destinationOracleHomeLocation"
    ],
    "properties":{
        "destinationOracleHomeLocation":{
            "description":"Location of the destination Oracle Home",
            "type":"string",
            "example":"/u01/oracle/newhome"
        }
    }
}

すべてに一致

ソースの表示

object allOf DatabaseGoldImageReferenceHomePatchingInput

パッチを適用した参照Oracleホームからイメージを作成するための入力

{
    "description":"Input to create the image version by patching and provisioning new Oracle Home",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomePatchingInput"
        }
    ],
    "type":"object",
    "required":[
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList",
        "destinationOracleHomeLocation"
    ],
    "properties":{
        "destinationOracleHomeLocation":{
            "description":"Location of the destination Oracle Home",
            "type":"string",
            "example":"/u01/oracle/newhome"
        }
    }
}

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

型: object

パッチを適用した指定された宛先Oracleホームにイメージをデプロイしてイメージ・バージョンを作成するためのリクエスト

ソースの表示

asmDbaGroup: string

ASM DBAグループ
databaseAdminGroup(必須): string

データベース管理グループ
databaseOperGroup: string

データベース操作グループ
destinationHostName(必須): string

宛先のホスト名
destinationOracleHomeLocation(必須): string

Oracleホームの場所
imageId(必須): string

デプロイするイメージのID

例: E5B98897FE871AC1E05380FE4564F682
inventoryGroup(必須): string

インベントリ・グループ
oracleBaseLocation: string

ベースの場所
osBackupDbaGroup: string

OSバックアップDBAグループ
osDgDbaGroup: string

OS DG DBAグループ。
osKeyMgmtGroup: string

OSキー管理グループ
patchList(必須): string

適用するパッチ
provisioningType(必須): string

プロビジョニング・タイプ
referenceHostPrivilegeCredential: string

参照Oracleホームのターゲットの特権ホスト資格証明

例: HOST_ROOT_CRED:ADMIN
versionId: string

新規バージョンの作成元のバージョンのID

例: E5v98897FE871AC1E05380FE4564F690

{
    "description":"Request to create the image version by deploying image at a given destination Oracle Home with patching",
    "required":[
        "imageId",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList",
        "destinationOracleHomeLocation",
        "destinationHostName",
        "provisioningType",
        "inventoryGroup",
        "databaseAdminGroup"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInput"
        }
    ],
    "type":"object",
    "properties":{
        "imageId":{
            "description":"ID of the image to be deployed",
            "type":"string",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        },
        "versionId":{
            "description":"ID of the version from which the new version to be created",
            "type":"string",
            "example":"E5v98897FE871AC1E05380FE4564F690"
        },
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential for the reference Oracle Home target",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "destinationOracleHomeLocation":{
            "description":"Location of the Oracle Home",
            "type":"string"
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string"
        },
        "oracleBaseLocation":{
            "description":"Base location",
            "type":"string"
        },
        "destinationHostName":{
            "description":"Host name of the destination",
            "type":"string"
        },
        "provisioningType":{
            "description":"Provisioning type",
            "type":"string"
        },
        "inventoryGroup":{
            "description":"Inventory group",
            "type":"string"
        },
        "databaseAdminGroup":{
            "description":"Database admin group",
            "type":"string"
        },
        "asmDbaGroup":{
            "description":"ASM dba group",
            "type":"string"
        },
        "osBackupDbaGroup":{
            "description":"OS backup dba group",
            "type":"string"
        },
        "databaseOperGroup":{
            "description":"Database oper group",
            "type":"string"
        },
        "osDgDbaGroup":{
            "description":"OS dg dba group",
            "type":"string"
        },
        "osKeyMgmtGroup":{
            "description":"OS key management group",
            "type":"string"
        }
    }
}

すべてに一致

ソースの表示

object allOf DatabaseGoldImageVersionInput

イメージの新しいバージョンを作成するための共通入力

{
    "description":"Request to create the image version by deploying image at a given destination Oracle Home with patching",
    "required":[
        "imageId",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList",
        "destinationOracleHomeLocation",
        "destinationHostName",
        "provisioningType",
        "inventoryGroup",
        "databaseAdminGroup"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageVersionInput"
        }
    ],
    "type":"object",
    "properties":{
        "imageId":{
            "description":"ID of the image to be deployed",
            "type":"string",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        },
        "versionId":{
            "description":"ID of the version from which the new version to be created",
            "type":"string",
            "example":"E5v98897FE871AC1E05380FE4564F690"
        },
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential for the reference Oracle Home target",
            "type":"string",
            "example":"HOST_ROOT_CRED:ADMIN"
        },
        "destinationOracleHomeLocation":{
            "description":"Location of the Oracle Home",
            "type":"string"
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string"
        },
        "oracleBaseLocation":{
            "description":"Base location",
            "type":"string"
        },
        "destinationHostName":{
            "description":"Host name of the destination",
            "type":"string"
        },
        "provisioningType":{
            "description":"Provisioning type",
            "type":"string"
        },
        "inventoryGroup":{
            "description":"Inventory group",
            "type":"string"
        },
        "databaseAdminGroup":{
            "description":"Database admin group",
            "type":"string"
        },
        "asmDbaGroup":{
            "description":"ASM dba group",
            "type":"string"
        },
        "osBackupDbaGroup":{
            "description":"OS backup dba group",
            "type":"string"
        },
        "databaseOperGroup":{
            "description":"Database oper group",
            "type":"string"
        },
        "osDgDbaGroup":{
            "description":"OS dg dba group",
            "type":"string"
        },
        "osKeyMgmtGroup":{
            "description":"OS key management group",
            "type":"string"
        }
    }
}

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

型: object

指定されたソフトウェア・ホーム(Oracleデータベース、グリッド・インフラストラクチャまたはその他のソフトウェア・ホーム)からイメージを作成するための入力

すべてに一致

ソースの表示

object DatabaseGoldImageFPPInput

指定されたシリーズ名でFPPサーバーに新規シリーズ・リソースを作成し、参照Oracleホームからイメージを作成し、シリーズをそれに関連付けるための入力

{
    "description":"Input to create image from software home specified, which can be an Oracle database, a grid infrastructure, or any other software home",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageFPPInput"
        }
    ]
}

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

型: object

イメージの新しいバージョンを作成するための共通入力

すべてに一致

ソースの表示

object DatabaseGoldImageCommonDetails

イメージを作成するための共通入力の詳細

{
    "description":"Common input to create new version of the image",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageCommonDetails"
        }
    ]
}

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

型: object

イメージを作成するための共通入力の詳細

ソースの表示

excludeFileList: string

除外するファイルのリスト
externalId: string

イメージの外部ID

例: oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1
externalStageLocation: string

SANの外部ステージの場所

例: false
imageDescription: string

イメージの説明
imageNotes: string

イメージに関するノート
imageSoftwareLibraryPath: string

イメージのソフトウェア・ライブラリ・パス

例: <path>/18.0/linux64
isCreateImageLegacyWay: boolean

従来の方法でイメージを作成することを示すフラグ

例: false
isIgnoreActiveFileExecutionCheck: boolean

アクティブなファイル実行を無視するフラグ

例: false
nfsLocalMountPoint: string

マウントするNFS共有のローカル・ディレクトリ・パス

例: /scratch/cuser/Nfs_mount_point
softwareLibraryStorageName: string

ソフトウェア・ライブラリ記憶域の名前

例: swlib
softwareLibraryStorageType: string

ソフトウェア・ライブラリ記憶域のタイプ

例: OmsShared
storageDestination: string

指定可能な値: [ "SOFTWARE_LIBRARY", "FPP_SERVER" ]

イメージの保管/作成は、ソフトウェア・ライブラリまたはFPPサーバーにあります
versionName: string

データベース・ゴールド・イメージ・バージョンの名前

例: fm_version_1
versionStatus: string

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

イメージ・バージョンのステータスの列挙
windowsCredential: string

Windowsプラットフォームの資格証明
workingDirectory: string

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

作業ディレクトリ

例: /scratch/workdir

{
    "description":"Common input details to create the image",
    "type":"object",
    "properties":{
        "storageDestination":{
            "description":"Image storage/creation is either in software library or in FPP server",
            "type":"string",
            "enum":[
                "SOFTWARE_LIBRARY",
                "FPP_SERVER"
            ]
        },
        "imageDescription":{
            "description":"Description of the image",
            "type":"string"
        },
        "imageSoftwareLibraryPath":{
            "description":"Software library path for image",
            "type":"string",
            "example":"<path>/18.0/linux64"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "default":"/u01/scratch/workDir",
            "example":"/scratch/workdir"
        },
        "softwareLibraryStorageName":{
            "description":"Software library storage name",
            "type":"string",
            "example":"swlib"
        },
        "softwareLibraryStorageType":{
            "description":"Software Library storage type",
            "type":"string",
            "example":"OmsShared"
        },
        "versionName":{
            "description":"Name for the Database Gold Image Version",
            "type":"string",
            "example":"fm_version_1"
        },
        "versionStatus":{
            "$ref":"#/components/schemas/VersionStatusEnum"
        },
        "nfsLocalMountPoint":{
            "description":"Local directory path for NFS share to mount",
            "type":"string",
            "example":"/scratch/cuser/Nfs_mount_point"
        },
        "imageNotes":{
            "description":"Notes about the image",
            "type":"string"
        },
        "externalId":{
            "description":"External ID for the image",
            "type":"string",
            "example":"oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1"
        },
        "excludeFileList":{
            "description":"List of files to be excluded",
            "type":"string"
        },
        "windowsCredential":{
            "description":"Credential for the Windows platform",
            "type":"string"
        },
        "isIgnoreActiveFileExecutionCheck":{
            "description":"Flag to ignore active files execution",
            "type":"boolean",
            "example":false
        },
        "isCreateImageLegacyWay":{
            "description":"Flag to indicate creation of the image in a legacy way",
            "type":"boolean",
            "example":false
        },
        "externalStageLocation":{
            "description":"External Stage Location for SAN",
            "type":"string",
            "example":false
        }
    }
}

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

型: object

パッチを適用した参照Oracleホームからイメージを作成するための入力

ソースの表示

isCleanupDestinationHome: boolean

宛先ホームのクリーン・アップを示すフラグ

例: false
patchList(必須): string

適用するパッチ

例: 31504723
referenceHostPrivilegeCredential: string

参照Oracleホームのターゲットの特権ホスト資格証明

例: TESTPRIVADMIN:ADMIN

{
    "description":"Input to create the image from the reference Oracle home with patching",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList"
    ],
    "properties":{
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential of the reference Oracle Home target",
            "type":"string",
            "example":"TESTPRIVADMIN:ADMIN"
        },
        "isCleanupDestinationHome":{
            "description":"Flag to indicate cleanup destination home",
            "type":"boolean",
            "example":false
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string",
            "example":"31504723"
        }
    }
}

すべてに一致

ソースの表示

object allOf DatabaseGoldImageReferenceHomeInput

参照Oracleホームからイメージを作成するための入力

{
    "description":"Input to create the image from the reference Oracle home with patching",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageReferenceHomeInput"
        }
    ],
    "type":"object",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName",
        "patchList"
    ],
    "properties":{
        "referenceHostPrivilegeCredential":{
            "description":"Privilege host credential of the reference Oracle Home target",
            "type":"string",
            "example":"TESTPRIVADMIN:ADMIN"
        },
        "isCleanupDestinationHome":{
            "description":"Flag to indicate cleanup destination home",
            "type":"boolean",
            "example":false
        },
        "patchList":{
            "description":"Patches to be applied",
            "type":"string",
            "example":"31504723"
        }
    }
}

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

型: object

参照Oracleホームからイメージを作成するための入力

ソースの表示

referenceHostCredential: string

参照Oracleホームのホスト資格証明

例: TESTSUPERADMIN:ADMIN
referenceTargetName(必須): string

参照Oracleホームのターゲット

例: myoraclehome_4661

{
    "description":"Input to create image from a reference Oracle home",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageInput"
        }
    ],
    "type":"object",
    "properties":{
        "referenceTargetName":{
            "description":"Reference Oracle Home target",
            "type":"string",
            "example":"myoraclehome_4661"
        },
        "referenceHostCredential":{
            "description":"Reference Oracle Home host credential",
            "type":"string",
            "example":"TESTSUPERADMIN:ADMIN"
        }
    }
}

すべてに一致

ソースの表示

object allOf DatabaseGoldImageInput

イメージまたはバージョンを作成するための共通入力

{
    "description":"Input to create image from a reference Oracle home",
    "required":[
        "imageName",
        "imageDescription",
        "referenceTargetName",
        "imageSoftwareLibraryPath",
        "workingDirectory",
        "softwareLibraryStorageName",
        "softwareLibraryStorageType",
        "versionName"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageInput"
        }
    ],
    "type":"object",
    "properties":{
        "referenceTargetName":{
            "description":"Reference Oracle Home target",
            "type":"string",
            "example":"myoraclehome_4661"
        },
        "referenceHostCredential":{
            "description":"Reference Oracle Home host credential",
            "type":"string",
            "example":"TESTSUPERADMIN:ADMIN"
        }
    }
}

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

型: object

イメージまたはバージョンを作成するための共通入力

ソースの表示

imageName: string

イメージの名前

{
    "description":"Common input to create image or version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageCommonDetails"
        }
    ],
    "properties":{
        "imageName":{
            "description":"Name of the image",
            "type":"string"
        }
    }
}

すべてに一致

ソースの表示

object DatabaseGoldImageCommonDetails

イメージを作成するための共通入力の詳細

{
    "description":"Common input to create image or version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/DatabaseGoldImageCommonDetails"
        }
    ],
    "properties":{
        "imageName":{
            "description":"Name of the image",
            "type":"string"
        }
    }
}

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

型: object

指定されたシリーズ名でFPPサーバーに新規シリーズ・リソースを作成し、参照Oracleホームからイメージを作成し、シリーズをそれに関連付けるための入力

ソースの表示

fppOptions: string

FPPの追加オプション
fppRestUser: string

FPP RESTコールに使用されるRESTユーザー

例: rest_cuser
imageDescription: string

イメージの説明

例: Gold image for DB19
imageName: string

FPPシリーズの名前

例: FPP_DB_19_Series_04_july_21
referenceHostCredential: string

参照ホストのホスト資格証明

例: SRC_HOST_CRED:ADMIN
referenceTargetName(必須): string

参照ターゲット名

例: myoraclehome_3917
version: string

イメージのバージョン
versionName(必須): string

イメージの名前

例: Tier1_19_ver_Image_04_July_21
workingDirectory(必須): string

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

作業ディレクトリ

例: /scratch/cuser/agents/image

{
    "description":"Input to create new series resource in FPP server with given series name and creates image from reference Oracle Home and associates series to it",
    "type":"object",
    "required":[
        "versionName",
        "referenceTargetName",
        "workingDirectory"
    ],
    "properties":{
        "imageName":{
            "description":"Name of the FPP series",
            "type":"string",
            "example":"FPP_DB_19_Series_04_july_21"
        },
        "versionName":{
            "description":"Name of the image",
            "type":"string",
            "example":"Tier1_19_ver_Image_04_July_21"
        },
        "imageDescription":{
            "description":"Description for the image",
            "type":"string",
            "example":"Gold image for DB19"
        },
        "referenceTargetName":{
            "description":"Reference target name",
            "type":"string",
            "example":"myoraclehome_3917"
        },
        "referenceHostCredential":{
            "description":"Host credential of the reference host",
            "type":"string",
            "example":"SRC_HOST_CRED:ADMIN"
        },
        "workingDirectory":{
            "description":"Working directory",
            "type":"string",
            "default":"/u01/scratch/workDir",
            "example":"/scratch/cuser/agents/image"
        },
        "version":{
            "description":"Version of the image",
            "type":"string"
        },
        "fppOptions":{
            "description":"Additional options for FPP",
            "type":"string"
        },
        "fppRestUser":{
            "description":"REST user to be used for an FPP REST call",
            "type":"string",
            "example":"rest_cuser"
        }
    }
}

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

型: object

Exapatchゴールド・イメージ・バージョンを作成するための入力

1つのスキーマに一致

ソースの表示

object ExapatchGoldImageVersionInput

Exadataゴールド・イメージまたはバージョンを作成するための共通リクエスト詳細

{
    "description":"Inputs to create an Exapatch Gold Image Version",
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ExapatchGoldImageVersionInput"
        }
    ]
}

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

型: object

Exadataゴールド・イメージまたはバージョンを作成するための共通リクエスト詳細

すべてに一致

ソースの表示

object ExapatchGoldImageVersionCommonDetails

指定されたイメージ名で新しいイメージ・リソースを作成し、指定されたfppサーバーのパッチの場所からゴールド・イメージを作成します。

{
    "description":"Common Request details to create a Exadata Gold Image or version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExapatchGoldImageVersionCommonDetails"
        }
    ],
    "required":[
        "versionName",
        "imageVersion",
        "fppServerHost",
        "imageLocation",
        "workingDirectory",
        "referenceHostCredential",
        "imageDescription",
        "targetType"
    ]
}

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

型: object

指定されたイメージ名で新しいイメージ・リソースを作成し、指定されたfppサーバーのパッチの場所からゴールド・イメージを作成します。

ソースの表示

dbNodeFile: string

dbnodeパッチのファイル名。

例: p34568889_221000_Linux-x86-64.zip
fppServerHost: string

FPPホスト名

例: myFppServerHostName.mycompany.comom
imageDescription: string

ゴールド・イメージの説明

例: Description of the Exapatch Gold Image
imageLocation: string

fppサーバー上のパッチの場所

例: /u01/staging/db_212
imageVersion: string

イメージ・バージョン

例: 19.13.0.0.0
patchManagerLocation: string

パッチ・マネージャ・ファイルを含むフォルダ名は、指定されたimageLocationの相対パスである必要があります。

例: dbserver_patch_220810
referenceHostCredential: string

参照fppサーバー・ホストのホスト資格証明。

例: TEST_HOST_CREDENTIAL:SYSMAN
storageFile: string

ストレージ・パッチのファイル名。

例: p34568888_221000_Linux-x86-64.zip
switchFile: string

スイッチ・パッチのファイル名。

例: p34568890_221000_Linux-x86-64.zip
targetType: string

指定可能な値: [ "oracle_si_netswitch", "oracle_dbmachine", "oracle_exadata", "host" ]

Exapatch作成タイプ
versionName: string

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

例: Tier1_ver_Image_31_July_22
workingDirectory: string

作業ディレクトリの場所

例: /u01/scratch/workDir

{
    "description":"Creates a new image resource with the given image name and creates a Gold Image from patch location on given fpp server.",
    "type":"object",
    "properties":{
        "versionName":{
            "description":"Name of the image version",
            "type":"string",
            "example":"Tier1_ver_Image_31_July_22"
        },
        "imageVersion":{
            "description":"Image version",
            "type":"string",
            "example":"19.13.0.0.0"
        },
        "fppServerHost":{
            "description":"FPP host name",
            "type":"string",
            "example":"myFppServerHostName.mycompany.comom"
        },
        "imageLocation":{
            "description":"Location of the patch on the fpp server",
            "type":"string",
            "example":"/u01/staging/db_212"
        },
        "workingDirectory":{
            "description":"Working directory location",
            "type":"string",
            "example":"/u01/scratch/workDir"
        },
        "referenceHostCredential":{
            "description":"Host Credentials for the reference fpp server host.",
            "type":"string",
            "example":"TEST_HOST_CREDENTIAL:SYSMAN"
        },
        "imageDescription":{
            "description":"Description of the Gold Image",
            "type":"string",
            "example":"Description of the Exapatch Gold Image"
        },
        "targetType":{
            "description":"Exapatch creation type",
            "type":"string",
            "enum":[
                "oracle_si_netswitch",
                "oracle_dbmachine",
                "oracle_exadata",
                "host"
            ]
        },
        "switchFile":{
            "description":"File name of switch patch .",
            "type":"string",
            "example":"p34568890_221000_Linux-x86-64.zip"
        },
        "storageFile":{
            "description":"File name of storage patch.",
            "type":"string",
            "example":"p34568888_221000_Linux-x86-64.zip"
        },
        "dbNodeFile":{
            "description":"File name of the dbnode patch.",
            "type":"string",
            "example":"p34568889_221000_Linux-x86-64.zip"
        },
        "patchManagerLocation":{
            "description":"Folder name that contains patch manager files should be a relative path of given imageLocation.",
            "type":"string",
            "example":"dbserver_patch_220810"
        }
    }
}

例

先頭に戻る

レスポンス

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

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

先頭に戻る