Skip to main content

db_servers

Creates, updates, deletes, gets or lists a db_servers resource.

Overview​

Namedb_servers
TypeResource
Idoci.database.db_servers

Fields​

The following fields are returned by SELECT queries:

Information about the Exadata Db server.

NameDatatypeDescription
idstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Db server.
autonomousVirtualMachineIdsarrayThe list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Autonomous Virtual Machines associated with the Db server.
autonomousVmClusterIdsarrayThe list of [OCIDs](/Content/General/Concepts/identifiers.htm) of the Autonomous VM Clusters associated with the Db server.
compartmentIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
computeModelstringThe compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. (ECPU, OCPU) (x-default-description: Null used when unspecified.)
cpuCoreCountintegerThe number of CPU cores enabled on the Db server.
dbNodeIdsarrayThe [OCID](/Content/General/Concepts/identifiers.htm) of the Db nodes associated with the Db server.
dbNodeStorageSizeInGBsintegerThe allocated local node storage in GBs on the Db server.
dbServerPatchingDetailsobjectThe scheduling details for the quarterly maintenance window. Patching and system updates take place during the maintenance window.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
displayNamestringThe user-friendly name for the Db server. The name does not need to be unique.
exadataInfrastructureIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
freeformTagsobjectFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringThe current state of the Db server. (CREATING, AVAILABLE, UNAVAILABLE, DELETING, DELETED, MAINTENANCE_IN_PROGRESS)
maxCpuCountintegerThe total number of CPU cores available.
maxDbNodeStorageInGBsintegerThe total local node storage available in GBs.
maxMemoryInGBsintegerThe total memory available in GBs.
memorySizeInGBsintegerThe allocated memory in GBs on the Db server.
shapestringThe shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.
systemTagsobjectSystem tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreatedstring (date-time)The date and time that the Db Server was created.
vmClusterIdsarrayThe [OCID](/Content/General/Concepts/identifiers.htm) of the VM Clusters associated with the Db server.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectexadataInfrastructureId, dbServerId, regionopc-request-idGets information about the Exadata Db server.<br />
listselectcompartmentId, exadataInfrastructureId, regionlimit, page, sortOrder, opc-request-id, sortBy, lifecycleState, displayNameLists the Exadata DB servers in the ExadataInfrastructureId and specified compartment.<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
compartmentIdstringThe compartment [OCID](/Content/General/Concepts/identifiers.htm).
dbServerIdstringThe DB server [OCID](/Content/General/Concepts/identifiers.htm).
exadataInfrastructureIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the ExadataInfrastructure.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
displayNamestringA filter to return only resources that match the entire display name given. The match is not case sensitive.
lifecycleStatestringA filter to return only resources that match the given lifecycle state exactly.
limitintegerThe maximum number of items to return per page.
opc-request-idstringUnique identifier for the request.
pagestringThe pagination token to continue listing from.
sortBystringSort by TIMECREATED. Default order for TIMECREATED is descending.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples​

Gets information about the Exadata Db server.<br />

SELECT
id,
autonomousVirtualMachineIds,
autonomousVmClusterIds,
compartmentId,
computeModel,
cpuCoreCount,
dbNodeIds,
dbNodeStorageSizeInGBs,
dbServerPatchingDetails,
definedTags,
displayName,
exadataInfrastructureId,
freeformTags,
lifecycleDetails,
lifecycleState,
maxCpuCount,
maxDbNodeStorageInGBs,
maxMemoryInGBs,
memorySizeInGBs,
shape,
systemTags,
timeCreated,
vmClusterIds
FROM oci.database.db_servers
WHERE exadataInfrastructureId = '{{ exadataInfrastructureId }}' -- required
AND dbServerId = '{{ dbServerId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;