rdb / Client / describe_db_snapshots

describe_db_snapshots

rdb.Client.describe_db_snapshots(**kwargs)

DBスナップショットの情報を取得します。

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

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_db_snapshots(
    DBInstanceIdentifier='string',
    DBSnapshotIdentifier='string',
    Filter='string',
    FilterName='string',
    FilterValue='string',
    Filters=[
        'string',
    ],
    Marker='string',
    MaxRecords=123,
    SnapshotType='automated'|'manual'
)
Parameters:
  • DBInstanceIdentifier (string) –

  • DBSnapshotIdentifier (string) –

  • Filter (string) –

  • FilterName (string) –

  • FilterValue (string) –

  • Filters (list) –

    • (string) –

  • Marker (string) –

  • MaxRecords (integer) –

  • SnapshotType (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBSnapshots': [
        {
            'AllocatedStorage': 123,
            'AvailabilityZone': 'string',
            'DBInstanceIdentifier': 'string',
            'DBSnapshotIdentifier': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'InstanceCreateTime': datetime(2015, 1, 1),
            'LicenseModel': 'string',
            'MasterUsername': 'string',
            'OptionGroupName': 'string',
            'Port': 123,
            'SnapshotCreateTime': datetime(2015, 1, 1),
            'SnapshotType': 'string',
            'Status': 'string'
        },
    ],
    'Marker': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –

    • DBSnapshots (list) –

      • (dict) –

        • AllocatedStorage (integer) –

        • AvailabilityZone (string) –

        • DBInstanceIdentifier (string) –

        • DBSnapshotIdentifier (string) –

        • Engine (string) –

        • EngineVersion (string) –

        • InstanceCreateTime (datetime) –

        • LicenseModel (string) –

        • MasterUsername (string) –

        • OptionGroupName (string) –

        • Port (integer) –

        • SnapshotCreateTime (datetime) –

        • SnapshotType (string) –

        • Status (string) –

    • Marker (string) –

    • ResponseMetadata (dict) –

      • RequestId (string) –