文档首页> 云数据库 RDS> API参考> API v3（推荐）> 实例管理> 创建数据库实例
更新时间：2022-08-15 GMT+08:00
编辑
查看PDF
分享

创建数据库实例

功能介绍

创建RDS实例，可分为单实例、HA实例和只读副本。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    POST /v3/{project_id}/instances

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

请求消息

表2 参数说明（创建单机实例、主备实例和集群版实例）

名称

是否必选

参数类型

说明

name

是

String

实例名称。

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

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

datastore

是

Object

数据库信息。

详情请参见表4。

ha

否

Object

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

详情请参见表5。

configuration_id

否

String

参数模板ID。

使用可参考获取参数模板列表响应消息表3中的“id”。

port

否

String

数据库端口信息。

  • RDS for MySQL数据库端口设置范围为1024～65535（其中12017和33071被RDS系统占用不可设置）。
  • RDS for PostgreSQL数据库端口修改范围为2100～9500。
  • RDS for SQL Server实例的端口设置范围为1433和2100~9500（其中5355和5985不可设置。对于2017 EE、2017 SE、2017 Web版，5050、5353和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，默认为空。

flavor_ref

是

String

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

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

volume

是

Object

volume信息。

详情请参见表7。

region

是

String

区域ID。

取值范围：非空，请参见地区和终端节点。

availability_zone

是

String

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

取值范围：非空，请参见地区和终端节点。

vpc_id

是

String

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

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

subnet_id

是

String

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

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

data_vip

否

String

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

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

security_group_id

是

String

指定实例所属的安全组。

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

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

charge_info

否

Object

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

详情请参见表8。

time_zone

否

String

UTC时区。

  • 不选择时，各个引擎时区如下：
    • MySQL默认为UTC时间。
    • PostgreSQL默认为UTC时间。
    • Microsoft SQL Server国内站默认为China Standard Time，国际站默认为UTC时间。
  • 选择填写时，取值范围为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}表示标签值，可以为空。

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

详情请参见 表9。

unchangeable_param

否

Object

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

详情参见表11。

collation

否

String

仅限RDS for SQL Server实例创建使用。对于RDS for MySQL和RDS for PostgreSQL实例，该参数无意义。

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

dry_run

否

Boolean

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

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

count

否

Integer

批量创建实例的数量，取值范围为1~50。
表3 参数说明（创建只读实例，RDS for SQL Server暂时不支持包周期只读实例）

名称

是否必选

参数类型

说明

name

是

String

实例名称。

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

取值范围：

  • RDS for MySQL数据库支持的字符长度是4~64个字符，必须以字母开头，区分大小写，可以包含字母、数字、中文字符、中划线或者下划线，不能包含其他的特殊字符。
  • RDS for PostgreSQL数据库支持的字符长度是4~64个字符，必须以字母开头，区分大小写，可以包含字母、数字、中文字符、中划线或者下划线，不能包含其他的特殊字符。
  • RDS for SQL Server数据库支持的字符长度是4~64个字符，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。

enterprise_project_id

否

String

项目标签。

disk_encryption_id

否

String

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

replica_of_id

否

String

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

flavor_ref

是

String

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

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

volume

是

Object

volume信息。

详情请参见表7。

region

否

String

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

取值范围：非空，请参见地区和终端节点。

availability_zone

是

String

可用区ID。

取值范围：非空，请参见地区和终端节点。

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版本。取值示例：5.7。
  • PostgreSQL引擎支持9.5、9.6、10、11、12、13、14版本。取值示例：9.6。如果您需要购买14版本的实例，请联系客服人员申请。
  • Microsoft SQL Server：仅支持2017 企业版、2017 标准版、2017 web版、2014 标准版、2014 企业版、2016 标准版、2016 企业版、2012 企业版、2012 标准版、2012 web版、2008 R2 企业版、2008 R2 web版、2014 web版、2016 web版。取值示例2014_SE。

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

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，表示SSD。
  • 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

标签键。最大长度36个unicode字符。

key不能为空或者空字符串，不能为空格。

字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。

value

是

String

标签值。最大长度43个unicode字符。

可以为空字符串。

字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。
表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<String,String>

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

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

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

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

名称

是否必选

参数类型

说明

lower_case_table_names

否

String

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

取值范围：

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

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

请求样例中参数“region”和“availability_zone”的值为示例值。

  • URI样例

    POST https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances

  • 请求样例

    创建单实例：

    {
	"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": "aaa",
	"availability_zone": "bbb",
	"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": "****",
	"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
}

    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": "aaa",
	
	"availability_zone": "bbb",
	"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": "****",
	"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": "aaa",
	"availability_zone": "bbb",
	"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"
	},
        "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用户创建单实例：

    {
	"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": "aaa",
	"availability_zone": "bbb",
	"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": "****",
	"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": "aaa",
	"availability_zone": "bbb,ccc",
	"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": "****",
	"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用户创建HA实例：

    {
	"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": "aaa",
	"availability_zone": "bbb,ccc",
	"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": "****",
	"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"
	},
	"disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4",
	"region": "aaa",
	"availability_zone": "bbb",
	"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": "aaa",
	"availability_zone": "bbb",
	"enterprise_project_id": "fdsa-3rds"
        "dsspool_id":"3278327382738217382173872183721837213",
	"tags": [
		{
			"key": "key1",
			"value": "value1"
		},
		{
			"key": "key2",
			"value": "value2"
		}
	]

响应消息

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

    名称

    参数类型

    说明

    instance

    Object

    实例信息。

    详情请参见表13。

    job_id

    String

    实例创建的任务id。

    查询详细任务信息请参见获取指定ID的任务信息。

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

    order_id

    String

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

    名称

    参数类型

    说明

    id

    String

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

    name

    String

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

    取值范围：

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

    status

    String

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

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

    datastore

    Object

    数据库信息。

    详情请参见表14。

    ha

    Object

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

    详情请参见表15。

    configuration_id

    String

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

    port

    String

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

    backup_strategy

    Object

    自动备份策略。

    详情请参见表16。

    enterprise_project_id

    String

    项目标签。

    disk_encryption_id

    String

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

    flavor_ref

    String

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

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

    volume

    Object

    volume信息。

    详情请参见表17。

    region

    String

    区域ID。

    availability_zone

    String

    可用区ID。

    vpc_id

    String

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

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

    subnet_id

    String

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

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

    security_group_id

    String

    指定实例所属的安全组。

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

    charge_info

    Object

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

    详情请参见表18。

    collation

    String

    RDS for SQL Server设定的字符集信息。

    restore_point

    Object

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

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

    名称

    参数类型

    说明

    type

    String

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

    • MySQL
    • PostgreSQL
    • SQLServer

    version

    String

    数据库版本。

    数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。
    表15 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”为同步模式。
    表16 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”。
    表17 volume字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    磁盘类型。

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

    • ULTRAHIGH，表示SSD。
    • LOCALSSD，表示本地SSD。
    • CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。
    • ESSD，表示极速型SSD。

    size

    Integer

    磁盘大小。

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

    名称

    参数类型

    说明

    charge_mode

    String

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

    period_num

    Integer

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

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

    参数

    参数类型

    描述

    instance_id

    String

    源实例ID。

    type

    String

    恢复方式。

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

    backup_id

    String

    用于恢复的备份ID。

    restore_time

    Integer

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

    database_name

    Map<String,String>

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

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

  • 正常响应样例

    MySQL单实例：

    {
	"instance": {
		"id": "dsfae23fsfdsae3435in01",
		"name": "trove-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": "aaa",
		"availability_zone": "bbb",
		"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": "aaa",
		"availability_zone": "bbb",
		"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.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": "aaa",
           "availability_zone": "bbb,ccc",
           "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": "aaa",
           "availability_zone": "bbb",
           "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"  
}
  • 异常响应

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 实例管理
分享：

    相关文档

    相关产品

close