功能介绍

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

• 调用接口前，您需要了解API 认证鉴权。

调试

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

URI

• URI格式

  POST /v3/{project_id}/instances

• URI样例

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

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一region下的project ID。 获取方法请参见获取项目ID。

请求消息

请求样例中参数“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",
  	"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"
  		}
  	],
          "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": "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"
  		}
  	],
  	"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": "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"
  		}
  	],
  }

  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": "Test@12345678",
  	"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
  }

  创建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": "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"
  		}
  	],
          "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": "Test@12345678",
  	"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"
  		}
  	]
  }

响应消息

• 正常响应要素说明

  表12 要素说明

  名称	参数类型	说明
  instance	Object	实例信息。 详情请参见表13。
  job_id	String	实例创建的任务id。 查询详细任务信息请参见获取指定ID的任务信息。 仅创建按需实例时会返回该参数。
  order_id	String	订单号，创建包年包月时返回该参数。

  表13 instance说明

  名称	参数类型	说明
  id	String	实例ID，批量创建实例时，该字段为空。
  name	String	实例名称。用于表示实例的名称，同一租户下，同类型的实例名称可相同。 取值范围： MySQL数据库支持的字符长度是4~64个字符，必须以字母开头，区分大小写，可以包含字母、数字、中文字符、中划线或者下划线，不能包含其他的特殊字符。 PostgreSQL数据库支持的字符长度是4~64个字符，必须以字母开头，区分大小写，可以包含字母、数字、中文字符、中划线或者下划线，不能包含其他的特殊字符。 SQL Server数据库支持的字符长度是4~64个字符，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。
  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	Microsoft SQL Server设定的字符集信息。

  表14 datastore字段数据结构说明

  名称	参数类型	说明
  type	String	数据库引擎，返回值如下： MySQL PostgreSQL SQLServer
  version	String	数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。

  表15 ha字段数据结构说明

  名称	参数类型	说明
  mode	String	实例主备模式，取值范围：Ha（主备）。
  replication_mode	String	备机同步参数。实例主备模式为Ha时有效。 取值： MySQL为“async”或“semisync”。 PostgreSQL为“async”或“sync”。 Microsoft 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”，即包年/包月时该字段生效。

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

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

• 异常响应

  请参见异常请求结果。

状态码

请参见状态码。

错误码

请参见错误码。