DescribeDBInstances - Amazon Relational Database Service

Description

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

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name Description Required

Name	Description	Required
`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	No
`Marker`	An optional marker provided in the 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	No
`MaxRecords`	The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer	No

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

No

Marker

An optional marker provided in the 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

No

MaxRecords

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

Default: 100

Constraints: minimum 20, maximum 100

Type: Integer

No

Response Elements

The following elements come wrapped in a DescribeDBInstancesResult structure.

Name Description

Name	Description
`DBInstances`	A list of DBInstance instances. Type: DBInstance list
`Marker`	The marker obtained from a previous operation response. Type: String

DBInstances

A list of DBInstance instances.

Type: DBInstance list

Marker

The marker obtained from a previous operation response.

Type: String

Errors

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

Error	Description	HTTP Status Code
`DBInstanceNotFound`	DBInstanceIdentifier does not refer to an existing DB Instance.	404

Examples

Sample Request

https://rds.amazonaws.com/
   ?Action=DescribeDBInstances
   &Version=2012-04-23
   &MaxRecords=100
   &SignatureVersion=2
   &SignatureMethod=HmacSHA256
   &Timestamp=2011-05-23T06%3A54%3A55.116Z
   &AWSAccessKeyId=< Your AWS Access ID Key >
   &Signature= < Your Signature >

Sample Response

<DescribeDBInstancesResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <DescribeDBInstancesResult>
    <DBInstances>     
      <DBInstance>
        <ReadReplicaDBInstanceIdentifiers/>
        <LatestRestorableTime>2011-05-23T06:50:00Z</LatestRestorableTime>
        <Engine>mysql</Engine>
        <PendingModifiedValues/>
        <BackupRetentionPeriod>1</BackupRetentionPeriod>
        <MultiAZ>false</MultiAZ>
        <LicenseModel>general-public-license</LicenseModel>
        <DBInstanceStatus>available</DBInstanceStatus>
        <EngineVersion>5.1.50</EngineVersion>
        <Endpoint>
          <Port>3306</Port>
          <Address>simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com</Address>
        </Endpoint>
        <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>
        <DBParameterGroups>
          <DBParameterGroup>
            <ParameterApplyStatus>in-sync</ParameterApplyStatus>
            <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>
          </DBParameterGroup>
        </DBParameterGroups>
        <DBSecurityGroups>
          <DBSecurityGroup>
            <Status>active</Status>
            <DBSecurityGroupName>default</DBSecurityGroupName>
          </DBSecurityGroup>
        </DBSecurityGroups>
        <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>
        <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
        <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>
        <AvailabilityZone>us-east-1a</AvailabilityZone>
        <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>
        <AllocatedStorage>10</AllocatedStorage>
        <DBInstanceClass>db.m1.large</DBInstanceClass>
        <MasterUsername>master</MasterUsername>
      </DBInstance>
  </DescribeDBInstancesResult>
  <ResponseMetadata>
    <RequestId>9135fff3-8509-11e0-bd9b-a7b1ece36d51</RequestId>
  </ResponseMetadata>
</DescribeDBInstancesResponse>