阿里云RDS文档概述——实例管理

名称	类型	是否必须	描述
Action	String	是	系统规定参数,取值：CreateDBInstance
RegionId	String	是	数据中心(长度不超过50个字符)。通过函数DescribeRegions查看可用的数据中心
Engine	String	是	数据库类型, 取值: MySQL\|SQLServer
EngineVersion	String	是	数据库版本号,取值:MySQL: 5.5/5.6;SQLServer: 2008r2
DBInstanceClass	String	是	实例规格, 取值：见实例规格附表
DBInstanceStorage	Integer	是	自定义存储空间取值：mysql为[5,1000]; sql server为[10，1000]
DBInstanceNetType	String	是	网络连接类型取值:Internet公网,Intranet私网
DBInstanceDescription	String	否	实例的描述或备注信息，不超过256个字节注：不能以http://,https开头。以中文、英文字母开头。可以包含中文、英文字符、”_”，” -”，数字字符长度2~256
SecurityIPList	String	是	允许访问该实例下所有数据库的IP名单，以逗号隔开，不可重复，最多100个；支持格式：%，0.0.0.0/0，10.23.12.24（IP），或者10.23.12.24/24（CIDR模式，无类域间路由，/24表示了地址中前缀的长度，范围[1,32]）其中，0.0.0.0/0，表示不限制，
PayType	String	是	付费类型：取值:Postpaid:按量付费 (目前只支持这种方式)
ClientToken	String	是	用于保证幂等性

返回参数:

名称	类型	描述
DBInstanceId	String	实例名
OrderId	String	订单ID
ConnectionString	String	数据库连接地址
Port	String	数据库连接端口

示例:

请求示例:

https://rds.aliyuncs.com/?Action=CreateDBInstance

&RegionId=cn-hangzhou

&Engine=MySQL

&EngineVersion=5.5

&DBInstanceClass=rds.mys2.small

&DBInstanceStorage=5

&DBInstanceNetType=Internet

&SecurityIPList=11.11.11.11

&PayType=Postpaid

&ClientToken=ETnLKlblzczshOTUbOCziJZNwHlYBQ

&<公共请求参数>

返回示例:

XML格式:

<ConnectionString>rdsaiiabnaiiabn.mysql.rds.aliyuncs.com</ConnectionString>

<DBInstanceId>rdsaiiabnaiiabn</DBInstanceId>

</CreateDBInstanceResponse>

JSON格式:

{

"OrderId":"100789370230206",

"ConnectionString":"rdsaiiabnaiiabn.mysql.rds.aliyuncs.com",

"DBInstanceId":"rdsaiiabnaiiabn",

"Port":"3306",

"RequestId":"1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC"

}

删除数据库实例:

描述:

说明：删除指定实例

接口调用要求如下，否则操作将失败：

实例状态为运行中

实例没有被人为锁定

实例类型为主实例（按量付费类型）、只读实例、灾备实例、临时实例

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：DeleteDBInstance
DBInstanceId	String	是	实例名

示例:

请求示例:

https://rds.aliyuncs.com/?Action=DeleteDBInstance

&DBInstanceId=rdsaiiabnaiiabn

&<公共请求参数>

返回示例:

XML格式:

</DeleteDBInstanceResponse>

JSON格式:

{

"RequestId":"65BDA532-28AF-4122-AA39-B382721EEE64"

}

变更配置:

描述:

说明:该接口可以对实例的两个属性进行升级配置或降低配置，分别为实例规格和存储空间，说明如下

接口调用要求如下,否则操作将失败:

实例为运行中

实例当前无正在运行的备份

实例规格和存储空间必须指定一项

降低磁盘空间配置，输入的磁盘空间不能小于实际使用空间大小的1.1倍

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：ModifyDBInstanceSpec
DBInstanceId	String	是	待升降级的实例
PayType	String	是	Postpaid，按量付费，目前只有这一种
DBInstanceClass	String	否	目标实例级别实例规格附表
DBInstanceStorage	Integer	否	自定义存储空间，取值范围：mysql为[5,1000],sqlserver为[10,1000]，按5G步进。

示例:

请求示例:

https://rds.aliyuncs.com/?Action=ModifyDBInstanceSpec

&DBInstanceId=rdsaiiabnaiiabn

&PayType=Postpaid

&DBInstanceStorage=10

&<公共请求参数>

返回示例:

XML格式:

<RequestId>3C5CFDEE-F774-4DED-89A2-1D76EC63C575</RequestId>

</ModifyDBInstanceSpecResponse>

JSON格式:

{

"RequestId":" 3C5CFDEE-F774-4DED-89A2-1D76EC63C575 "

}

查看数据库实例列表:

描述:

说明:

用户只能查看属于自己的实例列表或被RAM授权的实例列表

返回实例列表信息包括：实例状态、公网/私网、实例连接地址/端口，是否被锁，是否过期等

以供用户追加数据库、修改实例等操作。用户也可以查找指定名称、类型、状态的实例信息。

实例状态要求：无

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值: DescribeDBInstances
RegionId	String	是	实例的region通过函数DescribeRegions查看
Engine	String	否	数据库类型，取值: MySQL\|SQLServer，不填，默认返回所有
DBInstanceType	String	否	实例类型，取值:Primary:主实例Readonly：只读实例Guard：灾备实例Temp：临时实例不填，默认返回所有
PageSize	Integer	否	每页记录数，取值:30\|50\|100默认值：30
PageNumber	Integer	否	页码，大于0，且不超过Integer的最大值默认值: 1

返回参数:

名称	类型	描述
PageNumber	Integer	页码
TotalRecordCount	Integer	总记录数，需要让瑶池加
PageRecordCount	Integer	本页DBInstance个数
Items	List<DBInstance>	由DBInstance组成的数组

DBInstance的参数:

名称	类型	描述
DBInstanceId	String	实例名
DBInstanceDescription	String	实例描述
PayType	String	付费类型: Prepaid:预付费;Postpaid:按量付费
DBInstanceType	String	Primary:主实例;Readonly:只读实例;Guard:灾备实例;Temp:临时实例
RegionId	String	数据中心
ExpireTime	String	到期时间
DBInstanceStatus	String	实例状态: 参见实例状态表
Engine	String	数据库版本: MySQL\|SQLServer
DBInstanceNetType	String	实例访问类型:Internet:公网Intranet:私网
LockMode	String	实例锁定模式:Unlock:正常Manual;Lock:手动触发锁;LockByExpiration:实例过期自动锁;LockByRestoration:实例回滚前的自动锁;LockByDiskQuota:实例空间满自动锁
LockReason	String	被锁定的原因

示例:

请求示例:

https://rds.aliyuncs.com/?Action=DescribeDBInstances

&RegionId=cn-hangzhou

&Engine=MySQL

&<公共请求参数>

返回示例:

XML格式:

<Items>

<DBInstanceDescription>testforRemarks</DBInstanceDescription>

<DBInstanceId>rdsmjfirvmjfirv</DBInstanceId>

<DBInstanceNetType>Internet</DBInstanceNetType>

<PayType>Prepaid</PayType>

<DBInstanceStatus>Running</DBInstanceStatus>

<DBInstanceType>Primary</DBInstanceType>

<Engine>MySQL</Engine>

<LockMode>Unlock</LockMode>

<RegionId>cn-hangzhou</RegionId>

</DBInstance>

<DBInstanceDescription>testforcreate</DBInstanceDescription>

<DBInstanceId>rdsabqumfabqumf</DBInstanceId>

<DBInstanceNetType>Intranet</DBInstanceNetType>

<PayType>Postpaid</PayType>

<DBInstanceStatus>Running</DBInstanceStatus>

<DBInstanceType>Primary</DBInstanceType>

<Engine>MySQL</Engine>

<LockMode>Unlock</LockMode>

<RegionId>cn-hangzhou</RegionId>

</DBInstance>

</Items>

</DescribeDBInstancesResponse>

JSON格式:

{

"PageNumber":1,

"Items":{

"DBInstance":[

{

"Engine":"MySQL",

"DBInstanceType":"Primary",

"DBInstanceStatus":"Running",

"DBInstanceDescription":"testforRemarks",

"LockMode":"Unlock",

"RegionId":"cn-hangzhou",

"DBInstanceId":"rdsmjfirvmjfirv",

"PayType":"Prepaid",

"ExpireTime":"2014-10-10T16:00:00Z",

"DBInstanceNetType":"Internet",

"LockReason":""

{

"Engine":"MySQL",

"DBInstanceType":"Primary",

"DBInstanceStatus":"Running",

"DBInstanceDescription":"testforcreate",

"LockMode":"Unlock",

"RegionId":"cn-hangzhou",

"DBInstanceId":"rdsabqumfabqumf",

"PayType":"Postpaid",

"ExpireTime":"",

"DBInstanceNetType":"Intranet",

"LockReason":""

}

]

"TotalRecordCount":2,

"PageRecordCount":2,

"RequestId":"2553A660-E4EB-4AF4-A402-8AFF70A49143"

}

查看数据库实例详情:

描述:

说明:查看指定实例的详细属性

实例状态:无

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：DescribeDBInstanceAttribute
DBInstanceId	String	是	实例名，可以一次输入多个，以英文半角“,”分隔最多传入30个

返回参数:

名称	类型	描述
Items	List<DBInstanceAttribute>

DBInstanceAttribute的参数:

名称	类型	描述
DBInstanceId	String	实例名
PayType	String	付费类型:Prepaid:预付费;Postpaid:按量付费
DBInstanceType	String	实例类型:Primary:主实例;ReadOnly:只读实例;Guard:灾备实例;Temp:临时实例
RegionId	String	数据中心
ConnectionString	String	连接地址
Port	String	应用访问端口
Engine	String	数据库类型
EngineVersion	String	数据库版本
DBInstanceClass	String	实例规格
DBInstanceMemory	Long	实例内存，单位: M
DBInstanceStorage	Integer	实例存储空间，单位: GB
DBInstanceNetType	String	实例网络访问类型:Internet:公网;Intranet:私网
DBInstanceStatus	String	实例状态参见实例状态表
DBInstanceDescription	String	实例备注
LockMode	String	实例锁定模式: Unlock:正常;ManualLock:手动触发锁;LockByExpiration:实例过期自动锁;LockByRestoration:实例回滚前的自动锁;LockByDiskQuota:实例空间满自动锁
LockReason	String	被锁定的原因
DBMaxQuantity	Integer	一个实例下可创建最大数据库数量
AccountMaxQuantity	Integer	可创建帐号的最大数量
CreationTime	String	创建时间，格式: YYYY-MM-DD’T’hh:mm:ssZ，如2011-05-30T12:11:4Z
ExpireTime	String	到期时间，按量付费实例无到期时间
MaintainTime	String	实例可维护时间，如: 00:00Z-02:00Z，表示0点到2点可进行例行维护
AvailabilityValue	String	查询当年可用性实例可用性状态单位：百分比
MaxIOPS	Integer	最大IO请求次数，即IOPS
MaxConnections	Integer	最大实例并发连接数
MasterInstanceId	String	主实例的ID，如果没有返回此参数（即为null）则表示该实例是主实例
IncrementSourceDBInstanceId	String	增量数据来源的实例ID，如灾备实例的增量数据来源是主实例。只读实例的增量数据来源是主实例，主实例的增量数据涟源是NULL.
GuardDBInstanceId	String	该实例如果挂载着灾备实例。备实例的ID
TempDBInstanceId	String	该实例如果挂载着灾备实例。临时实例ID
ReadOnlyDBInstanceIds	List<ReadOnlyDBInstanceId>	该实例如果挂载着灾备实例。只读实例ID的列表
SecurityIPList	String	允许访问该实例下所有数据库的IP名单，以逗号隔开，不可重复，最多100个；支持格式：0.0.0.0/0，10.23.12.24（IP），或者10.23.12.24/24（CIDR模式，无类域间路由，/24表示了地址中前缀的长度，范围[1,32]）

ReadOnlyDBInstanceId:

名称	类型	描述
DBInstanceId	String	只读实例ID

示例:

请求示例:

https://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute

&DBInstanceId=rdsaiiabnaiiabn

&<公共请求参数>

返回示例:

XML格式:

<RequestId>3C5CFDEE-F774-4DED-89A2-1D76EC63C575</RequestId>

<Items>

<LockMode>Unlock</LockMode>

<ConnectionString>rdsfnjfqu7vjnuj.mysql.rds.aliyuncs.com</ConnectionString>

<DBInstanceNetType>Internet</DBInstanceNetType>

<Engine>MySQL</Engine>

<RegionId>cn-hangzhou</RegionId>

</ReadOnlyDBInstanceIds>

<DBInstanceType>Primary</DBInstanceType>

<DBInstanceStatus>Running</DBInstanceStatus>

<DBInstanceId>rdsfnjfqu7vjnuj</DBInstanceId>

<PayType>Postpaid</PayType>

<DBInstanceClass>rds.mys2.small</DBInstanceClass>

</DBInstanceAttribute>

</CreateDBInstanceResponse>

JSON格式:

{

"Items":{

"DBInstanceAttribute":[

{

"LockMode":"Unlock",

"ConnectionString":"rdsfnjfqu7vjnuj.mysql.rds.aliyuncs.com",

"CreationTime":"2014-10-10T10:28:48Z",

"DBInstanceNetType":"Internet",

"ReadOnlyDBInstanceIds":{

"ReadOnlyDBInstanceId":[]

"MaxConnections":60,

"LockReason":"",

"Engine":"MySQL",

"AvailabilityValue":"100.0%",

"AccountMaxQuantity":50,

"DBMaxQuantity":200,

"RegionId":"cn-hangzhou",

"TempDBInstanceId":"",

"DBInstanceMemory":240,

"MaxIOPS":150,

"DBInstanceType":"Primary",

"DBInstanceStatus":"Running",

"MasterInstanceId":"",

"EngineVersion":"5.5",

"IncrementSourceDBInstanceId":"",

"GuardDBInstanceId":"",

"DBInstanceStorage":10,

"DBInstanceDescription":"",

"DBInstanceId":"rdsfnjfqu7vjnuj",

"PayType":"Postpaid",

"ExpireTime":"",

"MaintainTime":"",

"DBInstanceClass":"rds.mys2.small",

"SecurityIPList":"11.11.11.11",

"Port":"3306"

}

]

"RequestId":"27BB49FA-DA47-4162-B39D-FC001E35C1C1"

}

切换实例内外网类型:

描述:

用户在必要的时候，可以进行内外网切换，即原来是内网，则会切换到外网，反之亦然。

切换后连接地址会发生变化，需要用户修改代码中的连接地址并重启应用。

实例状态要求:

必须满足以下条件，否则将修改失败:

实例当前状态:使用中

实例一天切换次数低于20次，按24小时为一天计算

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：SwitchDBInstanceNetType
DBInstanceId	String	是	实例名
ConnectionStringPrefix	String	是	新的用户连接，用户连接DB的地（前辍），需惟一性检查由小写字母数字，中划线组成，字母开头，长度不超过30个字符
Port	Integer	否	端口号参数大小范围：3001~3999

示例:

请求示例:

https://rds.aliyuncs.com/?Action=SwitchDBInstanceNetType

&DBInstanceId=rdsaiiabnaiiabn

&ConnectionStringPrefix=test11wangyicheng

&<公共请求参数>

返回示例:

XML格式:

</SwitchDBInstanceNetTypeResponse>

JSON格式：

{

"RequestId":" 087E2E17-36BB-49EA-BA6D-674164553D2C "

}

重启数据库实例:

描述:

说明：根据用户的需求可以重启指定的实例，重启一般在10S钟内完成，如果当时有大量的事务需要提交或回滚，可能会延长1分钟左右。

操作必须满足以下条件，否则操作将失败

实例使用中

实例无正在运行的系统自动备份

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：RestartDBInstance
DBInstanceId	String	是	实例名

示例:

请求示例:

https://rds.aliyuncs.com/?Action=RestartDBInstance

&DBInstanceId=rdsaiiabnaiiabn

&<公共请求参数>

返回示例:

XML格式:

</SwitchDBInstanceNetTypeResponse>

JSON格式:

{

"RequestId":" 65BDA532-28AF-4122-AA39-B382721EEE64"

}

查询可用的物理位置:

描述:

查看该用户可以使用的物理位置，调用创建实例接口之前查看该函数查询用户可以使用的RegionId

请求参数:

名称	类型	是否必须	描述
Action	String	是	操作接口名，系统规定参数。取值：DescribeRegions

返回参数:

名称	类型	描述
Regions	List<RDSRegion>	数组格式，返回Region列表，详情见下表。

RDSRegion:

名称	类型	描述
RegionId	String	RegionId

示例:

请求示例:

https://rds.aliyuncs.com/?Action=DescribeRegions

&<公共请求参数>

返回示例:

XML格式:

<RegionId>cn-hangzhou</RegionId>

</RDSRegion>

<RegionId>cn-qingdao</RegionId>

</RDSRegion>

<RegionId>cn-beijing</RegionId>

</RDSRegion>

<RegionId>cn-hongkong</RegionId>

</RDSRegion>

<RegionId>cn-shenzhen</RegionId>

</RDSRegion>

</Regions>

</DescribeRegionsResponse>

JSON格式:

{

"Regions":{

"RDSRegion":[

{"RegionId":"cn-hangzhou"},

{"RegionId":"cn-qingdao"},

{"RegionId":"cn-beijing"},

{"RegionId":"cn-hongkong"},

{"RegionId":"cn-shenzhen"}

]

"RequestId":"A36D9720-7902-42A4-B8B9-014A2135E6C3"

}

修改实例备注:

描述:

修改实例的备注名，用于方便用户记录该实例，比如为该实例修改备注名为“阿里云测试环境实例”

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：ModifyDBInstanceDescription
DBInstanceId	String	是	实例名
DBInstanceDescription	Sting	是	实例描述信息注：不能以http://,https开头。以中文、英文字母开头。可以包含中文、英文字符、”_”，” -”，数字字符长度2~256

示例:

请求示例:

https://rds.aliyuncs.com/?Action=ModifyDBInstanceDescription

&DBInstanceId=rdsaiiabnaiiabn

&DBInstanceDescription=testwangyichengdescribe

&<公共请求参数>

返回示例:

XML格式:

</ModifyDBInstanceDescriptionResponse>

JSON格式:

{

RequestId":" 17F57FEE-EA4F-4337-8D2E-9C23CAA63D74"

}

修改实例访问白名单:

描述:

说明:修改允许访问实例的IP名单

接口调用必须满足以下条件，否则将失败:

实例运行中

实例没有被锁定

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：ModifySecurityIps
DBInstanceId	String	是	实例名
SecurityIps	String	是	允许访问该实例下所有数据库的IP名单，以逗号隔开，不可重复，最多100个；支持格式：0.0.0.0/0，10.23.12.24（IP），或者10.23.12.24/24（CIDR模式，无类域间路由，/24表示了地址中前缀的长度，范围[1,32]）其中， 0.0.0.0/0，表示不限制，用户输入%，提示非法字符。

示例:

请求示例:

https://rds.aliyuncs.com/?Action=ModifySecurityIps

&DBInstanceId=rdsaiiabnaiiabn

&SecurityIps=192.168.1.2

&<公共请求参数>

返回示例:

XML格式:

</ModifySecurityIpsResponse>

JSON格式:

{

"RequestId":"65BDA532-28AF-4122-AA39-B382721EEE64"

}

修改实例可维护时间:

描述:

修改实例可例行维护的时间，您可以设置一个业务的一个低峰的时间段。

阿里云如果进行例行维护时间，会在您设置的可维护时间段内进行，对您的业务影响降到最低。

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：ModifyDBInstanceMaintainTime
DBInstanceId	String	是	实例名
MaintainTime	String	是	实例的维护时间，取值范围如下： 22:00Z-02:00Z:22点至凌晨2点 02:00Z-06:00Z:凌晨2点至6点 06:00-10:00: 6点至10点 10:00Z-14:00Z: 10点至14点 14:00Z-18:00Z: 14点至18点 18:00Z-22:00Z: 18点至22点

示例:

请求示例:

https://rds.aliyuncs.com/?Action=ModifyDBInstanceMaintainTime

&DBInstanceId=rdsaiiabnaiiabn

&MaintainTime=22:00Z-02:00Z

&<公共请求参数>

返回示例:

XML格式:

</ModifyDBInstanceMaintainTimeResponse>

JSON格式:

{

"RequestId":"65BDA532-28AF-4122-AA39-B382721EEE64"

}

数据库版本升级:

描述:

针对实例进行数据库版本升级，如将数据库版本MySQL5.1升级至MySQL5.5版本。

如果主实例下挂载着只读实例或者灾备实例，请先升级只读实例或者灾备实例的数据库版本。

操作必须满足以下条件，否则操作将失败:

实例为运行中

输入的数据库版本号必须大于当前实例的版本号

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：UpgradeDBInstanceEngineVersion
DBInstanceId	String	是	待升降级的实例
EngineVersion	String	是	待升级到的数据库版本

返回参数:

名称	类型	描述
TaskId	Integer	任务id

示例:

请求示例:

https://rds.aliyuncs.com/?Action=UpgradeDBInstanceEngineVersion

&DBInstanceId=rdsaiiabnaiiabn

&EngineVersion=5.6

&<公共请求参数>

返回示例:

XML格式:

</UpgradeDBInstanceEngineVersionResponse>

JSON格式:

{

"RequestId":"65BDA532-28AF-4122-AA39-B382721EEE64"

"TaskId": "124378"

}

清除事物日志:

描述:

对于MySQL类型的实例，将清空实例的所有BINLOG日志。

对于SQLServer实例，产生一个临时备份。临时备份完成后，将收缩RDS磁盘空间。

请求参数:

名称	类型	是否必须	描述
Action	String	是	系统规定参数，取值：PurgeDBInstanceLog
DBInstanceId	String	是	待收缩磁盘空间的实例

示例:

请求示例:

https://rds.aliyuncs.com/?Action=PurgeDBInstanceLog

&DBInstanceId=rdsaiiabnaiiabn

&<公共请求参数>

返回示例:

XML格式:

</PurgeDBInstanceLogResponse>

JSON格式:

{

"RequestId":"65BDA532-28AF-4122-AA39-B382721EEE64"

}

秒客网

阿里云RDS文档概述——实例管理

相关文章