Oracle Database ApplianceのREST APIリリース19.24

KVM DB Systemの作成

post

/dbsystem

DbSystemCreateParamsを使用して、Oracle Database Applianceに新しいKVM DB Systemを作成します。 Oracle Database Appliance KVM DBシステム・イメージがダウンロードされ、リポジトリが最初にイメージで更新されていることを確認します。

リクエスト

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

application/json

DB Systemを作成するためのパラメータ

ルート・スキーマ : DbSystemCreateParams

型: object

Show Source

database: object DbSystemCreateDatabaseParams
dbHome: object DbSystemCreateDbHomeParams
forced: boolean

DB Systemの作成操作を強制するかどうか
grid: object DbSystemCreateGridParams
network(required): object DbSystemCreateNetworkParams
restoreDatabase: object DbSystemCreateRestoreDatabaseParams
system(required): object DbSystemCreateSystemParams

{
    "type":"object",
    "required":[
        "system",
        "network"
    ],
    "properties":{
        "forced":{
            "type":"boolean",
            "description":"Whether or not to force the DB System create operation"
        },
        "system":{
            "$ref":"#/definitions/DbSystemCreateSystemParams"
        },
        "network":{
            "$ref":"#/definitions/DbSystemCreateNetworkParams"
        },
        "grid":{
            "$ref":"#/definitions/DbSystemCreateGridParams"
        },
        "dbHome":{
            "$ref":"#/definitions/DbSystemCreateDbHomeParams"
        },
        "database":{
            "$ref":"#/definitions/DbSystemCreateDatabaseParams"
        },
        "restoreDatabase":{
            "$ref":"#/definitions/DbSystemCreateRestoreDatabaseParams"
        }
    }
}

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

型: object

Show Source

adminPassword(required): string

データベースの管理パスワード
characterSet: object DbCharacterSet
dbClass(required): string

許容値: [ "OLTP", "DSS", "IMDB" ]

データベースのクラス(OLTP|DSS|IMDB)
dbStorage: string

許容値: [ "ASM", "PMEM" ]

データベースのストレージ・タイプ(ASM|PMEM) - デフォルト値はASMです
domainName(required): string

データベースのドメイン名
edition(required): string

許容値: [ "SE", "EE" ]

データベースのエディション(SE|EE)
enableDbConsole: boolean

データベース・コンソールが有効かどうか
enableEEHA: boolean

HA for EE SIデータベースを有効にするかどうか
enableFlashCache: boolean

フラッシュ・キャッシュを有効にするかどうか
enableFlashStorage: boolean

フラッシュ・ストレージを有効にするかどうか
enableSEHA: boolean

19c以降のSIデータベースでHA for SEを有効にするかどうか
enableTDE: boolean

TDEを有効にするかどうか
enableUnifiedAuditing: boolean

統合監査を有効にするかどうか
isCdb: boolean

データベースがCDBかどうか
level0BackupDay: string

許容値: [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ]

データベースのバックアップ日 (monday|tuesday|wednesday|thursday|friday|saturday|sunday)
name(required): string

データベースの名前。
pdbAdminUser: string

PDB管理ユーザーの名前
pdbName: string

PDBの名前
redundancy: string

データベースの冗長性。ディスク・グループの冗長性がFLEXの場合、データベースの冗長性は「HIGH」または「MIRROR」のいずれかに設定する必要があります。それ以外の場合はnullにできます
rmanBackupPassword: string

データベースのRMANバックアップ・パスワード
role(required): string

許容値: [ "PRIMARY", "STANDBY" ]

データベースのロール(PRIMARY|STANDBY)
shape(required): string

許容値: [ "odb1s", "odb1", "odb2", "odb4", "odb6", "odb8", "odb10", "odb12", "odb16", "odb20", "odb24", "odb28", "odb32", "odb36", "odb42", "odb48", "odb56", "odb64" ]

データベースのシェイプ(odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)
targetNodeNumber: integer

データベースのターゲット・ノード番号
tdePassword: string

データベースのTDEパスワード
type(required): string

許容値: [ "RAC", "RACOne", "SI" ]

データベースのタイプ(RAC|RACOne|SI)
uniqueName(required): string

データベースの一意の名前
version(required): string

データベースのバージョン

{
    "type":"object",
    "required":[
        "name",
        "uniqueName",
        "domainName",
        "adminPassword",
        "version",
        "edition",
        "type",
        "dbClass",
        "shape",
        "role"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the database"
        },
        "uniqueName":{
            "type":"string",
            "description":"Unique name of the database"
        },
        "domainName":{
            "type":"string",
            "description":"Domain name of the database"
        },
        "adminPassword":{
            "type":"string",
            "description":"Admin password of the database"
        },
        "version":{
            "type":"string",
            "description":"Version of the database"
        },
        "edition":{
            "type":"string",
            "description":"Edition of the database (SE|EE)",
            "enum":[
                "SE",
                "EE"
            ]
        },
        "type":{
            "type":"string",
            "description":"Type of the database (RAC|RACOne|SI)",
            "enum":[
                "RAC",
                "RACOne",
                "SI"
            ]
        },
        "dbClass":{
            "type":"string",
            "description":"Class of the database (OLTP|DSS|IMDB)",
            "enum":[
                "OLTP",
                "DSS",
                "IMDB"
            ]
        },
        "shape":{
            "type":"string",
            "description":"Shape of the database (odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)",
            "enum":[
                "odb1s",
                "odb1",
                "odb2",
                "odb4",
                "odb6",
                "odb8",
                "odb10",
                "odb12",
                "odb16",
                "odb20",
                "odb24",
                "odb28",
                "odb32",
                "odb36",
                "odb42",
                "odb48",
                "odb56",
                "odb64"
            ]
        },
        "role":{
            "type":"string",
            "description":"Role of the database (PRIMARY|STANDBY)",
            "enum":[
                "PRIMARY",
                "STANDBY"
            ]
        },
        "redundancy":{
            "type":"string",
            "description":"Redundancy of the database. If the diskgroup redundancy is FLEX, then database redundancy must be set to one of \"HIGH\" or \"MIRROR\", otherwise, can be null"
        },
        "characterSet":{
            "$ref":"#/definitions/DbCharacterSet"
        },
        "enableDbConsole":{
            "type":"boolean",
            "description":"Whether or not the database console is enabled"
        },
        "enableSEHA":{
            "type":"boolean",
            "description":"Whether or not to enable HA for SE for 19c and later SI database"
        },
        "enableEEHA":{
            "type":"boolean",
            "description":"Whether or not to enable HA for EE SI database"
        },
        "enableFlashStorage":{
            "type":"boolean",
            "description":"Whether or not enable flash storage"
        },
        "enableFlashCache":{
            "type":"boolean",
            "description":"Whether or not enable flash cache"
        },
        "rmanBackupPassword":{
            "type":"string",
            "description":"RMAN backup password of the database"
        },
        "level0BackupDay":{
            "type":"string",
            "description":"Backup day of the database (monday|tuesday|wednesday|thursday|friday|saturday|sunday)",
            "enum":[
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday",
                "saturday",
                "sunday"
            ]
        },
        "enableTDE":{
            "type":"boolean",
            "description":"Whether or not enable TDE"
        },
        "tdePassword":{
            "type":"string",
            "description":"TDE password of the database"
        },
        "enableUnifiedAuditing":{
            "type":"boolean",
            "description":"Whether or not enable unified auditing"
        },
        "isCdb":{
            "type":"boolean",
            "description":"Whether or not the database is CDB"
        },
        "pdbName":{
            "type":"string",
            "description":"Name of the PDB"
        },
        "pdbAdminUser":{
            "type":"string",
            "description":"Name of the PDB admin user"
        },
        "targetNodeNumber":{
            "type":"integer",
            "description":"Target node number of the database"
        },
        "dbStorage":{
            "type":"string",
            "description":"Storage type of the database (ASM|PMEM) - The default value is ASM",
            "enum":[
                "ASM",
                "PMEM"
            ]
        }
    }
}

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

型: object

Show Source

エディション: string

許容値: [ "SE", "EE" ]

データベース・ホームのエディション(SE|EE)
enableUnifiedAuditing: boolean

統合監査を有効にするかどうか
version(required): string

データベース・ホームのバージョン

{
    "type":"object",
    "required":[
        "version"
    ],
    "properties":{
        "version":{
            "type":"string",
            "description":"Version of the database home"
        },
        "edition":{
            "type":"string",
            "description":"Edition of the database home (SE|EE)",
            "enum":[
                "SE",
                "EE"
            ]
        },
        "enableUnifiedAuditing":{
            "type":"boolean",
            "description":"Whether or not enable unified auditing"
        }
    }
}

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

型: object

Show Source

enableAFD: boolean

AFDがDBシステム内で有効かどうか
language: string

グリッド・インストールの言語設定
version: string

グリッド・ホームのバージョン

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string",
            "description":"version of the grid home"
        },
        "language":{
            "type":"string",
            "description":"Language setting for the grid installation"
        },
        "enableAFD":{
            "type":"boolean",
            "description":"Whether or not AFD is enabled within DB system"
        }
    }
}

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

型: object

Show Source

clusterInterconnect: object DbSystemClusterInterconnect
dnsServers(required): array dnsServers

ネットワークのDNSサーバー
domainName(required): string

ネットワークのドメイン名
nodes(required): array nodes
ntpServers(required): array ntpServers

ネットワークのNTPサーバー
publicVNetwork: string

パブリック仮想ネットワークの名前
scanIps: array scanIps

DBシステム・データベースのSCAN IP
scanName: string

DBシステム・データベースのSCAN名

{
    "type":"object",
    "required":[
        "domainName",
        "ntpServers",
        "dnsServers",
        "nodes"
    ],
    "properties":{
        "domainName":{
            "type":"string",
            "description":"Domain name of the network"
        },
        "ntpServers":{
            "type":"array",
            "description":"NTP servers of the network",
            "items":{
                "type":"string"
            }
        },
        "dnsServers":{
            "type":"array",
            "description":"DNS servers of the network",
            "items":{
                "type":"string"
            }
        },
        "scanName":{
            "type":"string",
            "description":"SCAN name for the DB system database"
        },
        "scanIps":{
            "type":"array",
            "description":"SCAN IPs for the DB system database",
            "items":{
                "type":"string"
            }
        },
        "nodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCreateNetworkNodeParams"
            }
        },
        "publicVNetwork":{
            "description":"Name of the public virtual network",
            "type":"string"
        },
        "clusterInterconnect":{
            "$ref":"#/definitions/DbSystemClusterInterconnect"
        }
    }
}

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

型: object

Show Source

backupPasswords: array backupPasswords
backupReportDetails(required): object DbSystemCreateRestoreBackupReportDetails

新しいDB System内のデータベースのリストアに使用する必要があるバックアップ・レポートの詳細
customization: object DbSystemCreateRestoreBackupDatabaseCustomization

新しいDB System内でリストアされたデータベース用にカスタマイズできるデータベース・パラメータ
enableForceDelete: boolean

バックアップから作成されるデータベースのファイル・グループ、FRAおよびアーカイブ・ログ(存在する場合)を削除
numberOfRmanChannels: integer

バックアップからデータベースを作成する際に使用する必要があるRMANチャネルの数
sourceDetails(required): object DbSystemCreateRestoreBackupSourceDetails

バックアップとその宛先の詳細
sysPassword(required): string

データベースの管理パスワード。
tdePassword: string

パスワードで保護されたソフトウェア・キーストアに使用されるパスワード

{
    "type":"object",
    "required":[
        "sysPassword",
        "backupReportDetails",
        "sourceDetails"
    ],
    "properties":{
        "backupReportDetails":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupReportDetails"
        },
        "sourceDetails":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupSourceDetails"
        },
        "customization":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupDatabaseCustomization"
        },
        "sysPassword":{
            "type":"string",
            "description":"Admin password of the database."
        },
        "tdePassword":{
            "type":"string",
            "description":"Password used for password protected software keystore"
        },
        "backupPasswords":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"RMAN backup password used to encrypt backups"
            }
        },
        "numberOfRmanChannels":{
            "type":"integer",
            "description":"Number of RMAN channel that must be used while creating the database from backup"
        },
        "enableForceDelete":{
            "type":"boolean",
            "description":"Deletes the filegroups, FRA and archived logs of database that is getting created from backup, if present"
        }
    }
}

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

型: object

Show Source

bootOptions: string

DB System VMのブート・オプション
cpuPoolName: string

共有DB System CPUプールの名前
customMemorySize: string

DB Systemのメモリー
customRoleSeparation: object DbSystemCreateRoleSeparationParams
diskGroup: string

ASMディスク・グループ
enableRoleSeparation: boolean

ロールの分離を有効にするかどうか
failOver: boolean
multiUserAccess: object DbSystemCreateIdmParams
name(required): string

DB Systemの名前
redundancy: string

許容値: [ "MIRROR", "HIGH" ]

VMストレージの冗長性
shape: string

DB Systemのシェイプ(odb2|odb4|odb6|odb8|odb10| odb12|odb16|odb20|odb24|odb28|odb32|odb36|odb42| odb48|odb56|odb64)
singleNode: string
systemPassword(required): string

DB Systemのパスワード
timeZone(required): string

DB Systemのタイム・ゾーン
useReservedCores: boolean

予約済CPUコアを使用するかどうか

{
    "type":"object",
    "required":[
        "name",
        "systemPassword",
        "timeZone"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the DB System"
        },
        "shape":{
            "type":"string",
            "description":"Shape of the DB System (odb2|odb4|odb6|odb8|odb10| odb12|odb16|odb20|odb24|odb28|odb32|odb36|odb42| odb48|odb56|odb64)"
        },
        "customMemorySize":{
            "type":"string",
            "description":"Memory of the DB System"
        },
        "cpuPoolName":{
            "type":"string",
            "description":"Name of the shared DB System CPU Pool"
        },
        "useReservedCores":{
            "type":"boolean",
            "description":"Whether or not to use reserved CPU cores"
        },
        "diskGroup":{
            "type":"string",
            "description":"ASM disk group"
        },
        "systemPassword":{
            "type":"string",
            "description":"Password for the DB System"
        },
        "timeZone":{
            "type":"string",
            "description":"Time zone of the DB System"
        },
        "enableRoleSeparation":{
            "type":"boolean",
            "description":"Whether or not to enable the role separation"
        },
        "singleNode":{
            "type":"string"
        },
        "failOver":{
            "type":"boolean"
        },
        "customRoleSeparation":{
            "$ref":"#/definitions/DbSystemCreateRoleSeparationParams"
        },
        "redundancy":{
            "type":"string",
            "description":"Redundancy of the VM storage",
            "enum":[
                "MIRROR",
                "HIGH"
            ]
        },
        "multiUserAccess":{
            "$ref":"#/definitions/DbSystemCreateIdmParams"
        },
        "bootOptions":{
            "type":"string",
            "description":"Boot options for DB System VM"
        }
    }
}

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

型: object

Show Source

characterSet: string
dbLanguage: string
dbTerritory: string
nlsCharacterset: string

{
    "properties":{
        "characterSet":{
            "type":"string"
        },
        "nlsCharacterset":{
            "type":"string"
        },
        "dbTerritory":{
            "type":"string"
        },
        "dbLanguage":{
            "type":"string"
        }
    }
}

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

型: object

Show Source

gateway(required): string

クラスタ・インターコネクトのゲートウェイ・アドレス
interfaceName(required): string

クラスタ・インターコネクトのインタフェース
subnet(required): string

クラスタ・インターコネクトのサブネット・マスク
vlanId(required): string

クラスタ・インターコネクトのvlan id

{
    "type":"object",
    "required":[
        "vlanId",
        "gateway",
        "subnet",
        "interfaceName"
    ],
    "properties":{
        "vlanId":{
            "type":"string",
            "description":"vlan id for the Cluster Interconnect"
        },
        "gateway":{
            "type":"string",
            "description":"gateway address for Cluster Interconnect"
        },
        "subnet":{
            "type":"string",
            "description":"subnet mask for Cluster Interconnect"
        },
        "interfaceName":{
            "type":"string",
            "description":"interface for Cluster Interconnect"
        }
    }
}

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

型: array

ネットワークのDNSサーバー

Show Source

配列: string

{
    "type":"array",
    "description":"DNS servers of the network",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : ノード

型: array

Show Source

Array of: object DbSystemCreateNetworkNodeParams

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DbSystemCreateNetworkNodeParams"
    }
}

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

型: array

ネットワークのNTPサーバー

Show Source

配列: string

{
    "type":"array",
    "description":"NTP servers of the network",
    "items":{
        "type":"string"
    }
}

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

型: array

DBシステム・データベースのSCAN IP

Show Source

配列: string

{
    "type":"array",
    "description":"SCAN IPs for the DB system database",
    "items":{
        "type":"string"
    }
}

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

型: object

Show Source

gateway(required): string

DBシステム・ノードのゲートウェイ
ipAddress(required): string

DBシステム・ノードのIPアドレス
name(required): string

DBシステム・ノードの名前
netmask(required): string

DBシステム・ノードのネットマスク
number(required): integer

DBシステム・ノードの数
vipAddress: string

DBシステム・ノードの仮想IPアドレス
vipName: string

DBシステム・ノードの仮想IP名

{
    "type":"object",
    "required":[
        "number",
        "name",
        "ipAddress",
        "netmask",
        "gateway"
    ],
    "properties":{
        "number":{
            "type":"integer",
            "description":"Number of the DB system node"
        },
        "name":{
            "type":"string",
            "description":"Name of the DB system node"
        },
        "ipAddress":{
            "type":"string",
            "description":"IP address of the DB system node"
        },
        "netmask":{
            "type":"string",
            "description":"Netmask of the DB system node"
        },
        "gateway":{
            "type":"string",
            "description":"Gateway of the DB system node"
        },
        "vipName":{
            "type":"string",
            "description":"Virtual IP name of the DB system node"
        },
        "vipAddress":{
            "type":"string",
            "description":"Virtual IP address of the DB system node"
        }
    }
}

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

型: array

Show Source

配列: string

バックアップの暗号化に使用するRMANバックアップ・パスワード

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"RMAN backup password used to encrypt backups"
    }
}

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

型: object

新しいDB System内のデータベースのリストアに使用する必要があるバックアップ・レポートの詳細

Show Source

backupReport: object BackupReport
backupReportId: string

バックアップ・レポートのODAリソースID
backupReportPath: string

ローカル・ベア・メタルに存在するバックアップ・レポートJSONファイルのパス

{
    "type":"object",
    "description":"Details of the backup report that must be used to restore the database within a new DB System",
    "properties":{
        "backupReportId":{
            "type":"string",
            "description":"ODA resource ID of the backup report"
        },
        "backupReportPath":{
            "type":"string",
            "description":"Path of the backup report JSON file present in local Bare Metal"
        },
        "backupReport":{
            "$ref":"#/definitions/BackupReport"
        }
    }
}

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

型: object

新しいDB System内でリストアされたデータベース用にカスタマイズできるデータベース・パラメータ

Show Source

backupLocation: string

データベース・バックアップのロケーション
dbClass: string

データベースのクラス(OLTP|DSS|IMDB)
dbConsoleEnable: boolean

データベース・コンソールが有効かどうか
dbDomainName: string

データベースのドメイン名
dbEdition: string

データベースのエディション(SE|EE)
dbName: string

データベースの名前。
dbRedundancy: string

データベースの冗長性
dbShape: string

データベースのシェイプ(odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)
dbType: string

データベースのタイプ(RAC|RACOne|SI)
dbUniqueName: string

データベースの一意の名前
enableEEHA: boolean

HA for EE SIデータベースの有効化
enableSEHA: boolean

19c以降のSIデータベースに対するSEのHAの有効化
tdeFilesLocation: string

TDEウォレット・バックアップのロケーション

{
    "type":"object",
    "description":"Database parameters that can be customized for restored database within a new DB System",
    "properties":{
        "dbName":{
            "type":"string",
            "description":"Name of the database"
        },
        "dbUniqueName":{
            "type":"string",
            "description":"Unique name of the database"
        },
        "dbClass":{
            "type":"string",
            "description":"Class of the database (OLTP|DSS|IMDB)"
        },
        "dbType":{
            "type":"string",
            "description":"Type of the database (RAC|RACOne|SI)"
        },
        "dbEdition":{
            "type":"string",
            "description":"Edition of the database (SE|EE)"
        },
        "dbRedundancy":{
            "type":"string",
            "description":"Redundancy of the database"
        },
        "dbDomainName":{
            "type":"string",
            "description":"Domain name of the database"
        },
        "dbShape":{
            "type":"string",
            "description":"Shape of the database (odb1s|odb1|odb2|odb4|odb6| odb8|odb10|odb12|odb16|odb20|odb24|odb28|odb32| odb36|odb42|odb48|odb56|odb64)"
        },
        "dbConsoleEnable":{
            "type":"boolean",
            "description":"Whether or not the database console is enabled"
        },
        "enableSEHA":{
            "description":"Enable HA for SE for 19c and later SI database",
            "type":"boolean"
        },
        "enableEEHA":{
            "description":"Enable HA for EE SI database",
            "type":"boolean"
        },
        "backupLocation":{
            "type":"string",
            "description":"Database backup location"
        },
        "tdeFilesLocation":{
            "type":"string",
            "description":"TDE wallet backup location"
        }
    }
}

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

型: object

バックアップとその宛先の詳細

Show Source

nfsDetails: object DbSystemCreateRestoreBackupNfsDetails

バックアップが存在するNFSのロケーションの詳細
objectStoreDetails: object DbSystemCreateRestoreBackupObjectStoreDetails

バックアップが存在するオブジェクト・ストアの詳細
rmanBackupEncrypted: boolean

バックアップがRMANによって暗号化されていることを示すフラグ。
tdeEnabled: boolean

TDE対応を使用してバックアップが暗号化されていることを示すフラグ

{
    "type":"object",
    "description":"Details of the backup and its destination",
    "properties":{
        "objectStoreDetails":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupObjectStoreDetails"
        },
        "nfsDetails":{
            "$ref":"#/definitions/DbSystemCreateRestoreBackupNfsDetails"
        },
        "tdeEnabled":{
            "type":"boolean",
            "description":"Flag to indicate backups are encryted using TDE enabled"
        },
        "rmanBackupEncrypted":{
            "type":"boolean",
            "description":"Flag to indicate backups are encrypted by RMAN."
        }
    }
}

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

型: object

Show Source

backupLocation: string
backupLogLoc: string
backupReportLogDetail: string
backupType: string
cfBackupHandle: string
compressionAlgo: string

データベースが構成されているRMAN圧縮アルゴリズム。
cpuPool: string

CPUプール名を定義
createTime: string(date-time)
dbConfigLoc: string
dbDataSize: string
dbId: string
dbInfo: object DbInfo
dbName: string
dbRedoSize: string
dbResId: string
dbUniqueName: string
id: string
keepDays: integer
keystoreType: string

TDEマスター暗号化キーを格納するキーストアのタイプ。ソフトウェアまたはOKV。
name: string

リソースの表示名
numberOfCores: integer

コア数を定義
okvWalletName: string

データベースに対応するOKVサーバーに存在するウォレットの名前。
oraHomeVersion: string
pitrSCN: string
pitrTimeStamp: string(date-time)
resetLogsSCN: string
resetLogsTimeStamp: string(date-time)
rmanBackupPieces: string
spfBackupHandle: string
sqlPatches: string
state: object ResourceState
tag: string
tdeWalletLoc: string
updatedTime: string(date-time)

{
    "properties":{
        "id":{
            "type":"string"
        },
        "dbResId":{
            "type":"string"
        },
        "tag":{
            "type":"string"
        },
        "dbId":{
            "type":"string"
        },
        "dbName":{
            "type":"string"
        },
        "dbUniqueName":{
            "type":"string"
        },
        "backupType":{
            "type":"string"
        },
        "keepDays":{
            "type":"integer"
        },
        "backupLocation":{
            "type":"string"
        },
        "cfBackupHandle":{
            "type":"string"
        },
        "spfBackupHandle":{
            "type":"string"
        },
        "pitrTimeStamp":{
            "type":"string",
            "format":"date-time"
        },
        "pitrSCN":{
            "type":"string"
        },
        "resetLogsTimeStamp":{
            "type":"string",
            "format":"date-time"
        },
        "resetLogsSCN":{
            "type":"string"
        },
        "oraHomeVersion":{
            "type":"string"
        },
        "sqlPatches":{
            "type":"string"
        },
        "backupLogLoc":{
            "type":"string"
        },
        "tdeWalletLoc":{
            "type":"string"
        },
        "dbConfigLoc":{
            "type":"string"
        },
        "name":{
            "description":"display name for the resource",
            "type":"string"
        },
        "createTime":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "$ref":"#/definitions/ResourceState"
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        },
        "backupReportLogDetail":{
            "type":"string"
        },
        "dbInfo":{
            "$ref":"#/definitions/DbInfo"
        },
        "dbDataSize":{
            "type":"string"
        },
        "dbRedoSize":{
            "type":"string"
        },
        "rmanBackupPieces":{
            "type":"string"
        },
        "compressionAlgo":{
            "type":"string",
            "description":"The RMAN compression algorithm that the database is configured."
        },
        "cpuPool":{
            "description":"Defines the CPU Pool name",
            "type":"string"
        },
        "numberOfCores":{
            "description":"Defines the number of cores",
            "type":"integer"
        },
        "keystoreType":{
            "description":"Type of keystore, which stores TDE Master Encryption Key. Either Software or OKV.",
            "type":"string"
        },
        "okvWalletName":{
            "type":"string",
            "description":"Name of the wallet present in OKV Server corresponding to the database."
        }
    }
}

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

型: object

Show Source

dbClass: string
dbEdition: string
dbRedundancy: string
dbShape: string
dbStorage: string
dbType: string
isCdb: boolean
pdbName: string

{
    "properties":{
        "dbClass":{
            "type":"string"
        },
        "dbType":{
            "type":"string"
        },
        "dbShape":{
            "type":"string"
        },
        "dbEdition":{
            "type":"string"
        },
        "dbStorage":{
            "type":"string"
        },
        "dbRedundancy":{
            "type":"string"
        },
        "pdbName":{
            "type":"string"
        },
        "isCdb":{
            "type":"boolean"
        }
    }
}

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

型: object

Show Source

status: string

許容値: [ "CREATING", "CONFIGURED", "UPDATING", "DELETING", "FAILED", "RUNNING", "ENABLED", "DISABLED", "STALE" ]

{
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "CREATING",
                "CONFIGURED",
                "UPDATING",
                "DELETING",
                "FAILED",
                "RUNNING",
                "ENABLED",
                "DISABLED",
                "STALE"
            ]
        }
    }
}

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

型: object

バックアップが存在するNFSのロケーションの詳細

Show Source

serverIP(required): string

NFSサーバーのロケーションが使用可能なマシンのIPアドレス
serverLocation(required): string

NFSサーバーのロケーション

{
    "description":"Details to NFS location where backups are present",
    "required":[
        "serverIP",
        "serverLocation"
    ],
    "properties":{
        "serverIP":{
            "description":"IP address of the machine where NFS server location is available",
            "type":"string"
        },
        "serverLocation":{
            "description":"NFS server location",
            "type":"string"
        }
    }
}

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

型: object

バックアップが存在するオブジェクト・ストアの詳細

Show Source

endPointURL: string

オブジェクト・ストアのエンド・ポイントURL
objectStoreSwiftName(required): string

オブジェクト・ストアSwiftオブジェクトの名前
password: string

オブジェクト・ストアのパスワード
tenantName: string

オブジェクト・ストア・テナンシの名前
userName: string

オブジェクト・ストアのユーザー名

{
    "description":"Details of the Object Store where backups are present",
    "required":[
        "objectStoreSwiftName"
    ],
    "properties":{
        "objectStoreSwiftName":{
            "description":"Name of the Object Store Swift object",
            "type":"string"
        },
        "tenantName":{
            "description":"Name of the Object Store tenancy",
            "type":"string"
        },
        "userName":{
            "description":"Object Store user name",
            "type":"string"
        },
        "endPointURL":{
            "description":"Object Store end point URL",
            "type":"string"
        },
        "password":{
            "description":"Object Store password",
            "type":"string"
        }
    }
}

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

型: object

Show Source

groups(required): array groups
users(required): array users

{
    "type":"object",
    "required":[
        "groups",
        "users"
    ],
    "properties":{
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCreateGroupParams"
            }
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DbSystemCreateUserParams"
            }
        }
    }
}

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

型: object

Show Source

configurations: object DbSystemCreateIdmConfigurationsParams
isMultiUserAccessEnabled: boolean

この環境でマルチ・ユーザー・アクセスを有効にするには、このフラグをtrueに設定します。
isMultiUserAccessPLEnabled: boolean

この環境でパスワードなしのマルチ・ユーザー・アクセスを有効にするには、このフラグをtrueに設定します。
userCredentials: object DbSystemCreateIdmUserCredentialsParams

{
    "properties":{
        "isMultiUserAccessEnabled":{
            "type":"boolean",
            "description":"Set this flag to true to enable multi user access on this environment."
        },
        "isMultiUserAccessPLEnabled":{
            "type":"boolean",
            "description":"Set this flag to true to enable passwordless multi user access on this environment."
        },
        "userCredentials":{
            "$ref":"#/definitions/DbSystemCreateIdmUserCredentialsParams"
        },
        "configurations":{
            "$ref":"#/definitions/DbSystemCreateIdmConfigurationsParams"
        }
    }
}

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

型: array

Show Source

Array of: object DbSystemCreateGroupParams

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DbSystemCreateGroupParams"
    }
}

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

型: array

Show Source

Array of: object DbSystemCreateUserParams

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DbSystemCreateUserParams"
    }
}

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

型: object

Show Source

id(required): integer

グループのID
name(required): string

グループの名前
role(required): string

グループのロール

{
    "type":"object",
    "required":[
        "id",
        "name",
        "role"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID for the group"
        },
        "name":{
            "type":"string",
            "description":"Name for the group"
        },
        "role":{
            "type":"string",
            "description":"Role for the group"
        }
    }
}

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

型: object

Show Source

id(required): integer

ユーザーのID
name(required): string

ユーザーの名前
role(required): string

ユーザーのロール

{
    "type":"object",
    "required":[
        "id",
        "name",
        "role"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "description":"ID for the user"
        },
        "name":{
            "type":"string",
            "description":"Name for the user"
        },
        "role":{
            "type":"string",
            "description":"Role for the user"
        }
    }
}

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

型: object

Show Source

dcsUserPasswdExpDurationInDays: integer

DCSユーザーのパスワード失効期間(日数)
maxNumFailedLoginAttempts: integer

ユーザー・アカウントがロックされるまでのログイン試行の最大失敗回数
metadataStoreName: string

IDMサービス・プロバイダの永続ストア
passwordResetDurationInMins: integer

ロックされたアカウントのパスワードのリセットが必要な期間(分)
providerName: string

IDMサービス・プロバイダの名前
tokenExpirationInMins: integer

認証トークンの有効期限(分)

{
    "type":"object",
    "properties":{
        "providerName":{
            "type":"string",
            "description":"Name of the IDM service provider"
        },
        "metadataStoreName":{
            "type":"string",
            "description":"Persistent Store for the IDM service provider"
        },
        "dcsUserPasswdExpDurationInDays":{
            "type":"integer",
            "description":"Password expiry duration in days for DCS user"
        },
        "tokenExpirationInMins":{
            "type":"integer",
            "description":"Auth Token expiration duration in minutes"
        },
        "maxNumFailedLoginAttempts":{
            "type":"integer",
            "description":"Max number of failed login attempts allowed after which the user account gets locked"
        },
        "passwordResetDurationInMins":{
            "type":"integer",
            "description":"Time duration in minutes in which password needs to be reset for a locked account"
        }
    }
}

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

型: object

Show Source

gridUserPasswd: string

gridUserロールを持つシステム・ユーザーのパスワード
odaadminUserPasswd: string

ODA-ADMINISTRATORロールを持つシステム・ユーザーのパスワード
oracleUserPasswd: string

oracleUserロールを持つシステム・ユーザーのパスワード

{
    "type":"object",
    "properties":{
        "oracleUserPasswd":{
            "type":"string",
            "description":"Password for the system user with oracleUser role"
        },
        "gridUserPasswd":{
            "type":"string",
            "description":"Password for the system user with gridUser role"
        },
        "odaadminUserPasswd":{
            "type":"string",
            "description":"Password for the system user with ODA-ADMINISTRATOR role"
        }
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ : KvmJob

型: object

Show Source

jobId: string
jobReport: object ServiceJobReport

ジョブ・リクエストのステータス
syncJob: boolean

{
    "type":"object",
    "properties":{
        "syncJob":{
            "type":"boolean"
        },
        "jobId":{
            "type":"string"
        },
        "jobReport":{
            "$ref":"#/definitions/ServiceJobReport"
        }
    }
}

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

型: object

ジョブ・リクエストのステータス

Show Source

createTimestamp: string(date-time)
description: string
jobId: string
jobType: string
message: string
reports: array reports
resourceList: array resourceList
status: string

許容値: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure" ]
updatedTime: string(date-time)

{
    "description":"Job Request Status",
    "properties":{
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure"
            ]
        },
        "message":{
            "type":"string"
        },
        "reports":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskReport"
            }
        },
        "createTimestamp":{
            "type":"string",
            "format":"date-time"
        },
        "resourceList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobResourceInfo"
            }
        },
        "description":{
            "type":"string"
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        },
        "jobType":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : レポート

型: array

Show Source

Array of: object TaskReport

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaskReport"
    }
}

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

型: array

Show Source

Array of: object JobResourceInfo

リソース情報

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobResourceInfo"
    }
}

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

型: object

Show Source

duration: string
endTime: string(date-time)
jobId: string
nodeName: string
parentTaskId: string
reportLevel: string

許容値: [ "Verbose", "Info", "Error" ]
startTime: string(date-time)
status: string

許容値: [ "Created", "Scheduled", "Running", "Success", "Failure", "Retrying", "Waiting", "InternalError", "Reverting", "Reverted", "NodeDisconnectedFailure", "Skipped" ]
tags: array tags
taskDescription: string
taskId: string
taskName: string
taskResult: string
updatedTime: string(date-time)

{
    "properties":{
        "taskId":{
            "type":"string"
        },
        "taskName":{
            "type":"string"
        },
        "nodeName":{
            "type":"string"
        },
        "taskResult":{
            "type":"string"
        },
        "startTime":{
            "type":"string",
            "format":"date-time"
        },
        "endTime":{
            "type":"string",
            "format":"date-time"
        },
        "duration":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "Created",
                "Scheduled",
                "Running",
                "Success",
                "Failure",
                "Retrying",
                "Waiting",
                "InternalError",
                "Reverting",
                "Reverted",
                "NodeDisconnectedFailure",
                "Skipped"
            ]
        },
        "taskDescription":{
            "type":"string"
        },
        "parentTaskId":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "reportLevel":{
            "type":"string",
            "enum":[
                "Verbose",
                "Info",
                "Error"
            ]
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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

型: array

Show Source

配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: object

リソース情報

Show Source

jobId: string
resourceId: string
resourceNewType: string
resourceType: string

許容値: [ "Backup", "BackupConfig", "DB", "DbHome", "Grid", "Pdb", "Recovery", "Report", "Tde", "ObjectStoreSwift" ]
updatedTime: string(date-time)

{
    "description":"resource information",
    "properties":{
        "resourceId":{
            "type":"string"
        },
        "resourceType":{
            "type":"string",
            "enum":[
                "Backup",
                "BackupConfig",
                "DB",
                "DbHome",
                "Grid",
                "Pdb",
                "Recovery",
                "Report",
                "Tde",
                "ObjectStoreSwift"
            ]
        },
        "resourceNewType":{
            "type":"string"
        },
        "jobId":{
            "type":"string"
        },
        "updatedTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

デフォルト・レスポンス

予期しないエラーが発生しました

ルート・スキーマ : エラー

型: object

Show Source

code(required): string
message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る