云数据库API
  

目录

Common Parameters   

CreateDBInstance   

RestoreDBInstance   

DeleteDBSnapshot

Common Parameters

这里介绍所有请求使用的公共参数, 一些请求所需的特定参数在详细介绍时会单独罗列。

Action

用户请求的动作

Default: None

Type: string

Required: Yes

AccessKey

共有密钥

Default: None

Required: Yes

Signature

各信息组合的加密签名

Default: None

Required: Yes

UserId

用户ID

Default: None

Required: Yes


CreateDBInstance

CreateDBInstance

Description

创建一个新实例

Request Parameters

AvailabilityZone 

数据库可用区域

Default: 随机选择一个可用区域

Example: china-north-east

Type: String

Required: No

BackupRetentionPeriod 

自动备份周期

Default: 1

Constraints:

取值范围在0 到8之间                                                  

Type: Integer

Required: No

DBInstanceClass

创建实例的虚机类型

Valid Values: db.t1.micro | db.m1.small |db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge |db.m2.4xlarge

Type: String

Required: Yes

DBInstanceIdentifier

数据库实例名称

Constraints:

必须由字母数字连字符组成

首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Example: mydbinstance

Type: String

Required: Yes

DBName

数据库名称

实例创建时会用这个名字创建数据库,若没有指定则不创建数据库

Constraints:

必须由字母和数字组成

l不能与引擎名称相同

Type: String

Required: No

DBParameterGroupName

参数组名称

Constraints:

l由字母与数字组成的1-255位字符串

l首字符必须是字母

l不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: No

DBSecurityGroups

安全组名称

Default: 系统创建的默认安全组.

Type: String 

Required: No

Engine

引擎类型

Valid Values: MySQL | MongoDB

Type: String

Required: Yes

EngineVersion

引擎版本

Example: 5.1.42

Type: String

Required: No

MasterUserPassword

数据库用户密码

Type: String

MySQL

Constraints: 由字母与数字组成的8-41位字符串

Type: String

Required: Yes

MasterUsername

数据库用户名

Constraints:

l由字母与数字组成的1-16位字符串

l首字符必须是字母

不能和引擎名称相同

Type: String

Required: Yes

Port

数据库监听端口

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

Required: No

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=CreateDBInstance

    &DBInstanceIdentifier=SimCoProd01

    &Engine=mysql

    &MasterUserPassword=Password01

    &MasterUsername=master

    &DBInstanceClass=db.m1.large

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

 

DescribeDBInstances

Description

获取数据库实例相关信息,该接口支持分页

Request Parameters

 

DBInstanceIdentifier

数据库实例名

Constraints:

l由字母,数字或连字符组成的1-63位字符串

l首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: No

Marker

查看页码数,若指定该参数,则必须提供参数 "MaxRecords"

Type: String

Required: No

MaxRecords

每页显示数量

Default: 100

Constraints: 20-100

Type: Integer

Required: No

FuzzyQuery

使用模糊查询查看数据库实例信息

Default: true

Type: Boolean

Required: No

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=DescribeDBInstances

    &DBInstanceIdentifier=SimCoProd01

    &MaxRecords=100

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

DescribeDBInstanceSpaceState

Description

获取数据库实例空间使用情况

Request Parameters

 

DBInstanceIdentifier

数据库实例名称,若提供该参数则获取指定实例信息

Constraints:

l由字母,数字或连字符组成的1-63位字符串

首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: No

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=DescribeDBInstanceSpaceState

    &DBInstanceIdentifier=SimCoProd01

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

DeleteDBInstance

Description

删除实例,若在删除前制作镜像则等待镜像创建完成再删除实例

Request Parameters

 

DBInstanceIdentifier

数据库实例名称

Constraints:

l由字母,数字或连字符组成的1-63位字符串

l首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: Yes

FinalDBSnapshotIdentifier

镜像名称

Note

指定该参数,又选择了跳过镜像创建或导致错误产生

Constraints:

l由字母与数字组成的1-255位字符串

l首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: No

SkipFinalSnapshot

跳过删除实例前的创建镜像操作

Note

如果参数"SkipFinalSnapshot" 设为false,则参数"FinalDBSnapshotIdentifier"必须提供

Default: false

Type: Boolean

Required: Yes

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=DeleteDBInstance

    &DBInstanceIdentifier=dbinstance01

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

 

 

ModifyDBPassword

Description

修改数据库连接密码

Request Parameters

 

DBInstanceIdentifier

数据库实例名称

Constraints:

l由字母,数字或连字符组成的1-63位字符串

l首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: Yes

MasterUserPassword

数据库新密码,不能包含 "/", "\", 或者 "@".

Type: String

MySQL

Constraints: 由字母和数字组成的8-41位字符串.

Type: String

Required: Yes

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=ModifyDBPassword

    &DBInstanceIdentifier=dbinstance01

    &MasterUserPassword=mynewpassword

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

 

RebootDBInstance

Description

重启数据库实例

Request Parameters

 

DBInstanceIdentifier

数据库实例名称

Constraints:

l由字母,数字或连字符组成的1-63位字符串

l首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: Yes

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=RebootDBInstance

    &DBInstanceIdentifier=dbinstance01

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

RestoreDBInstance

RestoreDBInstanceFromDBSnapshot

Description

根据镜像恢复数据库

Request Parameters

 

AvailabilityZone

数据库可用区域

Default: 随机选择一个可用区域

Example: us-east-1a

Type: String

Required: No

DBInstanceClass

数据库实例类型

Valid Values: db.t1.micro | db.m1.small | db.m1.medium| db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

Type: String

Required: No

DBInstanceIdentifier

数据库实例名称

Constraints:

l由字母,数字或连字符组成的1-63位字符串

l首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: Yes

DBName

数据库名称

Note

 

不能与引擎名称相同

 

Type: String

Required: No

DBSnapshotIdentifier

实例镜像名称

Constraints:

l由字母,数字或连字符组成的1-255位字符串

首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Example: my-snapshot-id

Type: String

Required: Yes

Engine

数据库引擎

Default: 与原数据库实例引擎相同

Constraint: 必须与原数据库实例引擎兼容

Example: oracle-ee

Type: String

Required: No

Port

数据库服务监听端口

Default: 与原数据库实例监听端口相同

Constraints: 1150-65535

Type: Integer

Required: No

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=RestoreDBInstanceFromDBSnapshot

     &DBSnapshotIdentifier=mydbsnapshot

     &DBInstanceIdentifier=myrestoreddbinstance

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

 

 

RestoreDBInstanceToPointInTime

Description

恢复数据库到某个时间点

Request Parameters

 

AvailabilityZone

数据库可用区域

Default: 随机选择一个可用区域

Example: us-east-1a

Type: String

Required: No

DBInstanceClass

数据库实例类型

Valid Values: db.t1.micro | db.m1.small |db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge

Default: 与原数据库实例类型相同

Type: String

Required: No

DBName

数据库名称

Note

Type: String

Required: No

Engine

数据库引擎

Default: 原实例引擎

Constraint: 必须与原数据库实例引擎兼容

Example: mySQL

Type: String

Required: No

Port

数据库服务监听端口

Constraints: 1150-65535

Default: 3306

Type: Integer

Required: No

RestoreTime

数据库恢复的时间点

Valid Values: 值必须符合 UTC 时间

Constraints:

必须在当前时间以前

Example: 2009-09-07T23:45:00Z

Type: DateTime

Required: No

SourceDBInstanceIdentifier

原数据库实例名称

Constraints:

原实例必须存在

l由字母,数字或连字符组成的1-63位字符串

l首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: Yes

TargetDBInstanceIdentifier

新数据库实例名称

Constraints:

l由字母,数字或连字符组成的1-63位字符串

l首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: Yes

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=RestoreDBInstanceToPointInTime

     &TargetDBInstanceIdentifier=restored-db

    &SourceDBInstanceIdentifier=simcoprod01

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

CreateDBSnapshot

Description

创建镜像,创建镜像的实例必须是"available" 状态.

Request Parameter

 

DBInstanceIdentifier

数据库实例名称

Constraints:

l由字母,数字或连字符组成的1-63位字符串

首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: Yes

DBSnapshotIdentifier

镜像名称.

Constraints:

l不能为空

l由字母,数字或连字符组成的1-255位字符串

l首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Example: my-snapshot-id

Type: String

Required: Yes

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=CreateDBSnapshot

     &DBInstanceIdentifier=simcoprod01

    &DBSnapshotIdentifier=mydbsnapshot

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

DeleteDBSnapshot

DeleteDBSnapshot

Description

删除镜像

Note

镜像状态必须是"available才能被删除

Request Parameters

 

DBSnapshotIdentifier

镜像名称

Constraints: 必须是存在的镜像名,且状态为"available

Type: String

Required: Yes

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=DeleteDBSnapshot

     &DBInstanceIdentifier=simcoprod01

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

 

DescribeDBSnapshots

Description

返回所有镜像信息,该接口支持分页

Request Parameters

 

DBInstanceIdentifier

数据库实例名称,查看该实例的所有镜像,该参数不能与DBSnapshotIdentifier 混用

Constraints:

l由字母与数字组成的1-63位字符串

首字符必须是字母

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: No

DBSnapshotIdentifier

实例镜像名称

Constraints:

l由字母与数字组成的1-255位字符串

l首字符必须是字母

l不能以连字符结尾,且不能出现连续两个连字符

 

Type: String

Required: No

Marker

查看页码数,若指定该参数,则必须提供 "MaxRecords"

Type: String

Required: No

MaxRecords

每页显示数量

Default: 100

Constraints: 20-100

Type: Integer

Required: No

SnapshotType

镜像类型

Type: String

Required: No

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=DescribeDBSnapshot

     &MaxRecords=100

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

 

CreateDBSecurityGroup

Description

创建安全组

Request Parameters

 

DBSecurityGroupDescription

安全组相关描述

Type: String

Required: Yes

DBSecurityGroupName

安全组名称

Constraints: 由字母与数字组成的1-255位字符串,且不能为 "Default".

Example: mysecuritygroup

Type: String

Required: Yes

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=CreateDBSecurityGroup

    &DBSecurityGroupName=mydbsecuritygroup

    &DBSecurityGroupDescription=My%20new%20DBSecurityGroup

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

DeleteDBSecurityGroup

Description

删除安全组

Note

删除的安全组不能被现有的实例所绑定

RequestParameters

 

DBSecurityGroupName

安全组名称

Note

不能删除默认参数组

Constraints:

l由字母与数字组成的1-255位字符串

不能以连字符结尾,且不能出现连续两个连字符

Type: String

Required: Yes

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=DeleteDBSecurityGroup

    &DBSecurityGroupName=mysecuritygroup

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

DescribeDBSecurityGroups

Description

获取安全组列表,如果给定安全组名称,则返回该安全组的详细信息,该接口支持分页

Request Parameters

 

DBSecurityGroupName

安全组的名称

Type: String

Required: No

Marker

查看页码数,若指定该参数,则必须提供 "MaxRecords"

Type: String

Required: No

MaxRecords

每页显示数量

Default: 100

Constraints: 20-100

Type: Integer

Required: No

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=DescribeDBSecurityGroups

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

 

AuthorizeDBSecurityGroupIngress

Description

添加安全组规则

Request Parameters

 

CIDRIP

安全组规则,添加允许访问IP

Type: String

Required: No

DBSecurityGroupName

安全组名称

Type: String

Required: Yes

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=AuthorizeDBSecurityGroupIngress

    &DBSecurityGroupName=mydbsecuritygroup

    &CIDRIP=192.168.1.1%2F24

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw

 

 

 

RevokeDBSecurityGroupIngress

Description

移除安全组原有规则

Request Parameters

 

CIDRIP

安全组规则,限制可访问IP范围,必须符合 CIDR 规则

Type: String

Required: No

DBSecurityGroupName

安全组名称

Type: String

Required: Yes

 

Examples

Sample Request

http://nepo.360buy.com/

    ?Action=RevokeDBSecurityGroupIngress

    &DBSecurityGroupName=mydbsecuritygroup

    &CIDRIP=192.168.1.1%2F24

    &UserId=bjsw

    &AccessKey=B0QMclV3jO%2BJDfOru17Aic430eI%3D

    &Signature=bjsw