:doc:`odb <../../odb>` / Client / list_db_nodes

*************
list_db_nodes
*************



.. py:method:: odb.Client.list_db_nodes(**kwargs)

  

  Returns information about the DB nodes for the specified VM cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/odb-2024-08-20/ListDbNodes>`_  


  **Request Syntax**
  ::

    response = client.list_db_nodes(
        maxResults=123,
        nextToken='string',
        cloudVmClusterId='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    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``

    

  
  :type nextToken: string
  :param nextToken: 

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

    

  
  :type cloudVmClusterId: string
  :param cloudVmClusterId: **[REQUIRED]** 

    The unique identifier of the VM cluster.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'nextToken': 'string',
          'dbNodes': [
              {
                  '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'
              },
          ]
      }
      
    **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.

        
      

      - **dbNodes** *(list) --* 

        The list of DB nodes along with their properties.

        
        

        - *(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 virtual network interface card (VNIC) for the DB node.

            
          

          - **backupVnicId** *(string) --* 

            The OCID of the backup VNIC for the DB node.

            
          

          - **cpuCoreCount** *(integer) --* 

            The number of CPU cores enabled on the DB node.

            
          

          - **dbNodeStorageSizeInGBs** *(integer) --* 

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

            
          

          - **dbServerId** *(string) --* 

            The unique identifier of the database server that's associated with the DB node.

            
          

          - **dbSystemId** *(string) --* 

            The OCID of the DB system.

            
          

          - **faultDomain** *(string) --* 

            The name of the fault domain where the DB node is located.

            
          

          - **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 maintenance the DB node.

            
          

          - **memorySizeInGBs** *(integer) --* 

            The amount of memory, in gigabytes (GB), that allocated on the DB node.

            
          

          - **softwareStorageSizeInGB** *(integer) --* 

            The size of the block storage volume, in gigabytes (GB), that's allocated for the DB system. This attribute applies only for virtual machine DB systems.

            
          

          - **createdAt** *(datetime) --* 

            The date and time when the DB node was created.

            
          

          - **timeMaintenanceWindowEnd** *(string) --* 

            The end date and time of the maintenance window.

            
          

          - **timeMaintenanceWindowStart** *(string) --* 

            The start date and time of the 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.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`odb.Client.exceptions.ThrottlingException`

  
  *   :py:class:`odb.Client.exceptions.ValidationException`

  
  *   :py:class:`odb.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`odb.Client.exceptions.InternalServerException`

  
  *   :py:class:`odb.Client.exceptions.ResourceNotFoundException`

  