2025/12/10 - odb - 4 updated api methods
Changes The following APIs now return CloudExadataInfrastructureArn and OdbNetworkArn fields for improved resource identification and AWS service integration - GetCloudVmCluster, ListCloudVmClusters, GetCloudAutonomousVmCluster, and ListCloudAutonomousVmClusters.
{'cloudAutonomousVmCluster': {'cloudExadataInfrastructureArn': 'string',
'odbNetworkArn': 'string'}}
Gets information about a specific Autonomous VM cluster.
See also: AWS API Documentation
Request Syntax
client.get_cloud_autonomous_vm_cluster(
cloudAutonomousVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the Autonomous VM cluster to retrieve information about.
dict
Response Syntax
{
'cloudAutonomousVmCluster': {
'cloudAutonomousVmClusterId': 'string',
'cloudAutonomousVmClusterArn': 'string',
'odbNetworkId': 'string',
'odbNetworkArn': 'string',
'ociResourceAnchorName': 'string',
'percentProgress': ...,
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureId': 'string',
'cloudExadataInfrastructureArn': 'string',
'autonomousDataStoragePercentage': ...,
'autonomousDataStorageSizeInTBs': 123.0,
'availableAutonomousDataStorageSizeInTBs': 123.0,
'availableContainerDatabases': 123,
'availableCpus': ...,
'computeModel': 'ECPU'|'OCPU',
'cpuCoreCount': 123,
'cpuCoreCountPerNode': 123,
'cpuPercentage': ...,
'dataStorageSizeInGBs': 123.0,
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'description': 'string',
'domain': 'string',
'exadataStorageInTBsLowestScaledValue': 123.0,
'hostname': 'string',
'ocid': 'string',
'ociUrl': 'string',
'isMtlsEnabledVmCluster': True|False,
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'maintenanceWindow': {
'customActionTimeoutInMins': 123,
'daysOfWeek': [
{
'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
},
],
'hoursOfDay': [
123,
],
'isCustomActionTimeoutEnabled': True|False,
'leadTimeInWeeks': 123,
'months': [
{
'name': 'JANUARY'|'FEBRUARY'|'MARCH'|'APRIL'|'MAY'|'JUNE'|'JULY'|'AUGUST'|'SEPTEMBER'|'OCTOBER'|'NOVEMBER'|'DECEMBER'
},
],
'patchingMode': 'ROLLING'|'NONROLLING',
'preference': 'NO_PREFERENCE'|'CUSTOM_PREFERENCE',
'skipRu': True|False,
'weeksOfMonth': [
123,
]
},
'maxAcdsLowestScaledValue': 123,
'memoryPerOracleComputeUnitInGBs': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'nonProvisionableAutonomousContainerDatabases': 123,
'provisionableAutonomousContainerDatabases': 123,
'provisionedAutonomousContainerDatabases': 123,
'provisionedCpus': ...,
'reclaimableCpus': ...,
'reservedCpus': ...,
'scanListenerPortNonTls': 123,
'scanListenerPortTls': 123,
'shape': 'string',
'createdAt': datetime(2015, 1, 1),
'timeDatabaseSslCertificateExpires': datetime(2015, 1, 1),
'timeOrdsCertificateExpires': datetime(2015, 1, 1),
'timeZone': 'string',
'totalContainerDatabases': 123
}
}
Response Structure
(dict) --
cloudAutonomousVmCluster (dict) --
The details of the requested Autonomous VM cluster.
cloudAutonomousVmClusterId (string) --
The unique identifier of the Autonomous VM cluster.
cloudAutonomousVmClusterArn (string) --
The Amazon Resource Name (ARN) for the Autonomous VM cluster.
odbNetworkId (string) --
The unique identifier of the ODB network associated with this Autonomous VM cluster.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this Autonomous VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor associated with this Autonomous VM cluster.
percentProgress (float) --
The progress of the current operation on the Autonomous VM cluster, as a percentage.
displayName (string) --
The display name of the Autonomous VM cluster.
status (string) --
The current state of the Autonomous VM cluster. Possible values include CREATING, AVAILABLE, UPDATING, DELETING, DELETED, FAILED.
statusReason (string) --
Additional information about the current status of the Autonomous VM cluster.
cloudExadataInfrastructureId (string) --
The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.
autonomousDataStoragePercentage (float) --
The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.
autonomousDataStorageSizeInTBs (float) --
The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.
availableAutonomousDataStorageSizeInTBs (float) --
The available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB.
availableContainerDatabases (integer) --
The number of Autonomous CDBs that you can create with the currently available storage.
availableCpus (float) --
The number of CPU cores available for allocation to Autonomous Databases.
computeModel (string) --
The compute model of the Autonomous VM cluster: ECPU or OCPU.
cpuCoreCount (integer) --
The total number of CPU cores in the Autonomous VM cluster.
cpuCoreCountPerNode (integer) --
The number of CPU cores enabled per node in the Autonomous VM cluster.
cpuPercentage (float) --
The percentage of total CPU cores currently in use in the Autonomous VM cluster.
dataStorageSizeInGBs (float) --
The total data storage allocated to the Autonomous VM cluster, in GB.
dataStorageSizeInTBs (float) --
The total data storage allocated to the Autonomous VM cluster, in TB.
dbNodeStorageSizeInGBs (integer) --
The local node storage allocated to the Autonomous VM cluster, in gigabytes (GB).
dbServers (list) --
The list of database servers associated with the Autonomous VM cluster.
(string) --
description (string) --
The user-provided description of the Autonomous VM cluster.
domain (string) --
The domain name for the Autonomous VM cluster.
exadataStorageInTBsLowestScaledValue (float) --
The minimum value to which you can scale down the Exadata storage, in TB.
hostname (string) --
The hostname for the Autonomous VM cluster.
ocid (string) --
The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.
ociUrl (string) --
The URL for accessing the OCI console page for this Autonomous VM cluster.
isMtlsEnabledVmCluster (boolean) --
Indicates whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
licenseModel (string) --
The Oracle license model that applies to the Autonomous VM cluster.
maintenanceWindow (dict) --
The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
customActionTimeoutInMins (integer) --
The custom action timeout in minutes for the maintenance window.
daysOfWeek (list) --
The days of the week when maintenance can be performed.
(dict) --
An enumeration of days of the week used for scheduling maintenance windows.
name (string) --
The name of the day of the week.
hoursOfDay (list) --
The hours of the day when maintenance can be performed.
(integer) --
isCustomActionTimeoutEnabled (boolean) --
Indicates whether custom action timeout is enabled for the maintenance window.
leadTimeInWeeks (integer) --
The lead time in weeks before the maintenance window.
months (list) --
The months when maintenance can be performed.
(dict) --
An enumeration of months used for scheduling maintenance windows.
name (string) --
The name of the month.
patchingMode (string) --
The patching mode for the maintenance window.
preference (string) --
The preference for the maintenance window scheduling.
skipRu (boolean) --
Indicates whether to skip release updates during maintenance.
weeksOfMonth (list) --
The weeks of the month when maintenance can be performed.
(integer) --
maxAcdsLowestScaledValue (integer) --
The minimum value to which you can scale down the maximum number of Autonomous CDBs.
memoryPerOracleComputeUnitInGBs (integer) --
The amount of memory allocated per Oracle Compute Unit, in GB.
memorySizeInGBs (integer) --
The total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB).
nodeCount (integer) --
The number of database server nodes in the Autonomous VM cluster.
nonProvisionableAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs that can't be provisioned because of resource constraints.
provisionableAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster.
provisionedAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs currently provisioned in the Autonomous VM cluster.
provisionedCpus (float) --
The number of CPU cores currently provisioned in the Autonomous VM cluster.
reclaimableCpus (float) --
The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases.
reservedCpus (float) --
The number of CPU cores reserved for system operations and redundancy.
scanListenerPortNonTls (integer) --
The SCAN listener port for non-TLS (TCP) protocol. The default is 1521.
scanListenerPortTls (integer) --
The SCAN listener port for TLS (TCP) protocol. The default is 2484.
shape (string) --
The shape of the Exadata infrastructure for the Autonomous VM cluster.
createdAt (datetime) --
The date and time when the Autonomous VM cluster was created.
timeDatabaseSslCertificateExpires (datetime) --
The expiration date and time of the database SSL certificate.
timeOrdsCertificateExpires (datetime) --
The expiration date and time of the Oracle REST Data Services (ORDS) certificate.
timeZone (string) --
The time zone of the Autonomous VM cluster.
totalContainerDatabases (integer) --
The total number of Autonomous Container Databases that can be created with the allocated local storage.
{'cloudVmCluster': {'cloudExadataInfrastructureArn': 'string',
'odbNetworkArn': 'string'}}
Returns information about the specified VM cluster.
See also: AWS API Documentation
Request Syntax
client.get_cloud_vm_cluster(
cloudVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the VM cluster.
dict
Response Syntax
{
'cloudVmCluster': {
'cloudVmClusterId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterArn': 'string',
'cloudExadataInfrastructureId': 'string',
'cloudExadataInfrastructureArn': 'string',
'clusterName': 'string',
'cpuCoreCount': 123,
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'diskRedundancy': 'HIGH'|'NORMAL',
'giVersion': 'string',
'hostname': 'string',
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'isLocalBackupEnabled': True|False,
'isSparseDiskgroupEnabled': True|False,
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'domain': 'string',
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'shape': 'string',
'sshPublicKeys': [
'string',
],
'storageSizeInGBs': 123,
'systemVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'timeZone': 'string',
'vipIds': [
'string',
],
'odbNetworkId': 'string',
'odbNetworkArn': 'string',
'percentProgress': ...,
'computeModel': 'ECPU'|'OCPU',
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
]
}
}
Response Structure
(dict) --
cloudVmCluster (dict) --
The VM cluster.
cloudVmClusterId (string) --
The unique identifier of the VM cluster.
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterArn (string) --
The Amazon Resource Name (ARN) of the VM cluster.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Exadata infrastructure that this VM cluster belongs to.
clusterName (string) --
The name of the Grid Infrastructure (GI) cluster.
cpuCoreCount (integer) --
The number of CPU cores enabled on the VM cluster.
dataCollectionOptions (dict) --
The set of diagnostic collection options enabled for the VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
dataStorageSizeInTBs (float) --
The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers (list) --
The list of database servers for the VM cluster.
(string) --
diskRedundancy (string) --
The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname (string) --
The host name for the VM cluster.
iormConfigCache (dict) --
The ExadataIormConfig cache details for the VM cluster.
dbPlans (list) --
An array of IORM settings for all the database in the Exadata DB system.
(dict) --
The IORM configuration settings for the database.
dbName (string) --
The database name. For the default DbPlan, the dbName is default.
flashCacheLimit (string) --
The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share (integer) --
The relative priority of this database.
lifecycleDetails (string) --
Additional information about the current lifecycleState.
lifecycleState (string) --
The current state of IORM configuration for the Exadata DB system.
objective (string) --
The current value for the IORM objective. The default is AUTO.
isLocalBackupEnabled (boolean) --
Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
isSparseDiskgroupEnabled (boolean) --
Indicates whether the VM cluster is configured with a sparse disk group.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the VM cluster.
listenerPort (integer) --
The port number configured for the listener on the VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
nodeCount (integer) --
The number of nodes in the VM cluster.
ocid (string) --
The OCID of the VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the VM cluster.
ociUrl (string) --
The HTTPS link to the VM cluster in OCI.
domain (string) --
The domain of the VM cluster.
scanDnsName (string) --
The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the VM cluster.
(string) --
shape (string) --
The hardware model name of the Exadata infrastructure that's running the VM cluster.
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
storageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the VM cluster.
createdAt (datetime) --
The date and time when the VM cluster was created.
timeZone (string) --
The time zone of the VM cluster.
vipIds (list) --
The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
(string) --
odbNetworkId (string) --
The unique identifier of the ODB network for the VM cluster.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
computeModel (string) --
The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the VM cluster.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) service role associated with a resource.
iamRoleArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role.
status (string) --
The current status of the Amazon Web Services Identity and Access Management (IAM) service role.
statusReason (string) --
Additional information about the current status of the Amazon Web Services Identity and Access Management (IAM) service role, if applicable.
awsIntegration (string) --
The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role.
{'cloudAutonomousVmClusters': {'cloudExadataInfrastructureArn': 'string',
'odbNetworkArn': 'string'}}
Lists all Autonomous VM clusters in a specified Cloud Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.list_cloud_autonomous_vm_clusters(
maxResults=123,
nextToken='string',
cloudExadataInfrastructureId='string'
)
integer
The maximum number of items to return per page.
string
The pagination token to continue listing from.
string
The unique identifier of the Cloud Exadata Infrastructure that hosts the Autonomous VM clusters to be listed.
dict
Response Syntax
{
'nextToken': 'string',
'cloudAutonomousVmClusters': [
{
'cloudAutonomousVmClusterId': 'string',
'cloudAutonomousVmClusterArn': 'string',
'odbNetworkId': 'string',
'odbNetworkArn': 'string',
'ociResourceAnchorName': 'string',
'percentProgress': ...,
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudExadataInfrastructureId': 'string',
'cloudExadataInfrastructureArn': 'string',
'autonomousDataStoragePercentage': ...,
'autonomousDataStorageSizeInTBs': 123.0,
'availableAutonomousDataStorageSizeInTBs': 123.0,
'availableContainerDatabases': 123,
'availableCpus': ...,
'computeModel': 'ECPU'|'OCPU',
'cpuCoreCount': 123,
'cpuCoreCountPerNode': 123,
'cpuPercentage': ...,
'dataStorageSizeInGBs': 123.0,
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'description': 'string',
'domain': 'string',
'exadataStorageInTBsLowestScaledValue': 123.0,
'hostname': 'string',
'ocid': 'string',
'ociUrl': 'string',
'isMtlsEnabledVmCluster': True|False,
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'maintenanceWindow': {
'customActionTimeoutInMins': 123,
'daysOfWeek': [
{
'name': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY'
},
],
'hoursOfDay': [
123,
],
'isCustomActionTimeoutEnabled': True|False,
'leadTimeInWeeks': 123,
'months': [
{
'name': 'JANUARY'|'FEBRUARY'|'MARCH'|'APRIL'|'MAY'|'JUNE'|'JULY'|'AUGUST'|'SEPTEMBER'|'OCTOBER'|'NOVEMBER'|'DECEMBER'
},
],
'patchingMode': 'ROLLING'|'NONROLLING',
'preference': 'NO_PREFERENCE'|'CUSTOM_PREFERENCE',
'skipRu': True|False,
'weeksOfMonth': [
123,
]
},
'maxAcdsLowestScaledValue': 123,
'memoryPerOracleComputeUnitInGBs': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'nonProvisionableAutonomousContainerDatabases': 123,
'provisionableAutonomousContainerDatabases': 123,
'provisionedAutonomousContainerDatabases': 123,
'provisionedCpus': ...,
'reclaimableCpus': ...,
'reservedCpus': ...,
'scanListenerPortNonTls': 123,
'scanListenerPortTls': 123,
'shape': 'string',
'createdAt': datetime(2015, 1, 1),
'timeDatabaseSslCertificateExpires': datetime(2015, 1, 1),
'timeOrdsCertificateExpires': datetime(2015, 1, 1),
'timeZone': 'string',
'totalContainerDatabases': 123
},
]
}
Response Structure
(dict) --
nextToken (string) --
The pagination token to continue listing from.
cloudAutonomousVmClusters (list) --
The list of Autonomous VM clusters in the specified Cloud Exadata Infrastructure.
(dict) --
A summary of an Autonomous VM cluster.
cloudAutonomousVmClusterId (string) --
The unique identifier of the Autonomous VM cluster.
cloudAutonomousVmClusterArn (string) --
The Amazon Resource Name (ARN) for the Autonomous VM cluster.
odbNetworkId (string) --
The unique identifier of the ODB network associated with this Autonomous VM cluster.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this Autonomous VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor associated with this Autonomous VM cluster.
percentProgress (float) --
The progress of the current operation on the Autonomous VM cluster, as a percentage.
displayName (string) --
The user-friendly name for the Autonomous VM cluster.
status (string) --
The current status of the Autonomous VM cluster.
statusReason (string) --
Additional information about the current status of the Autonomous VM cluster, if applicable.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure containing this Autonomous VM cluster.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Exadata infrastructure containing this Autonomous VM cluster.
autonomousDataStoragePercentage (float) --
The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.
autonomousDataStorageSizeInTBs (float) --
The total data storage allocated for Autonomous Databases in the Autonomous VM cluster, in TB.
availableAutonomousDataStorageSizeInTBs (float) --
The available data storage for Autonomous Databases in the Autonomous VM cluster, in TB.
availableContainerDatabases (integer) --
The number of Autonomous Container Databases that you can create with the currently available storage.
availableCpus (float) --
The number of CPU cores available for allocation to Autonomous Databases.
computeModel (string) --
The compute model of the Autonomous VM cluster: ECPU or OCPU.
cpuCoreCount (integer) --
The total number of CPU cores in the Autonomous VM cluster.
cpuCoreCountPerNode (integer) --
The number of CPU cores per node in the Autonomous VM cluster.
cpuPercentage (float) --
The percentage of total CPU cores currently in use in the Autonomous VM cluster.
dataStorageSizeInGBs (float) --
The total data storage allocated to the Autonomous VM cluster, in GB.
dataStorageSizeInTBs (float) --
The total data storage allocated to the Autonomous VM cluster, in TB.
dbNodeStorageSizeInGBs (integer) --
The local node storage allocated to the Autonomous VM cluster, in GB.
dbServers (list) --
The list of database servers associated with the Autonomous VM cluster.
(string) --
description (string) --
The user-provided description of the Autonomous VM cluster.
domain (string) --
The domain name for the Autonomous VM cluster.
exadataStorageInTBsLowestScaledValue (float) --
The lowest value to which Exadata storage can be scaled down, in TB.
hostname (string) --
The host name for the Autonomous VM cluster.
ocid (string) --
The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.
ociUrl (string) --
The URL for accessing the OCI console page for this Autonomous VM cluster.
isMtlsEnabledVmCluster (boolean) --
Indicates if mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
licenseModel (string) --
The Oracle license model that applies to the Autonomous VM cluster.
maintenanceWindow (dict) --
The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
customActionTimeoutInMins (integer) --
The custom action timeout in minutes for the maintenance window.
daysOfWeek (list) --
The days of the week when maintenance can be performed.
(dict) --
An enumeration of days of the week used for scheduling maintenance windows.
name (string) --
The name of the day of the week.
hoursOfDay (list) --
The hours of the day when maintenance can be performed.
(integer) --
isCustomActionTimeoutEnabled (boolean) --
Indicates whether custom action timeout is enabled for the maintenance window.
leadTimeInWeeks (integer) --
The lead time in weeks before the maintenance window.
months (list) --
The months when maintenance can be performed.
(dict) --
An enumeration of months used for scheduling maintenance windows.
name (string) --
The name of the month.
patchingMode (string) --
The patching mode for the maintenance window.
preference (string) --
The preference for the maintenance window scheduling.
skipRu (boolean) --
Indicates whether to skip release updates during maintenance.
weeksOfMonth (list) --
The weeks of the month when maintenance can be performed.
(integer) --
maxAcdsLowestScaledValue (integer) --
The lowest value to which you can scale down the maximum number of Autonomous CDBs.
memoryPerOracleComputeUnitInGBs (integer) --
The amount of memory allocated per Oracle Compute Unit (OCU), in GB.
memorySizeInGBs (integer) --
The total amount of memory allocated to the Autonomous VM cluster, in GB.
nodeCount (integer) --
The number of database server nodes in the Autonomous VM cluster.
nonProvisionableAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs that can't be provisioned because of resource constraints.
provisionableAutonomousContainerDatabases (integer) --
The number of Autonomous CDBs that you can provision in the Autonomous VM cluster.
provisionedAutonomousContainerDatabases (integer) --
The number of Autonomous Container Databases currently provisioned in the Autonomous VM cluster.
provisionedCpus (float) --
The number of CPUs currently provisioned in the Autonomous VM cluster.
reclaimableCpus (float) --
The number of CPUs that can be reclaimed from terminated or scaled-down Autonomous Databases.
reservedCpus (float) --
The number of CPUs reserved for system operations and redundancy.
scanListenerPortNonTls (integer) --
The SCAN listener port for non-TLS (TCP) protocol.
scanListenerPortTls (integer) --
The SCAN listener port for TLS (TCP) protocol.
shape (string) --
The shape of the Exadata infrastructure for the Autonomous VM cluster.
createdAt (datetime) --
The date and time when the Autonomous VM cluster was created.
timeDatabaseSslCertificateExpires (datetime) --
The expiration date and time of the database SSL certificate.
timeOrdsCertificateExpires (datetime) --
The expiration date and time of the Oracle REST Data Services (ORDS) certificate.
timeZone (string) --
The time zone of the Autonomous VM cluster.
totalContainerDatabases (integer) --
The total number of Autonomous Container Databases that can be created in the Autonomous VM cluster.
{'cloudVmClusters': {'cloudExadataInfrastructureArn': 'string',
'odbNetworkArn': 'string'}}
Returns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.list_cloud_vm_clusters(
maxResults=123,
nextToken='string',
cloudExadataInfrastructureId='string'
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default: 10
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
string
The unique identifier of the Oracle Exadata infrastructure.
dict
Response Syntax
{
'nextToken': 'string',
'cloudVmClusters': [
{
'cloudVmClusterId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterArn': 'string',
'cloudExadataInfrastructureId': 'string',
'cloudExadataInfrastructureArn': 'string',
'clusterName': 'string',
'cpuCoreCount': 123,
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'diskRedundancy': 'HIGH'|'NORMAL',
'giVersion': 'string',
'hostname': 'string',
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'isLocalBackupEnabled': True|False,
'isSparseDiskgroupEnabled': True|False,
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'domain': 'string',
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'shape': 'string',
'sshPublicKeys': [
'string',
],
'storageSizeInGBs': 123,
'systemVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'timeZone': 'string',
'vipIds': [
'string',
],
'odbNetworkId': 'string',
'odbNetworkArn': 'string',
'percentProgress': ...,
'computeModel': 'ECPU'|'OCPU',
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
]
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
cloudVmClusters (list) --
The list of VM clusters along with their properties.
(dict) --
Information about a VM cluster.
cloudVmClusterId (string) --
The unique identifier of the VM cluster.
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterArn (string) --
The Amazon Resource Name (ARN) of the VM cluster.
cloudExadataInfrastructureId (string) --
The unique identifier of the Exadata infrastructure that this VM cluster belongs to.
cloudExadataInfrastructureArn (string) --
The Amazon Resource Name (ARN) of the Exadata infrastructure that this VM cluster belongs to.
clusterName (string) --
The name of the Grid Infrastructure (GI) cluster.
cpuCoreCount (integer) --
The number of CPU cores enabled on the VM cluster.
dataCollectionOptions (dict) --
Information about the data collection options enabled for a VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
dataStorageSizeInTBs (float) --
The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers (list) --
The list of database servers for the VM cluster.
(string) --
diskRedundancy (string) --
The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname (string) --
The host name for the VM cluster.
iormConfigCache (dict) --
The IORM settings of the Exadata DB system.
dbPlans (list) --
An array of IORM settings for all the database in the Exadata DB system.
(dict) --
The IORM configuration settings for the database.
dbName (string) --
The database name. For the default DbPlan, the dbName is default.
flashCacheLimit (string) --
The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share (integer) --
The relative priority of this database.
lifecycleDetails (string) --
Additional information about the current lifecycleState.
lifecycleState (string) --
The current state of IORM configuration for the Exadata DB system.
objective (string) --
The current value for the IORM objective. The default is AUTO.
isLocalBackupEnabled (boolean) --
Indicates whether database backups to local Exadata storage is enabled for the VM cluster.
isSparseDiskgroupEnabled (boolean) --
Indicates whether the VM cluster is configured with a sparse disk group.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the VM cluster.
listenerPort (integer) --
The port number configured for the listener on the VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
nodeCount (integer) --
The number of nodes in the VM cluster.
ocid (string) --
The OCID of the VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the VM cluster.
ociUrl (string) --
The HTTPS link to the VM cluster in OCI.
domain (string) --
The domain of the VM cluster.
scanDnsName (string) --
The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the VM cluster.
(string) --
shape (string) --
The hardware model name of the Exadata infrastructure that's running the VM cluster.
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
storageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the VM cluster.
createdAt (datetime) --
The date and time when the VM cluster was created.
timeZone (string) --
The time zone of the VM cluster.
vipIds (list) --
The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
(string) --
odbNetworkId (string) --
The unique identifier of the ODB network for the VM cluster.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network associated with this VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
computeModel (string) --
The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the VM cluster in the summary information.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) service role associated with a resource.
iamRoleArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role.
status (string) --
The current status of the Amazon Web Services Identity and Access Management (IAM) service role.
statusReason (string) --
Additional information about the current status of the Amazon Web Services Identity and Access Management (IAM) service role, if applicable.
awsIntegration (string) --
The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role.