Menu
Amazon Relational Database Service
API Reference (API Version 2014-10-31)

DescribeDBInstances

Returns information about provisioned RDS instances. This API supports pagination.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBInstanceIdentifier

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Type: String

Required: No

Filters.Filter.N

A filter that specifies one or more DB instances to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB Clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

Type: Array of Filter objects

Required: No

Marker

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

DBInstances.DBInstance.N

A list of DBInstance instances.

Type: Array of DBInstance objects

Marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DBInstanceNotFound

DBInstanceIdentifier does not refer to an existing DB instance.

HTTP Status Code: 404

Example

Sample Request

Copy
https://rds.us-west-2.amazonaws.com/ ?Action=DescribeDBInstances &MaxRecords=100 &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-09-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140420/us-west-2/rds/aws4_request &X-Amz-Date=20140420T171917Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=caa44629fa60576c2c282d9b74d47647f9e9f229f6d0e52db1d3be0d095743b0

Sample Response

Copy
<DescribeDBInstancesResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/"> <DescribeDBInstancesResult> <DBInstances> <DBInstance> <BackupRetentionPeriod>7</BackupRetentionPeriod> <MultiAZ>false</MultiAZ> <DBInstanceStatus>available</DBInstanceStatus> <VpcSecurityGroups/> <DBInstanceIdentifier>mysqlexampledb</DBInstanceIdentifier> <PreferredBackupWindow>10:07-10:37</PreferredBackupWindow> <PreferredMaintenanceWindow>sun:06:13-sun:06:43</PreferredMaintenanceWindow> <AvailabilityZone>us-west-2b</AvailabilityZone> <LatestRestorableTime>2014-04-21T17:15:00Z</LatestRestorableTime> <ReadReplicaDBInstanceIdentifiers/> <Engine>mysql</Engine> <PendingModifiedValues/> <LicenseModel>general-public-license</LicenseModel> <DBParameterGroups> <DBParameterGroup> <ParameterApplyStatus>in-sync</ParameterApplyStatus> <DBParameterGroupName>default.mysql5.6</DBParameterGroupName> </DBParameterGroup> </DBParameterGroups> <Endpoint> <Port>3306</Port> <Address>mysqlexampledb.c6c1rntzufv0.us-west-2.rds.amazonaws.com</Address> </Endpoint> <EngineVersion>5.6.13</EngineVersion> <OptionGroupMemberships> <OptionGroupMembership> <OptionGroupName>default:mysql-5-6</OptionGroupName> <Status>in-sync</Status> </OptionGroupMembership> </OptionGroupMemberships> <DBSecurityGroups> <DBSecurityGroup> <Status>active</Status> <DBSecurityGroupName>my-db-secgroup</DBSecurityGroupName> </DBSecurityGroup> </DBSecurityGroups> <PubliclyAccessible>true</PubliclyAccessible> <DBName>mysampledb</DBName> <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> <InstanceCreateTime>2014-01-29T22:58:24.231Z</InstanceCreateTime> <AllocatedStorage>5</AllocatedStorage> <MasterUsername>myawsuser</MasterUsername> <DBInstanceClass>db.t1.micro</DBInstanceClass> </DBInstance> <DBInstance> <BackupRetentionPeriod>7</BackupRetentionPeriod> <MultiAZ>false</MultiAZ> <DBInstanceStatus>available</DBInstanceStatus> <VpcSecurityGroups/> <DBInstanceIdentifier>mysqlexampledb-restore</DBInstanceIdentifier> <PreferredBackupWindow>10:07-10:37</PreferredBackupWindow> <PreferredMaintenanceWindow>sun:06:13-sun:06:43</PreferredMaintenanceWindow> <AvailabilityZone>us-west-2b</AvailabilityZone> <LatestRestorableTime>2014-04-21T17:15:00Z</LatestRestorableTime> <ReadReplicaDBInstanceIdentifiers/> <Engine>mysql</Engine> <PendingModifiedValues/> <LicenseModel>general-public-license</LicenseModel> <DBParameterGroups> <DBParameterGroup> <ParameterApplyStatus>in-sync</ParameterApplyStatus> <DBParameterGroupName>default.mysql5.6</DBParameterGroupName> </DBParameterGroup> </DBParameterGroups> <Endpoint> <Port>3306</Port> <Address>mysqlexampledb-restore.c6c2mntzugv0.us-west-2.rds.amazonaws.com</Address> </Endpoint> <EngineVersion>5.6.13</EngineVersion> <OptionGroupMemberships> <OptionGroupMembership> <OptionGroupName>default:mysql-5-6</OptionGroupName> <Status>in-sync</Status> </OptionGroupMembership> </OptionGroupMemberships> <DBSecurityGroups> <DBSecurityGroup> <Status>active</Status> <DBSecurityGroupName>default</DBSecurityGroupName> </DBSecurityGroup> </DBSecurityGroups> <PubliclyAccessible>true</PubliclyAccessible> <DBName>mysampledb</DBName> <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade> <InstanceCreateTime>2014-03-28T20:14:17.296Z</InstanceCreateTime> <AllocatedStorage>5</AllocatedStorage> <MasterUsername>myawsuser</MasterUsername> <DBInstanceClass>db.t1.micro</DBInstanceClass> </DBInstance> </DBInstances> </DescribeDBInstancesResult> <ResponseMetadata> <RequestId>01b2685a-b978-11d3-f272-7cd6cce12cc5</RequestId> </ResponseMetadata> </DescribeDBInstancesResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: