文档首页/ 云数据库 RDS/ API参考（安卡拉区域）/ API v3（推荐）/ 实例管理/ 创建数据库实例
更新时间：2024-04-11 GMT+08:00
查看PDF
分享

创建数据库实例

功能介绍

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

URI

  • URI格式

    POST /v3/{project_id}/instances

  • URI样例

    https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/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 MySQL默认3306。
  • RDS for PostgreSQL默认5432。

password

否

String

数据库密码。

取值范围：

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

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

  • RDS for MySQL数据库允许输入~!@#$%^*-_=+?,特殊字符。
  • RDS for PostgreSQL数据库允许输入~!@#%^*-_=+?,特殊字符。

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

backup_strategy

否

Object

高级备份策略。

详情请参见表6。

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，获取方法如下：

  • 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找子网的网段，选择未被占用的IP 。
  • 方法2：获取方法请参见《虚拟私有云API参考》中“查询子网”的内容。

security_group_id

是

String

指定实例所属的安全组。

  • 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。
  • 方法2：获取方法请参见《虚拟私有云API参考》中“查询安全组列表”的内容。

time_zone

否

String

UTC时区。

  • 不选择时，各个引擎时区如下：
    • MySQL默认为UTC时间。
    • PostgreSQL默认为UTC时间。
  • MySQL和PostgreSQL引擎选择填写时，取值范围为UTC-12:00~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。
表3 参数说明

名称

是否必选

参数类型

说明

name

是

String

实例名称。

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

取值范围：

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

flavor_ref

是

String

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

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

volume

是

Object

volume信息。

详情请参见表7。

region

否

String

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

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

availability_zone

是

String

可用区ID。

取值范围：非空，请参见地区和终端节点。
表4 datastore字段数据结构说明

名称

是否必选

参数类型

说明

type

是

String

数据库引擎，取值如下：

  • MySQL
  • PostgreSQL

version

是

String

数据库版本。

  • MySQL引擎支持5.6、5.7、8.0版本。取值示例：5.7。
  • PostgreSQL引擎支持9.5、9.6、10、11、12、13、14版本。取值示例：9.6。

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

名称

是否必选

参数类型

说明

mode

是

String

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

replication_mode

是

String

备机同步参数。

取值：

  • RDS for MySQL为“async”或“semisync”。
  • RDS for PostgreSQL为“async”或“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，表示关闭自动备份策略。
表7 volume字段数据结构说明

名称

是否必选

参数类型

说明

type

是

String

磁盘类型。

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

  • ULTRAHIGH，表示SSD（超高IO）。
  • CLOUDSSD，表示SSD云盘。

size

是

Integer

磁盘大小。

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

说明：

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

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

  • 请求样例

    创建单实例：

    {
	"name": "rds-instance-rep2",
	"datastore": {
		"type": "MySQL",
		"version": "5.6"
	},
	"flavor_ref": "rds.mysql.s1.large",
	"volume": {
		"type": "ULTRAHIGH",
		"size": 100
	},
	"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": "Test@12345678",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg"
}

    创建主备实例：

    {
	"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
	},
	"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": "Test@12345678",
	"configuration_id": "452408-ef4b-44c5-94be-305145fg"
}

    创建只读实例：

    {
	"name": "rds-instance-rep2",
	"replica_of_id": "afdsad-fds-fdsagin01",
	"flavor_ref": "rds.mysql.s1.large.rr",
	"volume": {
		"type": "ULTRAHIGH"
	},
	"region": "aaa",
	"availability_zone": "bbb"
}

响应消息

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

    名称

    参数类型

    说明

    instance

    Object

    实例信息。

    详情请参见表9。

    job_id

    String

    实例创建的任务id。
    表9 instance说明

    名称

    参数类型

    说明

    id

    String

    实例ID。

    说明：

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

    name

    String

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

    取值范围：

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

    status

    String

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

    datastore

    Object

    数据库信息。

    详情请参见表10。

    ha

    Object

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

    详情请参见表11。

    configuration_id

    String

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

    port

    String

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

    backup_strategy

    Object

    自动备份策略。

    详情请参见表12。

    flavor_ref

    String

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

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

    volume

    Object

    volume信息。

    详情请参见表13。

    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

    计费方式信息。

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

    名称

    参数类型

    说明

    type

    String

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

    • MySQL
    • PostgreSQL

    version

    String

    数据库版本。

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

    名称

    参数类型

    说明

    mode

    String

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

    replication_mode

    String

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

    取值：

    • RDS for MySQL为“async”或“semisync”。
    • RDS for PostgreSQL为“async”或“sync”。
    说明：
    • “async”为异步模式。
    • “semisync”为半同步模式。
    • “sync”为同步模式。
    表12 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值，表示关闭自动备份策略。

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

    名称

    参数类型

    说明

    type

    String

    磁盘类型。

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

    • ULTRAHIGH，表示SSD（超高IO）。
    • CLOUDSSD，表示SSD云盘。

    size

    Integer

    磁盘大小。

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

    名称

    参数类型

    说明

    charge_mode

    String

    创建类型。

响应样例中参数“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
		},
                "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"
}

    主备实例：

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

    请参见异常请求结果。

状态码

错误码

请参见错误码。

父主题： 实例管理