odb / Client / get_db_node

get_db_node

odb.Client.get_db_node(**kwargs)

Returns information about the specified DB node.

See also: AWS API Documentation

Request Syntax

response = client.get_db_node(
    cloudVmClusterId='string',
    dbNodeId='string'
)
Parameters:

  • cloudVmClusterId (string) –

    [REQUIRED]

    The unique identifier of the VM cluster that contains the DB node.

  • dbNodeId (string) –

    [REQUIRED]

    The unique identifier of the DB node to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'dbNode': {
        'dbNodeId': 'string',
        'dbNodeArn': 'string',
        'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'STOPPING'|'STOPPED'|'STARTING',
        'statusReason': 'string',
        'additionalDetails': 'string',
        'backupIpId': 'string',
        'backupVnic2Id': 'string',
        'backupVnicId': 'string',
        'cpuCoreCount': 123,
        'dbNodeStorageSizeInGBs': 123,
        'dbServerId': 'string',
        'dbSystemId': 'string',
        'faultDomain': 'string',
        'hostIpId': 'string',
        'hostname': 'string',
        'ocid': 'string',
        'ociResourceAnchorName': 'string',
        'maintenanceType': 'VMDB_REBOOT_MIGRATION',
        'memorySizeInGBs': 123,
        'softwareStorageSizeInGB': 123,
        'createdAt': datetime(2015, 1, 1),
        'timeMaintenanceWindowEnd': 'string',
        'timeMaintenanceWindowStart': 'string',
        'totalCpuCoreCount': 123,
        'vnic2Id': 'string',
        'vnicId': 'string',
        'privateIpAddress': 'string',
        'floatingIpAddress': 'string'
    }
}

Response Structure

  • (dict) –

    • dbNode (dict) –

      Information about a DB node.

      • dbNodeId (string) –

        The unique identifier of the DB node.

      • dbNodeArn (string) –

        The Amazon Resource Name (ARN) of the DB node.

      • status (string) –

        The current status of the DB node.

      • statusReason (string) –

        Additional information about the status of the DB node.

      • additionalDetails (string) –

        Additional information about the planned maintenance.

      • backupIpId (string) –

        The Oracle Cloud ID (OCID) of the backup IP address that’s associated with the DB node.

      • backupVnic2Id (string) –

        The OCID of the second backup VNIC.

      • backupVnicId (string) –

        The OCID of the backup VNIC.

      • cpuCoreCount (integer) –

        Number of CPU cores enabled on the DB node.

      • dbNodeStorageSizeInGBs (integer) –

        The amount of local node storage, in gigabytes (GBs), that’s allocated on the DB node.

      • dbServerId (string) –

        The unique identifier of the Db server that is associated with the DB node.

      • dbSystemId (string) –

        The OCID of the DB system.

      • faultDomain (string) –

        The name of the fault domain the instance is contained in.

      • hostIpId (string) –

        The OCID of the host IP address that’s associated with the DB node.

      • hostname (string) –

        The host name for the DB node.

      • ocid (string) –

        The OCID of the DB node.

      • ociResourceAnchorName (string) –

        The name of the OCI resource anchor for the DB node.

      • maintenanceType (string) –

        The type of database node maintenance. Either VMDB_REBOOT_MIGRATION or EXADBXS_REBOOT_MIGRATION.

      • memorySizeInGBs (integer) –

        The allocated memory in GBs on the DB node.

      • softwareStorageSizeInGB (integer) –

        The size (in GB) of the block storage volume allocation for the DB system.

      • createdAt (datetime) –

        The date and time when the DB node was created.

      • timeMaintenanceWindowEnd (string) –

        End date and time of maintenance window.

      • timeMaintenanceWindowStart (string) –

        Start date and time of maintenance window.

      • totalCpuCoreCount (integer) –

        The total number of CPU cores reserved on the DB node.

      • vnic2Id (string) –

        The OCID of the second VNIC.

      • vnicId (string) –

        The OCID of the VNIC.

      • privateIpAddress (string) –

        The private IP address assigned to the DB node.

      • floatingIpAddress (string) –

        The floating IP address assigned to the DB node.

Exceptions