REST Resource: projects.locations.dbSystems

Resource: DbSystem

Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/

JSON representation 
{
  "name": string,
  "properties": {
    object (DbSystemProperties)
  },
  "gcpOracleZone": string,
  "labels": {
    string: string,
    ...
  },
  "odbNetwork": string,
  "odbSubnet": string,
  "entitlementId": string,
  "displayName": string,
  "createTime": string,
  "ociUrl": string
}
Fields
name

string

Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{dbSystem}
properties

object (DbSystemProperties)

Optional. The properties of the DbSystem.
gcpOracleZone

string

Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
labels

map (key: string, value: string)

Optional. The labels or tags associated with the DbSystem.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
odbNetwork

string

Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odbNetwork} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
odbSubnet

string

Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odbNetwork}/odbSubnets/{odbSubnet}
entitlementId

string

Output only. The ID of the subscription entitlement associated with the DbSystem
displayName

string

Required. The display name for the System db. The name does not have to be unique within your project.
createTime

string (Timestamp format)

Output only. The date and time that the DbSystem was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
ociUrl

string

Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.

DbSystemProperties

The properties of a DbSystem.

JSON representation 
{
  "shape": string,
  "computeCount": integer,
  "initialDataStorageSizeGb": integer,
  "databaseEdition": enum (DbSystemDatabaseEdition),
  "licenseModel": enum (LicenseModel),
  "sshPublicKeys": [
    string
  ],
  "hostnamePrefix": string,
  "hostname": string,
  "privateIp": string,
  "dataCollectionOptions": {
    object (DataCollectionOptionsDbSystem)
  },
  "timeZone": {
    object (TimeZone)
  },
  "lifecycleState": enum (DbSystemLifecycleState),
  "dbHome": {
    object (DbHome)
  },
  "ocid": string,
  "memorySizeGb": integer,
  "computeModel": enum (ComputeModel),
  "dataStorageSizeGb": integer,
  "recoStorageSizeGb": integer,
  "domain": string,
  "nodeCount": integer,
  "dbSystemOptions": {
    object (DbSystemOptions)
  }
}
Fields
shape

string

Required. Shape of DB System.
computeCount

integer

Required. The number of CPU cores to enable for the DbSystem.
initialDataStorageSizeGb

integer

Required. The initial data storage size in GB.
databaseEdition

enum (DbSystemDatabaseEdition)

Required. The database edition of the DbSystem.
licenseModel

enum (LicenseModel)

Required. The license model of the DbSystem.
sshPublicKeys[]

string

Required. SSH public keys to be stored with the DbSystem.
hostnamePrefix

string

Optional. Prefix for DB System host names.
hostname

string

Output only. The hostname of the DbSystem.
privateIp

string

Optional. The private IP address of the DbSystem.
dataCollectionOptions

object (DataCollectionOptionsDbSystem)

Optional. Data collection options for diagnostics.
timeZone

object (TimeZone)

Optional. Time zone of the DbSystem.
lifecycleState

enum (DbSystemLifecycleState)

Output only. State of the DbSystem.
dbHome

object (DbHome)

Optional. Details for creating a Database Home.
ocid

string

Output only. OCID of the DbSystem.
memorySizeGb

integer

Optional. The memory size in GB.
computeModel

enum (ComputeModel)

Optional. The compute model of the DbSystem.
dataStorageSizeGb

integer

Optional. The data storage size in GB that is currently available to DbSystems.
recoStorageSizeGb

integer

Optional. The reco/redo storage size in GB.
domain

string

Optional. The host domain name of the DbSystem.
nodeCount

integer

Optional. The number of nodes in the DbSystem.
dbSystemOptions

object (DbSystemOptions)

Optional. The options for the DbSystem.

DbSystemDatabaseEdition

The editions available for DbSystem.

Enums
DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED The database edition is unspecified.
STANDARD_EDITION The database edition is Standard.
ENTERPRISE_EDITION The database edition is Enterprise.
ENTERPRISE_EDITION_HIGH_PERFORMANCE The database edition is Enterprise Edition.

LicenseModel

The license model of the DbSystem.

Enums
LICENSE_MODEL_UNSPECIFIED The license model is unspecified.
LICENSE_INCLUDED The license model is included.
BRING_YOUR_OWN_LICENSE The license model is bring your own license.

DataCollectionOptionsDbSystem

Data collection options for DbSystem.

JSON representation 
{
  "isDiagnosticsEventsEnabled": boolean,
  "isIncidentLogsEnabled": boolean
}
Fields
isDiagnosticsEventsEnabled

boolean

Optional. Indicates whether to enable data collection for diagnostics.
isIncidentLogsEnabled

boolean

Optional. Indicates whether to enable incident logs and trace collection.

DbSystemLifecycleState

The various lifecycle states of the DbSystem.

Enums
DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED Default unspecified value.
PROVISIONING Indicates that the resource is in provisioning state.
AVAILABLE Indicates that the resource is in available state.
UPDATING Indicates that the resource is in updating state.
TERMINATING Indicates that the resource is in terminating state.
TERMINATED Indicates that the resource is in terminated state.
FAILED Indicates that the resource is in failed state.
MIGRATED Indicates that the resource has been migrated.
MAINTENANCE_IN_PROGRESS Indicates that the resource is in maintenance in progress state.
NEEDS_ATTENTION Indicates that the resource needs attention.
UPGRADING Indicates that the resource is upgrading.

DbHome

Details of the Database Home resource.

JSON representation 
{
  "displayName": string,
  "dbVersion": string,
  "database": {
    object (Database)
  },
  "isUnifiedAuditingEnabled": boolean
}
Fields
displayName

string

Optional. The display name for the Database Home. The name does not have to be unique within your project.
dbVersion

string

Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
database

object (Database)

Required. The Database resource.
isUnifiedAuditingEnabled

boolean

Optional. Whether unified auditing is enabled for the Database Home.

ComputeModel

The compute model of the DbSystem.

Enums
COMPUTE_MODEL_UNSPECIFIED The compute model is unspecified.
ECPU The compute model is virtual.
OCPU The compute model is physical.

DbSystemOptions

Details of the DbSystem Options.

JSON representation 
{
  "storageManagement": enum (StorageManagement)
}
Fields
storageManagement

enum (StorageManagement)

Optional. The storage option used in DB system.

StorageManagement

The storage option used in DB system.

Enums
STORAGE_MANAGEMENT_UNSPECIFIED The storage management is unspecified.
ASM Automatic storage management.
LVM Logical Volume management.

Methods

create

 Creates a new DbSystem in a given project and location.

delete

 Deletes a single DbSystem.

get

 Gets details of a single DbSystem.

list

 Lists all the DbSystems for the given project and location.