odb / Paginator / ListDbNodes

ListDbNodes¶

class odb.Paginator.ListDbNodes¶

paginator = client.get_paginator('list_db_nodes')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from odb.Client.list_db_nodes().

Request Syntax

response_iterator = paginator.paginate(
    cloudVmClusterId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

cloudVmClusterId (string) –
[REQUIRED]

The unique identifier of the VM cluster.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- 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.
- NextToken (string) –
  
  A token to resume pagination.