rdb / Client / describe_db_instances

describe_db_instances

rdb.Client.describe_db_instances(**kwargs)

DBサーバーの情報を取得します。

このAPIアクションはページネートをサポートしています。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_instances(
    DBInstanceIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123
)

Parameters:

• DBInstanceIdentifier (string) –

• Filter (string) –

• FilterName (string) –

• FilterValue (string) –

• Filters (list) –

  • (string) –

• Marker (string) –

• MaxRecords (integer) –

Return type:

dict

Returns:

Response Syntax

{
    'DBInstances': [
        {
            'AccountingType': 'string',
            'AllocatedStorage': 123,
            'AutoMinorVersionUpgrade': True|False,
            'AvailabilityZone': 'string',
            'BackupRetentionPeriod': 123,
            'BinlogRetentionPeriod': 123,
            'CACertificateIdentifier': 'string',
            'DBInstanceClass': 'string',
            'DBInstanceIdentifier': 'string',
            'DBInstanceStatus': 'string',
            'DBName': 'string',
            'DBParameterGroups': [
                {
                    'DBParameterGroupName': 'string',
                    'ParameterApplyStatus': 'string'
                },
            ],
            'DBSecurityGroups': [
                {
                    'DBSecurityGroupName': 'string',
                    'Status': 'string'
                },
            ],
            'Endpoint': {
                'Address': 'string',
                'NiftyPrivateAddress': 'string',
                'Port': 123
            },
            'Engine': 'string',
            'EngineVersion': 'string',
            'ExternalReplicationInfo': {
                'ExternalMasterAddress': 'string',
                'ExternalReplicationMessage': 'string',
                'ExternalReplicationStatus': 'string',
                'ReplicationAddresses': [
                    'string',
                ],
                'ReplicationPrivateAddresses': [
                    'string',
                ]
            },
            'InstanceCreateTime': datetime(2015, 1, 1),
            'LatestRestorableTime': datetime(2015, 1, 1),
            'LicenseModel': 'string',
            'MasterUsername': 'string',
            'MultiAZ': True|False,
            'NextMonthAccountingType': 'string',
            'NiftyMasterPrivateAddress': 'string',
            'NiftyMultiAZType': 'string',
            'NiftyNetworkId': 'string',
            'NiftySlavePrivateAddress': 'string',
            'NiftyStorageType': 123,
            'OptionGroupMemberships': [
                {
                    'OptionGroupName': 'string',
                    'Status': 'string'
                },
            ],
            'PendingModifiedValues': {
                'AllocatedStorage': 123,
                'BackupRetentionPeriod': 123,
                'DBInstanceClass': 'string',
                'DBInstanceIdentifier': 'string',
                'EngineVersion': 'string',
                'MasterUserPassword': 'string',
                'MultiAZ': True|False,
                'Port': 123
            },
            'PreferredBackupWindow': 'string',
            'PreferredMaintenanceWindow': 'string',
            'PubliclyAccessible': True|False,
            'ReadReplicaDBInstanceIdentifiers': [
                'string',
            ],
            'ReadReplicaSourceDBInstanceIdentifier': 'string',
            'SecondaryAvailabilityZone': 'string',
            'StatusInfos': [
                {
                    'Message': 'string',
                    'Normal': True|False,
                    'Status': 'string',
                    'StatusType': 'string'
                },
            ],
            'VpcSecurityGroups': 'string'
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

• (dict) –

  • DBInstances (list) –

    • (dict) –

      • AccountingType (string) –

      • AllocatedStorage (integer) –

      • AutoMinorVersionUpgrade (boolean) –

      • AvailabilityZone (string) –

      • BackupRetentionPeriod (integer) –

      • BinlogRetentionPeriod (integer) –

      • CACertificateIdentifier (string) –

      • DBInstanceClass (string) –

      • DBInstanceIdentifier (string) –

      • DBInstanceStatus (string) –

      • DBName (string) –

      • DBParameterGroups (list) –

        • (dict) –

          • DBParameterGroupName (string) –

          • ParameterApplyStatus (string) –

      • DBSecurityGroups (list) –

        • (dict) –

          • DBSecurityGroupName (string) –

          • Status (string) –

      • Endpoint (dict) –

        • Address (string) –

        • NiftyPrivateAddress (string) –

        • Port (integer) –

      • Engine (string) –

      • EngineVersion (string) –

      • ExternalReplicationInfo (dict) –

        • ExternalMasterAddress (string) –

        • ExternalReplicationMessage (string) –

        • ExternalReplicationStatus (string) –

        • ReplicationAddresses (list) –

          • (string) –

        • ReplicationPrivateAddresses (list) –

          • (string) –

      • InstanceCreateTime (datetime) –

      • LatestRestorableTime (datetime) –

      • LicenseModel (string) –

      • MasterUsername (string) –

      • MultiAZ (boolean) –

      • NextMonthAccountingType (string) –

      • NiftyMasterPrivateAddress (string) –

      • NiftyMultiAZType (string) –

      • NiftyNetworkId (string) –

      • NiftySlavePrivateAddress (string) –

      • NiftyStorageType (integer) –

      • OptionGroupMemberships (list) –

        • (dict) –

          • OptionGroupName (string) –

          • Status (string) –

      • PendingModifiedValues (dict) –

        • AllocatedStorage (integer) –

        • BackupRetentionPeriod (integer) –

        • DBInstanceClass (string) –

        • DBInstanceIdentifier (string) –

        • EngineVersion (string) –

        • MasterUserPassword (string) –

        • MultiAZ (boolean) –

        • Port (integer) –

      • PreferredBackupWindow (string) –

      • PreferredMaintenanceWindow (string) –

      • PubliclyAccessible (boolean) –

      • ReadReplicaDBInstanceIdentifiers (list) –

        • (string) –

      • ReadReplicaSourceDBInstanceIdentifier (string) –

      • SecondaryAvailabilityZone (string) –

      • StatusInfos (list) –

        • (dict) –

          • Message (string) –

          • Normal (boolean) –

          • Status (string) –

          • StatusType (string) –

      • VpcSecurityGroups (string) –

  • Marker (string) –

  • ResponseMetadata (dict) –

    • RequestId (string) –