请求消息
MySQL 8. 0创建单实例指定初始化参数：
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",
"password": "Test@12345678",
"configuration_id": "452408-ef4b-44c5-94be-305145fg"
"enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00",
"tags": [
"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",
"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": [
{ "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",
"password": "Test@12345678",
"configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds",
"time_zone": "UTC+04:00",
"dsspool_id":"3278327382738217382173872183721837213", "tags": [
{ "name": "rds-instance-rep2", "datastore": {
"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",
"password": "Test@12345678",
"configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds",
"time_zone": "UTC+04:00",
"tags": [
{ "name": "rds-instance-rep2", "datastore": {
"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",
"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": [
"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": [
{ "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": [
表4-30 要素说明
名称 参数类型 说明
instance Object 实例信息。
详情请参见表4-31。
job_id String 实例创建的任务id。
查询详细任务信息请参见获取指定ID的 任务信息。
仅创建按需实例时会返回该参数。
order_id String 订单号，创建包年包月时返回该参数。
表4-31 instance 说明
名称 参数类型 说明
id String 实例ID，批量创建实例时，该字段为
空。
name String 实例名称。用于表示实例的名称，同一
租户下，同类型的实例名称可相同。
取值范围：
支持的字符长度是4~64个字节，必须 以字母或中文开头，区分大小写，可以 包含字母、数字、中文字符（一个中文 字符占用3个字节）、中划线或者下划 线，不能包含其他的特殊字符。
status String 实例状态。如BUILD，表示创建中。
仅创建按需实例时会返回该参数。
datastore Object 数据库信息。
详情请参见表4-32。
ha Object HA配置参数，仅当您选择创建HA实例
时该参数才可见。
详情请参见表4-33。
configuration_id String 参数模板ID，仅当您创建实例指定用户 自定义参数组时，该参数才可见。
port String 数据库端口信息，与请求参数相同。
backup_strategy Object 自动备份策略。
详情请参见表4-34。
enterprise_project
_id String 项目标签。
名称 参数类型 说明
disk_encryption_id String 用于磁盘加密的密钥ID，仅当您创建实 例选择该参数时才可见，默认为空。
flavor_ref String 规格码，取值范围：非空。
使用可参考查询数据库规格响应消息表 4-13中的“spec_code”。
volume Object volume信息。
详情请参见表4-35。
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 计费方式信息，支持包年/包月和按 需。
详情请参见表4-36。
collation String Microsoft SQL Server设定的字符集信 息。
restore_point Object 恢复数据源对象。恢复到新实例时必 选。
详情请参见表4-37。
表4-32 datastore 字段数据结构说明
名称 参数类型 说明
type String 数据库引擎，返回值如下：
● MySQL
● PostgreSQL
● SQLServer version String 数据库版本。
数据库支持的详细版本信息，可调用查询 数据库引擎的版本接口获取。
表4-33 ha 字段数据结构说明
名称 参数类型 说明
mode String 实例主备模式，取值：Ha。
replication_
mode String 备机同步参数。实例为Ha模式时有效。
取值：
● MySQL为“async”或“semisync”。
● PostgreSQL为“async”或“sync”。
● Microsoft SQL Server为“sync”。
说明
● “async”为异步模式。
● “semisync”为半同步模式。
● “sync”为同步模式。
表4-34 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”。
表4-35 volume 字段数据结构说明
名称 参数类型 说明
type String 磁盘类型。
取值范围如下，区分大小写：
● ULTRAHIGH，表示SSD。
● LOCALSSD，表示本地SSD。
● CLOUDSSD，表示SSD云盘，仅支持 通用型和独享型规格实例。
● ESSD，表示极速型SSD。
size Integer 磁盘大小。
取值范围：40GB~4000GB。必须为10的 整数倍。
表4-36 chargeInfo 字段数据结构说明
名称 参数类型 说明
charge_mode String 创建类型，支持包年/包月和按需。
period_num Integer 订购周期长度，按月计算。
“charge_mode”为“prePaid”，即包 年/包月时该字段生效。
表4-37 restore_point 字段数据结构说明
参数 参数类型 描述
instance_id String 源实例ID。
type String 恢复方式。
● “backup”，表示使用备份文件恢复
● “timestamp”，表示按时间点恢复。
backup_id String 用于恢复的备份ID。
restore_time Integer 恢复数据的时间点，格式为UNIX时间戳，单位 是毫秒，时区为UTC。
database_na
me Map<String,S
tring> 仅适用于SQL Server引擎，当有此参数时表示 支持局部恢复和重命名恢复，恢复数据以局部
"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"
}
"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"
}
"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"
}
4.5.2 修改实例名称
功能介绍
修改指定数据库实例的名称。
● 调用接口前，您需要了解API 认证鉴权。
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
PUT /v3/{project_id}/instances/{instance_id}/name
● URI样例
https://rds.cn-north-1.myhuaweicloud.com/
v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/
5b409baece064984a1b3eef6addae50cin01/name
● 参数说明
表4-38 参数说明
名称 是否必选 说明
project_id 是 租户在某一region下的project ID。
获取方法请参见获取项目ID。
instance_id 是 实例ID。
请求消息
● 参数说明
表4-39 参数说明
名称 是否必选 参数类型 说明
name 是 String 实例名称。
用于表示实例的名称，同一租户 下，同类型的实例名可重名。取 值范围如下：
支持的字符长度是4~64个字节，
必须以字母或中文开头，区分大 小写，可以包含字母、数字、中 文字符（一个中文字符占用3个字 节）、中划线或者下划线，不能 包含其他的特殊字符。
● 请求样例
{ "name": "Test_2345674"
}
响应消息
● 正常响应要素说明 无。
● 正常响应样例 无。
● 异常响应
请参见异常请求结果。
状态码
● 正常 200
● 异常
请参见状态码。
错误码
请参见错误码。
4.5.3 修改实例备注
功能介绍
修改指定数据库实例的备注信息。
● 调用接口前，您需要了解API 认证鉴权。
调试
您可以在API Explorer中调试该接口。