Amazon Relational Database Service API Reference API Version 2011-04-01 pot

Default:true Type: Boolean AutoMinorVersionUpgrade NoThe EC2 Availability Zone that the database instance will be created in.. Type: String AvailabilityZone Amazon Relational Database Se

Trang 1

Amazon Relational Database

ServiceAPI Reference API Version 2011-04-01

Trang 2

Amazon Relational Database Service: API Reference

Amazon Relational Database Service API Reference

Trang 3

Table of Contents

Welcome 1

Actions 2

AuthorizeDBSecurityGroupIngress 4

CreateDBInstance 7

CreateDBInstanceReadReplica 17

CreateDBParameterGroup 23

CreateDBSecurityGroup 26

CreateDBSnapshot 28

DeleteDBInstance 31

DeleteDBParameterGroup 36

DeleteDBSecurityGroup 38

DeleteDBSnapshot 40

DescribeDBEngineVersions 43

DescribeDBInstances 47

DescribeDBParameterGroups 50

DescribeDBParameters 52

DescribeDBSecurityGroups 55

DescribeDBSnapshots 58

DescribeEngineDefaultParameters 61

DescribeEvents 64

DescribeOrderableDBInstanceOptions 68

DescribeReservedDBInstances 72

DescribeReservedDBInstancesOfferings 75

ModifyDBInstance 78

ModifyDBParameterGroup 87

PurchaseReservedDBInstancesOffering 89

RebootDBInstance 92

ResetDBParameterGroup 96

RestoreDBInstanceFromDBSnapshot 98

RestoreDBInstanceToPointInTime 104

RevokeDBSecurityGroupIngress 111

Data Types 114

AvailabilityZone 115

DBEngineVersion 115

DBInstance 116

DBParameterGroup 118

DBParameterGroupStatus 119

DBSecurityGroup 119

DBSecurityGroupMembership 120

DBSnapshot 120

DescribeDBEngineVersionsResult 121

DescribeDBInstancesResult 122

DescribeDBParameterGroupsResult 122

DescribeDBParametersResult 123

DescribeDBSecurityGroupsResult 123

DescribeDBSnapshotsResult 123

DescribeEventsResult 124

DescribeOrderableDBInstanceOptionsResult 124

DescribeReservedDBInstancesOfferingsResult 124

DescribeReservedDBInstancesResult 125

EC2SecurityGroup 125

Endpoint 126

EngineDefaults 126

Event 127

IPRange 127

Trang 4

ModifyDBParameterGroupResult 127

OrderableDBInstanceOption 128

Parameter 128

PendingModifiedValues 129

ReservedDBInstance 130

ReservedDBInstancesOffering 131

ResetDBParameterGroupResult 132

Common Query Parameters 133

Common Errors 135

Trang 5

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up,operate, and scale a relational database in the cloud It provides cost-efficient, resizable capacity for anindustry-standard relational database and manages common database administration tasks, freeing updevelopers to focus on what makes their applications and businesses unique

Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server Thismeans the code, applications, and tools you already use today with your existing MySQL or Oracledatabases work with Amazon RDS without modification Amazon RDS automatically backs up yourdatabase and maintains the database software that powers your DB Instance Amazon RDS is flexible:you can scale your database instance's compute resources and storage capacity to meet your application'sdemand As with all Amazon Web Services, there are no up-front investments, and you pay only for theresources you use

This is the Amazon RDS API Reference It contains a comprehensive description of all Amazon RDS

Query APIs and data types To get started with Amazon RDS, go to the Amazon RDS Getting StartedGuide For more information on Amazon RDS concepts and usage scenarios, go to the Amazon RDSUser Guide

This document was last updated on October 7, 2011

Trang 8

Description

Enables ingress to a DBSecurityGroup using one of two forms of authorization First, EC2 Security Groupscan be added to the DBSecurityGroup if the application using the database is running on EC2 instances.Second, IP ranges are available if the application accessing your database is running on the Internet.Required parameters for this API are one of CIDR range or (EC2SecurityGroupName AND

Name

NoThe IP range to authorize

Type: String

CIDRIP

YesThe name of the DB Security Group to add

authorization to

Type: String

DBSecurityGroupName

NoName of the EC2 Security Group to authorize

Type: String

EC2SecurityGroupName

NoAWS Account Number of the owner of the EC2 SecurityGroup specified in the EC2SecurityGroupNameparameter The AWS Access Key ID is not anacceptable value

Provides the description of the DB Security Group

Trang 9

Description Name

Contains a list of IPRange (p 127) elements

Type:IPRange (p 127) list

Description Error

400The specified CIDRIP or EC2 security group is alreadyauthorized for the specified DB security group

AuthorizationAlreadyExists

400Database security group authorization quota has beenreached

Trang 10

</AuthorizeDBSecurityGroupIngressResult>

</AuthorizeDBSecurityGroupIngressResponse>

Examples

Trang 11

YesThe amount of storage (in gigabytes) to be initiallyallocated for the database instance

Default:true

Type: Boolean

AutoMinorVersionUpgrade

NoThe EC2 Availability Zone that the database

instance will be created in

Default: A random, system-chosen Availability Zone

in the endpoint's region

Example:us-east-1d

Constraint: The AvailabilityZone parameter cannot

be specified if the MultiAZ parameter is set to true.The specified Availability Zone must be in the sameregion as the current endpoint

Type: String

AvailabilityZone

CreateDBInstance

Trang 12

Required Description

Name

NoThe number of days for which automated backupsare retained Setting this parameter to a positivenumber enables backups Setting this parameter

to 0 disables automated backups

Default: 1Constraints:

• Must be a value from 0 to 8

• Cannot be set to 0 if the DB Instance is a masterinstance with read replicas

Type: Integer

BackupRetentionPeriod

YesThe compute and memory capacity of the DB

as a lowercase string

Constraints:

• Must contain from 1 to 63 alphanumericcharacters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain twoconsecutive hyphens

Trang 13

Name

NoThe meaning of this parameter differs according tothe database engine you use

MySQL

The name of the database to create when the DBInstance is created If this parameter is notspecified, no database is created in the DBInstance

Constraints:

• Must contain 1 to 64 alphanumeric characters

• Cannot be a word reserved by the specifieddatabase engine

Constraints:

• Must be 1 to 255 alphanumeric characters

Trang 14

Name

YesThe name of the database engine to be used forthis instance

Valid Values:MySQL | oracle-se1 | oracle-se

| oracle-ee

Type: String

Engine

NoThe version number of the database engine to use

Valid values:license-included |

Trang 15

Name

YesThe name of master user for the client DB Instance

MySQL

Constraints:

• Cannot be a reserved word for the chosendatabase engine

Type: String

Oracle

Constraints:

• Cannot be a reserved word for the chosendatabase engine

Type: String

MasterUsername

NoSpecifies if the DB Instance is a Multi-AZ

deployment You cannot set the AvailabilityZoneparameter if the MultiAZ parameter is set to true

Type: Boolean

MultiAZ

NoThe port number on which the database acceptsconnections

Trang 16

Name

NoThe daily time range during which automated

backups are created if automated backups areenabled, using the BackupRetentionPeriod

parameter

Default: A 30-minute window selected at randomfrom an 8-hour block of time per region Thefollowing list shows the time blocks for each regionfrom which the default backup windows areassigned

• US-East (Northern Virginia) Region:

03:00-11:00 UTC

• US-West (Northern California) Region:

06:00-14:00 UTC

• EU (Ireland) Region: 22:00-06:00 UTC

• Asia Pacific (Singapore) Region: 14:00-22:00

UTC

• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Constraints: Must be in the format

hh24:mi-hh24:mi Times should be UniversalTime Coordinated (UTC) Must not conflict with thepreferred maintenance window Must be at least

30 minutes

Type: String

PreferredBackupWindow

NoThe weekly time range (in UTC) during which

system maintenance can occur

• US-East (Northern Virginia) Region:

03:00-11:00 UTC

• US-West (Northern California) Region:

06:00-14:00 UTC

• EU (Ireland) Region: 22:00-06:00 UTC

• Asia Pacific (Singapore) Region: 14:00-22:00

UTC

• Asia Pacific (Tokyo) Region: 17:00-03:00 UTC

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, SunConstraints: Minimum 30-minute window

Type: String

PreferredMaintenanceWindow

Request Parameters

Trang 17

Response Elements

The following elements come wrapped in a DBInstance structure

Specifies the allocated storage size specified ingigabytes

Specifies the name of the Availability Zone the

DB Instance is located in

The meaning of this parameter differs according

to the database engine you use

MySQL

Contains the name of the initial database of thisinstance that was provided at create time, if onewas specified when the DB Instance wascreated This same name is returned for the life

Trang 18

Provides List of DB Security Group elementscontaining only DBSecurityGroup.Name and

DBSecurityGroup.Status subelements.Type:DBSecurityGroupMembership (p 120) list

DBSecurityGroups

Specifies the connection endpoint

Type:Endpoint (p 126)

Endpoint

Provides the name of the database engine to

be used for this DB Instance

Type:PendingModifiedValues (p 129)

PendingModifiedValues

Specifies the daily time range during whichautomated backups are created if automatedbackups are enabled, as determined by the

BackupRetentionPeriod.Type: String

ReadReplicaDBInstanceIdentifiers

Response Elements

Trang 19

Contains the identifier of the source DB Instance

if this DB Instance is a Read Replica

400User already has a DB Instance with the givenidentifier

DBInstanceAlreadyExists

404

DBParameterGroupName does not refer to an

existing DB Parameter Group

DBParameterGroupNotFound

404

DBSecurityGroupName does not refer to an

existing DB Security Group

DBSecurityGroupNotFound

400Request would result in user exceeding the

allowed number of DB Instances

InstanceQuotaExceeded

400Specified DB Instance class is not available in thespecified Availability Zone

InsufficientDBInstanceCapacity

allowed amount of storage available across all DBInstances

Trang 20

Sample Response

Trang 21

Description

Creates a DB Instance that acts as a Read Replica of a source DB Instance

All Read Replica DB Instances are created as Single-AZ deployments with backups disabled All other

DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from thesource DB Instance, except as specified below

Name

NoIndicates that minor engine upgrades will be appliedautomatically to the Read Replica during themaintenance window

Default: Inherits from the source DB InstanceType: Boolean

AutoMinorVersionUpgrade

NoThe Amazon EC2 Availability Zone that the ReadReplica will be created in

Default: A random, system-chosen Availability Zone

in the endpoint's region

Example:us-east-1d

Type: String

AvailabilityZone

NoThe compute and memory capacity of the ReadReplica

Valid Values:db.m1.small | db.m1.large |db.m1.xlarge | db.m2.xlarge

This is the unique key that identifies a DB Instance

This parameter is stored as a lowercase string

Type: String

DBInstanceIdentifier

CreateDBInstanceReadReplica

Trang 22

Name

NoThe port number that the DB Instance uses forconnections

Default: Inherits from the source DB InstanceValid Values:1150-65535

Type: Integer

Port

YesThe identifier of the DB Instance that will act as thesource for the Read Replica Each DB Instancecan have up to five Read Replicas

Constraints: Must be the identifier of an existing

DB Instance that is not already a Read Replica DBInstance

Trang 23

MySQL

DBSecurityGroups

Endpoint

Trang 24

Specifies that changes to the DB Instance arepending This element is only included whenchanges are pending Specific changes areidentified by subelements

400User already has a DB Instance with the givenidentifier

404

DBSecurityGroupName does not refer to an

existing DB Security Group

DBSecurityGroupNotFound

allowed number of DB Instances

InstanceQuotaExceeded

400Specified DB Instance class is not available in thespecified Availability Zone

allowed amount of storage available across all DBInstances

StorageQuotaExceeded

Errors

Trang 25

</DBParameterGroups>

<ReadReplicaSourceDBInstanceIdentifier>mydbinstance</ReadReplicaSourceDBInstanceIdentifier> <DBSecurityGroups>

<Status>active</Status>

<DBSecurityGroupName>default</DBSecurityGroupName> </DBSecurityGroup>

</DBSecurityGroups>

<PreferredBackupWindow>03:30-04:00</PreferredBackupWindow> <DBName>mydatabase</DBName>

Trang 26

</CreateDBInstanceReadReplicaResult>

</CreateDBInstanceReadReplicaResponse>

Examples

Trang 27

Description

Creates a new DB Parameter Group

A DB Parameter Group is initially created with the default parameters for the database engine used bythe DB Instance To provide custom values for any of the parameters, you must modify the group after

creating it using ModifyDBParameterGroup Once you've created a DB Parameter Group, you need to associate it with your DB Instance using ModifyDBInstance When you associate a new DB Parameter

Group with a running DB Instance, you need to reboot the DB Instance for the new DB Parameter Groupand associated settings to take effect

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters (p 133)

Name

YesThe DB Parameter Group Family name A DB ParameterGroup can be associated with one and only one DBParameter Group Family, and can be applied only to a

DB Instance running a database engine and engineversion compatible with that DB Parameter Group Family

Type: String

DBParameterGroupFamily

YesThe name of the DB Parameter Group

Constraints:

• Cannot end with a hyphen or contain two consecutivehyphens

Provides the name of the DB Parameter Group Family that this DBParameter Group is compatible with

Type: String

DBParameterGroupFamily

CreateDBParameterGroup

Trang 28

Provides the name of the DB Parameter Group

400

A DB Parameter Group with the same name exists

DBParameterGroupAlreadyExists

400Request would result in user exceeding the allowednumber of DB Parameter Groups

Trang 29

</ResponseMetadata>

</CreateDBParameterGroupResponse>

Examples

Trang 30

YesThe description for the DB Security Group

Type: String

DBSecurityGroupDescription

YesThe name for the DB Security Group This value

is stored as a lowercase string

Constraints: Must contain no more than 255alphanumeric characters or hyphens Must not be

Provides the description of the DB Security Group

Contains a list of IPRange (p 127) elements

Type:IPRange (p 127) list

For information about the common errors that all actions use, see Common Errors (p 135)

CreateDBSecurityGroup

Trang 31

HTTP Status Code

400

A database security group with the name specified

in DBSecurityGroupName already exists.

DBSecurityGroupAlreadyExists

400Request would result in user exceeding the allowednumber of DB Security Groups

Trang 32

YesThe DB Instance identifier This is the unique key that

identifies a DB Instance This parameter isn't case sensitive

Constraints:

• Must contain from 1 to 63 alphanumeric characters orhyphens

Type: String

YesThe identifier for the DB Snapshot

Constraints:

• Cannot be null, empty, or blank

• Must contain from 1 to 255 alphanumeric characters orhyphens

Specifies the allocated storage size in gigabytes (GB)

Type: Integer

AllocatedStorage

Specifies the name of the Availability Zone the DB Instance was located

in at the time of the DB Snapshot

Type: String

AvailabilityZone

CreateDBSnapshot

Trang 33

Specifies the the DBInstanceIdentifier of the DB Instance this DBSnapshot was created from

of DB Snapshots

SnapshotQuotaExceeded

Errors

Trang 35

YesThe DB Instance identifier for the DB Instance to bedeleted This parameter isn't case sensitive

Constraints:

• Must contain from 1 to 63 alphanumeric characters

or hyphens

Type: String

NoThe DBSnapshotIdentifier of the new DBSnapshotcreated when SkipFinalSnapshot is set to false

Note

Specifying this parameter and also settingthe SkipFinalShapshot parameter to trueresults in an error

Constraints:

Type: String

FinalDBSnapshotIdentifier

DeleteDBInstance

Trang 36

Name

NoDetermines whether a final DB Snapshot is createdbefore the DB Instance is deleted If true isspecified, no DBSnapshot is created If false isspecified, a DB Snapshot is created before the DBInstance is deleted

Trang 37

MySQL

DBSecurityGroups

Endpoint

Trang 38

Specifies that changes to the DB Instance arepending This element is only included whenchanges are pending Specific changes areidentified by subelements

Trang 39

<LatestRestorableTime>2011-05-23T07:15:00Z</LatestRestorableTime> <Engine>mysql</Engine>

<DBParameterGroupName>default.mysql5.1</DBParameterGroupName> </DBParameterGroup>

Trang 40

YesThe name of the DB Parameter Group

Constraints:

• Must be the name of an existing DB Parameter Group

• You cannot delete a default DB Parameter Group

• Cannot be associated with any DB Instances

404

400The DB Parameter Group cannot be deleted because

Tiêu đề	Amazon Relational Database Service API Reference
Chuyên ngành	Amazon Web Services
Thể loại	API reference
Năm xuất bản	2011

Định dạng
Số trang	140
Dung lượng	624,21 KB