创建数据库实例（v5接口）

功能介绍

该接口由“创建数据库实例（v3）”接口派生而来，接口请求体新增了“subscription_agency”字段，该字段用于使用RAM共享密钥创建包周期RDS实例的场景。该接口用于创建RDS实例，可分为单实例、HA实例和只读副本。

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

本接口仅支持AK/SK认证。本接口支持在HTTP请求消息头中设置X-Client-Token请求头，保证请求幂等性。详细信息请参考请求幂等性说明。

调试

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

URI

• URI格式

  POST /v5/{project_id}/instances

• 参数说明

  表1 参数说明

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

请求消息

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

• URI样例

  POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances

• 请求样例

  使用RAM共享密钥创建包周期MySQL单机实例：

  {
  	"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",
  	"subscription_agency": "xxx::xxxxx:xx:xxxx",
  	"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": "prePaid",
                  "period_type": "year",
                  "period_num": 1
          },
  	"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
  }

  使用RAM共享密钥创建包周期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",
          "subscription_agency": "xxx::xxxxx:xx:xxxx",
  	"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": "prePaid",
                  "period_type": "year",
                  "period_num": 1
  	},
  	"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"
  		}
  	]
  }

  使用RAM共享密钥创建包周期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",
          "subscription_agency": "xxx::xxxxx:xx:xxxx",
  	"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": "prePaid",
                  "period_type": "year",
                  "period_num": 1
  	},
          "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用户使用RAM共享密钥创建包周期MySQL单机实例：

  {
  	"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",
          "subscription_agency": "xxx::xxxxx:xx:xxxx",
  	"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": "prePaid",
                  "period_type": "year",
                  "period_num": 1
  	},
  	"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
  }

  使用RAM共享密钥创建包周期MySQL主备实例：

  {
  	"name": "rds-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",
          "subscription_agency": "xxx::xxxxx:xx:xxxx",
  	"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.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": "prePaid",
                  "period_type": "year",
                  "period_num": 1
  	},
  	"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用户使用RAM共享密钥创建包周期MySQL主备实例：

  {
  	"name": "rds-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",
          "subscription_agency": "xxx::xxxxx:xx:xxxx",
          "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.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": "prePaid",
                  "period_type": "year",
                  "period_num": 1
  	},
  	"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
  }

  使用RAM共享密钥创建包周期MySQL只读实例：

  {
  	"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",
  	"subscription_agency": "xxx::xxxxx:xx:xxxx",
          "region": "cn-north-4",
  	"availability_zone": "cn-north-4a",
  
          "charge_info": {
  		"charge_mode": "prePaid",
                  "period_type": "year",
                  "period_num": 1
  	},
  	"enterprise_project_id": "fdsa-3rds",
  	"tags": [
  		{
  			"key": "key1",
  			"value": "value1"
  		},
  		{
  			"key": "key2",
  			"value": "value2"
  		}
  	]
  }

响应消息

• 正常响应要素说明

  表13 要素说明

  名称	参数类型	说明
  instance	Object	实例信息。 详情请参见表14。
  job_id	String	实例创建的任务id。 查询详细任务信息请参见获取指定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，仅当您创建实例选择该参数时才可见，默认为空。
  flavor_ref	String	规格码，取值范围：非空。 使用可参考查询数据库规格响应消息表3中的“spec_code”。
  volume	Object	volume信息。 详情请参见表18。
  region	String	区域ID。
  availability_zone	String	可用区ID。
  vpc_id	String	虚拟私有云ID。
  subnet_id	String	子网的网络ID信息。
  security_group_id	String	指定实例所属的安全组。
  charge_info	Object	计费方式信息，支持包年/包月和按需。 详情请参见表19。
  collation	String	RDS for SQL Server设定的字符集信息。
  restore_point	Object	恢复数据源对象。恢复到新实例时必选。 详情请参见表20。

  表15 datastore字段数据结构说明

  名称	参数类型	说明
  type	String	数据库引擎，返回值如下： MySQL PostgreSQL SQLServer
  version	String	数据库版本。 数据库支持的详细版本信息，可调用查询数据库引擎的版本接口获取。
  complete_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，表示SSD。 LOCALSSD，表示本地SSD。 CLOUDSSD，表示SSD云盘，仅支持通用型和独享型规格实例。 ESSD，表示极速型SSD。
  size	Integer	磁盘大小。 取值范围：40GB~4000GB。必须为10的整数倍。

  表19 chargeInfo字段数据结构说明

  名称	参数类型	说明
  charge_mode	String	创建类型，支持包年/包月和按需。
  period_type	String	订购周期类型。 month：包月 year：包年
  period_num	Integer	订购周期长度，按月计算。 “charge_mode”为“prePaid”，即包年/包月时该字段生效。
  is_auto_pay	Boolean	创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 false：手动支付，默认该方式。 true：自动支付。
  is_auto_renew	Boolean	创建包周期实例时指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 false：不自动续订，默认该方式。 true：自动续订。

  表20 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.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": "prePaid",
                          "period_type": "year",
                          "period_num": 1
  		},
  	},
  	"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": "prePaid",
                          "period_type": "year",
                          "period_num": 1
  		},
                 "collation": "Cyrillic_General_CI_AS" 
  	},
  	"job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d"
  }

  MySQL主备实例：

  {
    "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": "prePaid",
                  "period_type": "year",
                  "period_num": 1
  	   },
           },
    "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" 
  }

  MySQL只读实例：

  {
    "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",
             "charge_info": {
  		"charge_mode": "prePaid",
                  "period_type": "year",
                  "period_num": 1
  	   },
             "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"  
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  202

• 异常

  请参见状态码。

错误码

请参见错误码。

获取委托URN

1. 打开统一身份认证服务（IAM）管理控制台。
   图1 IAM页面
   
2. 选择“委托 > 创建委托”。
3. 在创建委托页面，填选如下内容，单击“下一步”。
   • 委托名称：例如agency_billing
   • 委托类型：云服务
   • 云服务：Billing
   • 持续时间：永久
   • 描述：委托的描述
   图2 创建委托
   
4. 搜索框输入“fulfillment”进行搜索，勾选“ServicePolicyForRDSFulfillment”，单击“下一步”。
   图3 选择策略
   
5. 默认授权所有资源，单击“确定”，完成委托创建。
   图4 选择授权范围
   
6. 单击创建完成的委托名称，在基本信息页，获取委托URN。
   图5 获取URN