九游平台/ 云数据库 rds/ / / / 创建数据库实例
更新时间：2024-08-09 gmt 08:00

创建数据库实例-九游平台

功能介绍

创建rds实例，可分为单机实例、主备实例和只读实例。

  • 调用接口前，您需要了解api 。

本接口支持创建rds for mysql实例时，在http请求消息头中设置x-client-token请求头，保证请求幂等性。详细信息请参考。

调试

您可以在中调试该接口。

uri

  • uri格式

    post /v3/{project_id}/instances

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    租户在某一region下的项目id。

    获取方法请参见。

请求消息

表2 参数说明（创建单机实例、主备实例和集群版实例，不支持创建rds for sql server加域实例）

名称

是否必选

参数类型

说明

name

是

string

实例名称。

用于表示实例的名称，同一租户下，同类型的实例名可重名。取值规则如下：

  • rds for mysql支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线、点或者下划线，不能包含其他的特殊字符。
  • rds for postgresql和rds for sql server支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线或者下划线，不能包含其他的特殊字符。

datastore

是

object

数据库信息。

详情请参见表4。

flavor_ref

是

string

规格码，取值范围：非空。

使用可参考查询数据库规格响应消息表3中的“spec_code”。

volume

是

object

实例存储信息。

详情请参见表7。

region

是

string

区域id。

取值范围：非空，请参见。

availability_zone

是

string

可用区id。对于数据库实例类型不是单机的实例，需要分别为实例所有节点指定可用区，并用逗号隔开。详见示例。

调用查询数据库规格接口的返回信息中可以获取到可用区id。

vpc_id

是

string

虚拟私有云id，获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找vpc id。
  • 方法2：通过虚拟私有云服务的api接口查询，具体操作可参考。

subnet_id

是

string

子网的网络id信息，获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，单击vpc下的子网，进入子网详情页面，查找网络id。
  • 方法2：通过虚拟私有云服务的api接口查询，具体操作可参考。

security_group_id

是

string

指定实例所属的安全组。

  • 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组id。
  • 方法2：通过虚拟私有云服务的api接口查询，具体操作可参考。

如需开通mysql多安全组权限，您可以在管理控制台右上角，选择“”，提交权限申请。最多支持添加10个安全组id，安全组id之间用英文逗号隔开。

ha

否

object

ha配置参数，创建主备实例时使用。

详情请参见表5。

configuration_id

否

string

参数模板id。

使用可参考响应消息中的“id”。

port

否

string

数据库端口信息。

  • rds for mysql数据库端口设置范围为1024～65535（其中12017和33071被rds系统占用不可设置）。
  • rds for postgresql数据库端口修改范围为2100～9500。
  • 对于rds for sql server 2022 ee、2022 se、2022 web版、2019 ee、2019 se、2019 web版、2017 ee、2017 se、2017 web版：端口设置范围为1433和2100~9500（其中5050、5353、5355、5985和5986不可设置）。

    除此之外的其他版本：端口设置范围为1433和2100~9500（其中5355、5985和5986不可设置）。

当不传该参数时，默认端口如下：

  • rds for mysql默认3306。
  • rds for postgresql默认5432。
  • rds for sql server默认1433。

password

否

string

数据库密码。

取值范围：

数据库支持的密码长度是8~32个字符，至少包含大写字母、小写字母、数字、特殊字符三种字符的组合。

其中允许的特殊字符如下：

  • rds for mysql数据库允许输入~!@#$%^*-_= ?,()&特殊字符。
  • rds for sql server数据库允许输入~!@#$%^*-_ ?,特殊字符。
  • rds for postgresql数据库允许输入~!@#%^*-_= ?,特殊字符。

建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您提供的密码被系统视为弱密码，您将收到错误提示，请提供更高强度的密码。

backup_strategy

否

object

高级备份策略。

详情请参见表6。

enterprise_project_id

否

string

企业项目id。

使用请参考《企业管理 api参考》的“”响应消息表“enterprise_project字段数据结构说明”的“id”。

disk_encryption_id

否

string

用于磁盘加密的密钥id，默认为空。

说明：

serverless型实例不支持该参数。

data_vip

否

string

指定实例的内网ip，目前仅支持设置ipv4地址，获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，单击vpc下的子网，进入子网详情页面，查找子网的网段，选择未被占用的ip 。
  • 方法2：通过虚拟私有云服务的api接口查询，具体操作可参考，选择“device_owner”为空的私有ip。

charge_info

否

object

计费类型信息，支持包年包月和按需，默认为按需。

详情请参见表8。

time_zone

否

string

utc时区。

  • 不选择时，各个引擎时区如下：
    • mysql默认为utc时间。
    • postgresql默认为utc时间。
    • microsoft sql server国内站默认为china standard time，国际站默认为utc时间。
  • mysql和postgresql引擎选择填写时，取值范围为utc-12:00~utc 12:00，且只支持整段时间，如utc 08:00，不支持utc 08:30。
  • 选择填写时，取值范围为utc-12:00~utc 12:00，且只支持整段时间，如utc 08:00，不支持utc 08:30。

dsspool_id

否

string

dec用户专属存储id，每个az配置的专属存储不同，dec用户创建实例时，对于数据库实例类型不是单机或只读的实例，需要分别为实例所有节点指定dsspoolid，并用逗号隔开。

restore_point

否

object

恢复数据源对象。恢复到新实例时必选。

详情请参见表10。

tags

否

array of objects

标签列表，根据标签键值对创建实例。

  • {key}表示标签键，不可以为空或重复。
  • {value}表示标签值，可以为空。

如果创建实例时同时使用多个标签键值对，中间使用逗号分隔开，最多包含20组。

详情请参见 表9。

unchangeable_param

否

object

不可变更参数列表。该对象中的参数，在数据库初始化之前指定，指定后不支持修改。

详情参见表12。

collation

否

string

仅限rds for sql server实例创建使用。对于rds for mysql和rds for postgresql实例，该参数无意义。

取值范围：根据查询可设置的字符集。

dry_run

否

boolean

是否只预检此次请求，仅支持mysql引擎。

  • true：发送参数检查请求，不会创建实例。
    • 检查通过：返回202状态码。
    • 检查不通过：返回对应错误码，详情请参考。
  • false：发送正常请求，通过检查后，并且执行创建实例的请求。

count

否

integer

批量创建实例的数量，取值范围为1~50。

创建只读实例时，不支持设置该参数。

serverless_info

否

object

serverless型实例的资源扩缩范围。创建serverless型实例时必选。

详情参见表11 serverless_info字段数据结构说明。
表3 参数说明（创建只读实例，serverless实例暂时不支持创建只读实例，rds for sql server暂时不支持包周期只读实例）

名称

是否必选

参数类型

说明

name

是

string

实例名称。

用于表示实例的名称，同一租户下，同类型的实例名可重名。

取值规则如下：

  • rds for mysql支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线、点或者下划线，不能包含其他的特殊字符。
  • rds for postgresql和rds for sql server支持的字符长度是4~64个字节，必须以字母或中文开头，区分大小写，可以包含字母、数字、中文字符（一个中文字符占用3个字节）、中划线或者下划线，不能包含其他的特殊字符。

replica_of_id

是

string

只读实例的主实例id。创建只读实例时必选，其它场景不可选。

flavor_ref

是

string

规格码，取值范围：非空。

使用可参考查询数据库规格响应消息表3中的“spec_code”。

volume

是

object

volume信息。

详情请参见表7。

availability_zone

是

string

可用区id。

调用查询数据库规格接口的返回信息中可以获取到可用区id。

enterprise_project_id

否

string

项目标签。

disk_encryption_id

否

string

用于磁盘加密的密钥id，默认为空。

region

否

string

区域id。当前只支持创建与主实例同region的只读实例。

取值范围：非空，请参见。

charge_info

否

object

计费类型信息，支持包年/包月和按需，默认为按需。

详情请参见表8。

说明：

创建rds for mysql和rds for postgresql包年/包月计费模式的只读实例，需要具有相应的操作权限，您可以联系客服人员申请。

rds for sql server暂时不支持包周期只读实例。

dsspool_id

否

string

dec用户专属存储id，每个az配置的专属存储不同，dec用户创建实例时，对于数据库实例类型不是单机或只读的实例，需要分别为实例所有节点指定dsspoolid，并用逗号隔开。
表4 datastore字段数据结构说明

名称

是否必选

参数类型

说明

type

是

string

数据库引擎，取值如下：

  • mysql
  • postgresql
  • sqlserver

version

是

string

数据库版本。

  • mysql引擎取值：5.6、5.7、8.0。
  • postgresql引擎取值：10、11、12、13、14、15。9.5和9.6版本不支持购买，仅存量经营。
  • microsoft sql server：仅支持2022 企业版、2022 标准版、2022 web版（如需购买2022版本，请联系客服申请）、2019 企业版、2019 标准版、2019 web版、2017 企业版、2017 标准版、2017 web版、2014 标准版、2014 企业版、2016 标准版、2016 企业版、2012 企业版、2012 标准版、2012 web版、2014 web版、2016 web版。取值示例2014_se。2008 r2 企业版和2008 r2 web版不支持购买，仅存量经营。

数据库支持的详细版本信息，可调用接口获取。

complete_version

否

string

数据库完整版本号。仅在数据库引擎是“postgresql”时返回。
表5 ha字段数据结构说明

名称

是否必选

参数类型

说明

mode

是

string

实例主备模式，取值：ha，不区分大小写。

replication_mode

是

string

备机同步参数。

取值：

  • rds for mysql为“async”或“semisync”。
  • rds for postgresql为“async”或“sync”。
  • rds for sql server为“sync”。
说明：
  • “async”为异步模式。
  • “semisync”为半同步模式。
  • “sync”为同步模式。
表6 backup_strategy字段数据结构说明

名称

是否必选

参数类型

说明

start_time

是

string

备份时间段。自动备份将在该时间段内触发。

取值范围：非空，格式必须为hh:mm-hh:mm且有效，当前时间指utc时间。

  • hh取值必须比hh大1。
  • mm和mm取值必须相同，且取值必须为00、15、30或45。

取值示例：

  • 08:15-09:15
  • 23:00-00:00

keep_days

否

integer

指定备份文件的可保存天数。

取值范围：0～732。该参数缺省，或取值为0，表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。

须知：

rds for sql server的ha实例不支持关闭自动备份策略。
表7 volume字段数据结构说明

名称

是否必选

参数类型

说明

type

是

string

磁盘类型。

取值范围如下，区分大小写：

  • ultrahigh，表示超高io型磁盘。
  • localssd，表示本地ssd盘。
  • cloudssd，表示ssd云盘，仅支持通用型和独享型规格实例。
  • essd，表示极速型ssd。

size

是

integer

磁盘大小。

取值范围：40gb~4000gb，必须为10的整数倍。

说明：

对于只读实例，该参数无效，磁盘大小，默认和主实例相同。
表8 charge_info字段数据结构说明

名称

是否必选

参数类型

说明

charge_mode

是

string

计费模式。

取值范围：

  • prepaid：预付费，即包年/包月。
  • postpaid：后付费，即按需付费。

period_type

否

string

订购周期类型。

取值范围：

  • month：包月。
  • year：包年。
    说明：

    “charge_mode”为“prepaid”时生效，且为必选值。

period_num

否

integer

“charge_mode”为“prepaid”时生效，且为必选值，指定订购的时间。

取值范围：

  • 当“period_type”为“month”时，取值为1~9。
  • 当“period_type”为“year”时，取值为1~3和5。

    当前仅rds for mysql支持订购时间设置为5年，约束条件如下：

    • 如需订购时间设置为5年，需要具有相应的操作权限，您可以联系客服人员申请。
    • 当前仅华北-北京四、华东-上海一、华南-广州、西南-贵阳一支持。
    • 当前仅通用型规格实例支持。

is_auto_renew

否

boolean

创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

  • true，为自动续订。
  • false，为不自动续订，默认该方式。

is_auto_pay

否

boolean

创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的九游平台的支付方式。

  • true，为自动支付。
  • false，为手动支付，默认该方式。
表9 tags字段数据结构说明

名称

是否必选

参数类型

说明

key

是

string

标签键。长度为1-128个unicode字符。

可以包含任何语种字母、数字、空格和_.:= -@，但首尾不能含有空格，不能以_sys_开头。

value

是

string

标签值。最大长度255个unicode字符，可以为空字符串。

可以包含任何语种字母、数字、空格和_.:= -@。
表10 restore_point字段数据结构说明

名称

是否必选

参数类型

说明

instance_id

是

string

源实例id。

type

是

string

表示恢复方式，枚举值：

  • “backup”，表示使用备份文件恢复，按照此方式恢复时，“type”字段为非必选，“backup_id”必选。
  • “timestamp”，表示按时间点恢复，按照此方式恢复时，“type”字段必选，“restore_time”必选。

backup_id

否

string

用于恢复的备份id。当使用备份文件恢复时需要指定该参数。

restore_time

否

integer

恢复数据的时间点，格式为unix时间戳，单位是毫秒，时区为utc。

database_name

否

map

仅适用于sql server引擎，当有此参数时表示支持局部恢复和重命名恢复，恢复数据以局部恢复为主。

  • 新数据库名称不可与源实例数据库名称重名，新数据库名称为空，默认按照原数据库名进行恢复。 注意： 不填写该字段时，默认恢复全部数据库。

    示例：”database_name”:{“原库名”:”新库名”}

  • 新数据库名不能包含rdsadmin、master、msdb、tempdb、model或resource字段（不区分大小写）。
  • 数据库名称长度在1~64个字符之间，包含字母、数字、下划线或中划线，不能包含其他特殊字符。
表11 serverless_info字段数据结构说明

名称

是否必选

参数类型

说明

min_cap

是

string

serverless型实例的最小算力，单位rcu，范围0.5~8，步进0.5。

说明：

rcu即rds capacity unit，是serverless型实例的计费单位。

max_cap的值要大于min_cap的值。

max_cap

是

string

serverless型实例的最大算力，单位rcu，范围0.5~8，步进0.5。
表12 unchangeable_param字段数据结构说明

名称

是否必选

参数类型

说明

lower_case_table_names

否

string

表名大小写是否敏感，默认值是“1”。

取值范围：

  • 0：表名被存储成固定且表名称大小写敏感。
  • 1：表名将被存储成小写且表名称大小写不敏感。
说明：

恢复已有实例时，目标实例与原实例表名大小写设置不一致，可能会导致恢复失败。

请求示例

  • 创建mysql单机实例。
    post https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances
{
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "mysql",
		"version": "5.7"
	},
	"flavor_ref": "rds.mysql.s1.large",
	"volume": {
		"type": "ultrahigh",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.1",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
	"charge_info": {
		"charge_mode": "postpaid"
	},
	"password": "****",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "utc 04:00",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	],
        "dry_run": false,
        "count": 12
}
  • 创建postgresql单机实例。
    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "postgresql",
		"version": "10"
	},
	"flavor_ref": "rds.pg.s1.large",
	"volume": {
		"type": "ultrahigh",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.147",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
	"charge_info": {
		"charge_mode": "postpaid"
	},
	"password": "test@12345678",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "utc 04:00",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	]
}
  • 创建mysql 8.0单机实例指定初始化参数。
    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "mysql",
		"version": "8.0"
	},
	"flavor_ref": "rds.mysql.s1.large",
	"volume": {
		"type": "ultrahigh",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.1",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
	"charge_info": {
		"charge_mode": "postpaid"
	},
	"password": "****",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "utc 04:00",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	],
	"unchangeable_param": {
		"lower_case_table_names": "1"
	},
        "dry_run": false,
        "count": 12
}
  • 创建sql server单机实例支持指定字符集。
    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "sqlserver",
		"version": "2014_se"
	},
	"flavor_ref": "rds.mssql.se.m3.large.8",
	"volume": {
		"type": "ultrahigh",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.1",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
	"charge_info": {
		"charge_mode": "postpaid"
	},
        "collation": "cyrillic_general_ci_as",
	"password": "****",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "utc 04:00",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	],
}
  • dec用户创建mysql单机实例。
    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "mysql",
		"version": "5.6"
	},
	"flavor_ref": "rds.mysql.s1.large",
	"volume": {
		"type": "ultrahigh",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.1",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
	"charge_info": {
		"charge_mode": "postpaid"
	},
	"password": "****",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "utc 04:00",
       "dsspool_id":"3278327382738217382173872183721837213",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	],
        "dry_run": false,
        "count": 12
}
  • 创建主备实例。
    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "mysql",
		"version": "5.6"
	},
	"ha": {
		"mode": "ha",
		"replication_mode": "semisync"
	},
	"flavor_ref": "rds.mysql.s1.large.ha",
	"volume": {
		"type": "ultrahigh",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.1",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
	"charge_info": {
		"charge_mode": "postpaid"
	},
	"password": "****",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "utc 04:00",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	],
        "dry_run": false,
        "count": 12
}
  • dec用户创建mysql主备实例。
    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "mysql",
		"version": "5.6"
	},
	"ha": {
		"mode": "ha",
		"replication_mode": "semisync"
	},
	"flavor_ref": "rds.mysql.s1.large.ha",
	"volume": {
		"type": "ultrahigh",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a,cn-north-4b",
	"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
	"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
	"data_vip": "192.168.0.1",
	"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
	"port": 8635,
	"backup_strategy": {
		"start_time": "08:15-09:15",
		"keep_days": 12
	},
	"charge_info": {
		"charge_mode": "postpaid"
	},
	"password": "****",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg",
	"enterprise_project_id": "fdsa-3rds",
	"time_zone": "utc 04:00",
       "dsspool_id":"327832738273821772133432，21489938273821772133432",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	],
        "dry_run": false,
        "count": 12
}
  • 创建只读实例。
    {
	"name": "rds-instance-rep2",
	"replica_of_id": "afdsad-fds-fdsagin01",
	"flavor_ref": "rds.mysql.s1.large.rr",
	"volume": {
		"type": "ultrahigh",
		"size": 100
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
        "region": "cn-north-4",
	"availability_zone": "cn-north-4a",
	"enterprise_project_id": "fdsa-3rds",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	]
}
  • dec用户创建只读实例。
    {
	"name": "rds-instance-rep2",
	"replica_of_id": "afdsad-fds-fdsagin01",
	"flavor_ref": "rds.mysql.s1.large.rr",
	"volume": {
		"type": "ultrahigh"
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
        "region": "cn-north-4",
	"availability_zone": "cn-north-4a",
	"enterprise_project_id": "fdsa-3rds"
        "dsspool_id":"3278327382738217382173872183721837213",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	]
  • 创建mysql serverless型单机实例。
    {
        "name": "rds-instance-serverless1",
        "datastore": {
               "type": "mysql",
               "version": "5.7"
        },
        "flavor_ref": "rds.mysql.serverless",
        "volume": {
               "type": "cloudssd",
               "size": 40
        },
        "region": "cn-north-4",
	"availability_zone": "cn-north-4a",
        "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
        "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
        "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
        "port": 3306,
        "backup_strategy": {
               "start_time": "08:15-09:15",
               "keep_days": 12
        },
        "password": "****",
        "time_zone": "utc 04:00",
        "tags": [
               {
                       "key": "key1",
                       "value": "value1"
               },
               {
                       "key": "key2",
                       "value": "value2"
               }
        ],
        "dry_run": false,
        "count": 1,
        "serverless_info": {
              "min_cap": "0.5",
              "max_cap": "1"
        }
}
  • 创建mysql serverless型主备实例。
    {
        "name": "rds-instance-serverless2",
        "datastore": {
               "type": "mysql",
               "version": "5.7"
        },
        "ha": {
               "mode": "ha",
               "replication_mode": "semisync"
        },
        "flavor_ref": "rds.mysql.serverless.ha",
        "volume": {
               "type": "cloudssd",
               "size": 40
        },
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a,cn-north-4b",
        "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
        "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
        "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
        "port":3306,
        "backup_strategy": {
               "start_time": "08:15-09:15",
               "keep_days": 12
        },
        "password": "****",
        "time_zone": "utc 08:00",
        "tags": [
               {
                       "key": "key1",
                       "value": "value1"
               },
               {
                       "key": "key2",
                       "value": "value2"
               }
        ],
        "dry_run": false,
        "count": 1,
        "serverless_info": {
               "min_cap": "0.5",
               "max_cap": "1"
        }
}

响应消息

  • 正常响应要素说明
    表13 要素说明

    名称

    参数类型

    说明

    instance

    object

    实例信息。

    详情请参见表14。

    job_id

    string

    实例创建的任务id。

    查询详细任务信息请参见。

    仅创建按需实例时会返回该参数。

    order_id

    string

    订单号，创建包年包月时返回该参数。
    表14 instance说明

    名称

    参数类型

    说明

    id

    string

    实例id，批量创建实例时，mysql返回字段为多个实例id以英文逗号（,）隔开，其他引擎该字段为空。

    name

    string

    实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。

    status

    string

    实例状态。如build，表示创建中。

    仅创建按需实例时会返回该参数。

    datastore

    object

    数据库信息。

    详情请参见表15。

    ha

    object

    ha配置参数，仅当您选择创建ha实例时该参数才可见。

    详情请参见表16。

    configuration_id

    string

    参数模板id，仅当您创建实例指定用户自定义参数组时，该参数才可见。

    port

    string

    数据库端口信息，与请求参数相同。

    backup_strategy

    object

    自动备份策略。

    详情请参见表17。

    enterprise_project_id

    string

    项目标签。

    disk_encryption_id

    string

    用于磁盘加密的密钥id，仅当您创建实例选择该参数时才可见，默认为空。

    说明：

    serverless型实例不支持该参数。

    flavor_ref

    string

    规格码，取值范围：非空。

    使用可参考查询数据库规格响应消息表3中的“spec_code”。

    volume

    object

    volume信息。

    详情请参见表18。

    region

    string

    区域id。

    availability_zone

    string

    可用区id。

    vpc_id

    string

    虚拟私有云id，获取方法如下：

    • 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找vpc id。
    • 方法2：通过虚拟私有云服务的api接口查询，具体操作可参考。

    subnet_id

    string

    子网的网络id信息，获取方法如下：

    • 方法1：登录虚拟私有云服务的控制台界面，单击vpc下的子网，进入子网详情页面，查找网络id。
    • 方法2：通过虚拟私有云服务的api接口查询，具体操作可参考。

    security_group_id

    string

    指定实例所属的安全组。

    • 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组id。
    • 方法2：通过虚拟私有云服务的api接口查询，具体操作可参考。

    charge_info

    object

    计费方式信息，支持包年/包月和按需。

    详情请参见表19。

    collation

    string

    rds for sql server设定的字符集信息。

    restore_point

    object

    恢复数据源对象。恢复到新实例时必选。

    详情请参见表20。
    表15 datastore字段数据结构说明

    名称

    参数类型

    说明

    type

    string

    数据库引擎，返回值如下：

    • mysql
    • postgresql
    • sqlserver

    version

    string

    数据库版本。

    数据库支持的详细版本信息，可调用接口获取。
    表16 ha字段数据结构说明

    名称

    参数类型

    说明

    mode

    string

    实例主备模式，取值：ha。

    replication_mode

    string

    备机同步参数。实例为ha模式时有效。

    取值：

    • rds for mysql为“async”或“semisync”。
    • rds for postgresql为“async”或“sync”。
    • rds for sql server为“sync”。
    说明：
    • “async”为异步模式。
    • “semisync”为半同步模式。
    • “sync”为同步模式。
    表17 backupstrategy字段数据结构说明

    名称

    参数类型

    说明

    start_time

    string

    备份时间段。自动备份将在该时间段内触发。

    取值范围：非空，格式必须为hh:mm-hh:mm且有效，当前时间指utc时间。

    • hh取值必须比hh大1。
    • mm和mm取值必须相同，且取值必须为00、15、30或45。

    取值示例：

    • 08:15-09:15
    • 23:00-00:00

    如果请求体中“backup_strategy”为空，则响应体中 “start_time”默认返回“02:00-03:00”。

    keep_days

    integer

    指定已生成备份文件的可保存天数。

    取值范围：0～732。该参数缺省，或取0值，表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请，自动备份最长可以保留2562天。

    如果请求体中“backup_strategy”为空，则响应体中 “keep_days”默认返回“7”。
    表18 volume字段数据结构说明

    名称

    参数类型

    说明

    type

    string

    磁盘类型。

    取值范围如下，区分大小写：

    • ultrahigh，表示超高io型磁盘。
    • localssd，表示本地ssd盘。
    • cloudssd，表示ssd云盘，仅支持通用型和独享型规格实例。
    • essd，表示极速型ssd。

    size

    integer

    磁盘大小。

    取值范围：40gb~4000gb。必须为10的整数倍。
    表19 chargeinfo字段数据结构说明

    名称

    参数类型

    说明

    charge_mode

    string

    创建类型，支持包年/包月和按需。

    period_num

    integer

    订购周期长度，按月计算。

    “charge_mode”为“prepaid”，即包年/包月时该字段生效。
    表20 restore_point字段数据结构说明

    参数

    参数类型

    描述

    instance_id

    string

    源实例id。

    type

    string

    恢复方式。

    • “backup”，表示使用备份文件恢复
    • “timestamp”，表示按时间点恢复。

    backup_id

    string

    用于恢复的备份id。

    restore_time

    integer

    恢复数据的时间点，格式为unix时间戳，单位是毫秒，时区为utc。

    database_name

    map

    仅适用于sql server引擎，当有此参数时表示支持局部恢复和重命名恢复，恢复数据以局部恢复为主。

响应样例中参数“region”和“availability_zone”的值为示例值。

  • 正常响应样例

    创建mysql单机实例下发成功。

    {
	"instance": {
		"id": "dsfae23fsfdsae3435in01",
		"name": "trove-instance-rep2",
		"datastore": {
			"type": "mysql",
			"version": "5.7"
		},
		"flavor_ref": "rds.mysql.s1.large",
		"volume": {
			"type": "ultrahigh",
			"size": 100
		},
		"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
                "region": "cn-north-4",
	        "availability_zone": "cn-north-4a",
		"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
		"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
		"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
		"port": "8635",
		"backup_strategy": {
			"start_time": "08:15-09:15",
			"keep_days": 3
		},
		"configuration_id": "452408-44c5-94be-305145fg",
		"charge_info": {
			"charge_mode": "postpaid"
		}
	},
	"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

    创建sql server单机实例下发成功。

    {
	"instance": {
		"id": "dsfae23fsfdsae3435in01",
		"name": "trove-instance-rep2",
		"datastore": {
			"type": "sqlserver",
			"version": "2014_se"
		},
		"flavor_ref": "rds.mssql.2014.se.s3.large.2",
		"volume": {
			"type": "ultrahigh",
			"size": 100
		},
		"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
                "region": "cn-north-4",
	        "availability_zone": "cn-north-4a",
		"vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
		"subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
		"security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
		"port": "8635",
		"backup_strategy": {
			"start_time": "08:15-09:15",
			"keep_days": 3
		},
		"configuration_id": "452408-44c5-94be-305145fg",
		"charge_info": {
			"charge_mode": "postpaid"
		},
               "collation": "cyrillic_general_ci_as" 
	},
	"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

    创建主备实例下发成功。

    {
  "instance":{ 
           "id": "dsfae23fsfdsae3435in01",
           "name": "trove-instance-rep2", 
           "datastore": { 
             "type": "mysql", 
             "version": "5.7" 
            }, 
           "ha": {
             "mode": "ha",
             "replication_mode": "semisync"
           },
           "flavor_ref": "rds.mysql.s1.large.ha",
           "volume": { 
               "type": "ultrahigh", 
               "size": 100 
             },
           "disk_encryption_id":  "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	   "region": "cn-north-4",
	   "availability_zone": "cn-north-4a,cn-north-4b",
           "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", 
           "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
           "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", 
           "port": "8635", 
           "backup_strategy": { 
             "start_time": "08:15-09:15", 
             "keep_days": 3 
            }, 
           "configuration_id": "452408-44c5-94be-305145fg",
           "charge_info": {
                   "charge_mode": "postpaid"
                               },
         },
  "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" 
}

    创建只读实例下发成功。

    {
  "instance":{ 
            "id": "dsfae23fsfdsae3435in01",
            "name": "trove-instance-rep2", 
            "flavor_ref": "rds.mysql.s1.large.rr",
             "volume": { 
               "type": "ultrahigh", 
               "size": 100 
             },
           "disk_encryption_id":  "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
           "region": "cn-north-4",
           "availability_zone": "cn-north-4a",
           "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", 
           "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
           "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", 
           "port": "8635", 
           "configuration_id": "452408-44c5-94be-305145fg"
         },
 "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"  
}

    创建mysql serverless型单机实例下发成功。

    {
    "instance": {
        "id": "4c57a8203dd348f3b789476165755b20in01",
        "name": "serverless_single1",
        "status": "build",
        "datastore": {
            "type": "mysql",
            "version": "5.7"
        },
        "port": "3307",
        "volume": {
            "type": "cloudssd",
            "size": 40
        },
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a",
        "backup_strategy": {
            "start_time": "08:15-09:15",
            "keep_days": 12
        },
        "flavor_ref": "rds.mysql.serverless",
        "vpc_id": "bd3e4c67-74da-459d-820f-9fecd4ea9ca4",
        "subnet_id": "53cdf568-6f56-4944-a996-4afcaffe994e",
        "security_group_id": "89f258c5-4b81-4ef0-be30-34f2ee07dd1c",
        "charge_info": {
            "charge_mode": "postpaid"
        }
    },
    "job_id": "3c1b8910-4191-4eed-9865-49bd82bac65b"
}

    创建mysql serverless型主备实例下发成功。

    {
    "instance": {
        "id": "4c57a8203dd348f3b789476165755b20in01",
        "name": "serverless_ha1",
        "status": "build",
        "datastore": {
            "type": "mysql",
            "version": "5.7"
        },
        "ha": {
            "mode": "ha",
            "replication_mode": "semisync"
        },
        "port": "3307",
        "volume": {
            "type": "cloudssd",
            "size": 40
        },
	"region": "cn-north-4",
	"availability_zone": "cn-north-4a,cn-north-4b",
        "backup_strategy": {
            "start_time": "08:15-09:15",
            "keep_days": 12
        },
        "flavor_ref": "rds.mysql.serverless.ha",
        "vpc_id": "bd3e4c67-74da-459d-820f-9fecd4ea9ca4",
        "subnet_id": "53cdf568-6f56-4944-a996-4afcaffe994e",
        "security_group_id": "89f258c5-4b81-4ef0-be30-34f2ee07dd1c",
        "charge_info": {
            "charge_mode": "postpaid"
        }
    },
    "job_id": "3c1b8910-4191-4eed-9865-49bd82bac65b"
}
  • 异常响应

    请参见。

状态码

  • 正常

    202

  • 异常

    请参见。

错误码

请参见。

父主题：

相关文档

网站地图