文档首页 > > API参考> API v3(推荐)> 实例管理> 创建数据库实例

创建数据库实例

分享
更新时间: 2020/07/05 GMT+08:00

功能介绍

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

URI

  • URI格式

    POST https://{Endpoint}/v3/{project_id}/instances

  • URI样例

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

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    租户在某一region下的project ID。

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

请求消息

表2 参数说明(创建HA实例、单实例和分布式实例)

名称

是否必选

参数类型

说明

name

String

实例名称。

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

取值范围:4~64个字符之间,必须以字母开头,区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。

datastore

Object

数据库信息。

详情请参见表4

ha

Object

HA配置参数,创建HA实例时使用。

详情请参见表5

configuration_id

String

参数模板ID。

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

port

String

数据库端口信息。

  • MySQL数据库端口设置范围为1024~65535(其中12017和33071被RDS系统占用不可设置)。
  • PostgreSQL数据库端口修改范围为2100~9500。
  • Microsoft SQL Server实例的端口设置范围为1433和2100~9500(其中5355和5985不可设置。对于2017 EE、2017 SE、2017 Web版,5050、5353和5986不可设置)。

当不传该参数时,默认端口如下:

  • MySQL默认3306。
  • PostgreSQL默认5432。
  • Microsoft SQL Server默认1433。

password

String

数据库密码。

取值范围:

非空,由大小写字母、数字和特殊符号~!@#%^*-_=+?组成,长度8~32个字符。

建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。

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接口查询,具体操作可参考查询子网列表

security_group_id

String

指定实例所属的安全组。

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

charge_info

Object

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

详情请参见表8

time_zone

String

UTC时区。

  • 不选择时,各个引擎时区如下:
    • MySQL国内站、国际站默认为UTC时间。
    • PostgreSQL国内站、国际站默认为UTC时间。
    • Microsoft SQL Server国内站默认为UTC+08:00,国际站默认为UTC时间。
  • 选择填写时,取值范围为UTC-12:00~UTC+12:00,且只支持整段时间,如UTC+08:00,不支持UTC+08:30。

dsspool_id

String

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

表3 参数说明(创建只读实例,SQL Server暂时不支持包周期只读实例)

名称

是否必选

参数类型

说明

name

String

实例名称。

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

取值范围:4~64个字符之间,必须以字母开头,区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。

replica_of_id

String

主实例ID,用于创建只读实例。

使用可参考查询数据库实例列表响应消息表4中的“id”

enterprise_project_id

String

项目标签。

disk_encryption_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

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。具有相应权限的用户才可使用8.0,您可联系华为云客服人员申请。
  • PostgreSQL引擎支持1.0、9.5、9.6、10、11版本。取值示例:9.6。
  • 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。

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

表5 ha字段数据结构说明

名称

是否必选

参数类型

说明

mode

String

实例主备模式,取值:Ha(主备),不区分大小写。

replication_mode

String

备机同步参数。

取值:

  • MySQL为“async”或“semisync”。
  • PostgreSQL为“async”或“sync”。
  • Microsoft 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天。

须知:

SQL Server的HA实例不支持关闭自动备份策略。

表7 volume字段数据结构说明

名称

是否必选

参数类型

说明

type

String

磁盘类型。

取值范围如下,区分大小写:

  • ULTRAHIGH,表示SSD。
  • ULTRAHIGHPRO,表示SSD尊享版,仅支持超高性能型尊享版。

size

Integer

磁盘大小。

取值范围:40GB~4000GB,必须为10的整数倍。

MySQL部分用户支持11GB~10000GB,如果您想创建存储空间最大为10000GB的数据库实例,或提高扩容上限到10000GB,请联系客服开通。

说明:

对于只读实例,该参数无效,磁盘大小,默认和主实例相同。

表8 chargeInfo字段数据结构说明

名称

是否必选

参数类型

说明

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。

is_auto_renew

String

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

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

is_auto_pay

String

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

  • true,为自动支付。
  • false,为手动支付,默认该方式。

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

  • 请求样例

    创建单实例:

    {
    	"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",
    	"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"
    }

    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",
    	"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",
           "dsspool_id":"3278327382738217382173872183721837213"
    }

    创建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",
    	"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"
    }

    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",
    	"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",
           "dsspool_id":"327832738273821772133432,21489938273821772133432"        
    }

    创建只读实例:

    {
    	"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"
    }

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"

响应消息

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

    名称

    参数类型

    说明

    instance

    Object

    实例信息。

    详情请参见表10

    job_id

    String

    实例创建的任务id。

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

    order_id

    String

    订单号,创建包年包月时返回该参数。

    表10 instance说明

    名称

    参数类型

    说明

    id

    String

    实例id。

    说明:

    v3版本实例id与v1版本的实例id不兼容。

    name

    String

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

    取值范围:4~64个字符之间,必须以字母开头,不区分大小写,可以包含字母、数字、中划线或者下划线,不能包含其他的特殊字符。

    status

    String

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

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

    datastore

    Object

    数据库信息。

    详情请参见表11

    ha

    Object

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

    详情请参见表12

    configuration_id

    String

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

    port

    String

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

    backup_strategy

    Object

    自动备份策略。

    详情请参见表13

    enterprise_project_id

    String

    项目标签。

    disk_encryption_id

    String

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

    flavor_ref

    String

    规格码,取值范围:非空。

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

    volume

    Object

    volume信息。

    详情请参见表14

    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

    付费方式信息,支持包年/包月和按需。

    详情请参见表15

    表11 datastore字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    数据库引擎,返回值如下:

    • MySQL
    • PostgreSQL
    • SQLServer

    version

    String

    数据库版本。

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

    表12 ha字段数据结构说明

    名称

    参数类型

    说明

    mode

    String

    实例主备模式,取值范围:Ha(主备)。

    replication_mode

    String

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

    取值:

    • MySQL为“async”或“semisync”。
    • PostgreSQL为“async”或“sync”。
    • Microsoft SQL Server为“sync”。
    说明:
    • “async”为异步模式。
    • “semisync”为半同步模式。
    • “sync”为同步模式。
    表13 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”

    表14 volume字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    磁盘类型。

    取值范围如下,区分大小写:

    • ULTRAHIGH,表示SSD。

    size

    Integer

    磁盘大小。

    取值范围:40GB~4000GB。必须为10的整数倍。

    部分用户支持40GB~6000GB,如果您想创建存储空间最大为6000GB的数据库实例,或提高扩容上限到10000GB,请联系客服开通。

    表15 chargeInfo字段数据结构说明

    名称

    参数类型

    说明

    charge_mode

    String

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

    period_num

    Integer

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

    “charge_mode”“prePaid”,即包年/包月时该字段生效。

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

  • 正常响应样例

    单实例:

    {
    	"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"
    }

    HA实例:

    {
      "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"  
    
    }
  • 异常响应

    请参见异常请求结果

状态码

请参见状态码

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问