华为云用户手册

  • 响应消息体(可选) 该部分可选。响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_code": "AS.0001", "error_msg": "The format of message is error" } 其中,“error_code”表示错误码,“error_msg”表示错误描述信息。
  • URI URI格式 GET /v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time} 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 String 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 backup_id 否 String 参数解释: 备份ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 backup_type 否 String 参数解释: 备份类型。 约束限制: 不涉及。 取值范围: “auto”:自动全量备份。 “manual”:手动全量备份。 “fragment”:差异全量备份。 “incremental”:自动增量备份。 默认取值: 不涉及。 status 否 String 参数解释: 备份状态。 约束限制: 不涉及。 取值范围: “BUILDING”:备份中。 “COMPLETED”:备份完成。 “FAILED”:备份失败。 默认取值: 不涉及。 offset 否 Integer 参数解释: 索引位置,偏移量。 约束限制: 不涉及。 取值范围: 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 默认取值: 0 limit 否 Integer 参数解释: 查询记录数。 约束限制: 不涉及。 取值范围: 默认为100,不能为负数,最小值为1,最大值为100。 默认取值: 100 begin_time 否 String 参数解释: 查询开始时间。 约束限制: “begin_time”有值时,“end_time”必选。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 默认取值: 不涉及。 end_time 否 String 参数解释: 查询结束时间。 约束限制: “end_time”有值时,“begin_time”必选。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 默认取值: 不涉及。
  • 请求示例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4in01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 backups Array of objects 参数解释: 备份列表。详情请参见表3。 total_count Integer 参数解释: 总记录数。 取值范围: 不涉及。 表3 backups字段数据结构说明 名称 参数类型 说明 id String 参数解释: 备份ID。 取值范围: 不涉及。 name String 参数解释: 备份名称。 取值范围: 不涉及。 type String 参数解释: 备份类型。 取值范围: “auto”:自动全量备份。 “manual”:手动全量备份。 “fragment”:差异全量备份。 “incremental”:自动增量备份。 size Long 参数解释: 备份大小,单位:KB。 取值范围: 不涉及。 status String 参数解释: 备份状态。 取值范围: BUILDING: 备份中。 COMPLETED: 备份完成。 FAILED:备份失败。 DELETING:备份删除中。 begin_time String 参数解释: 备份开始时间。 全量备份类型下,指备份开始时间。 MySQL增量备份类型,指备份文件中上一轮增备任务的最后一个事务的提交时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 end_time String 参数解释: 备份结束时间。 全量备份类型下,指备份结束时间。 MySQL增量备份类型,指备份文件中最后一个事务的提交时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”,其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 datastore Object 参数解释: 数据库版本信息。详情请参见表4。 instance_id String 参数解释: 备份所在实例ID。 取值范围: 不涉及。 associated_with_ddm Boolean 参数解释: 是否已被DDM实例关联。 取值范围: 不涉及。 表4 datastore字段数据结构说明 名称 参数类型 说明 type String 参数解释: 数据库引擎。 取值范围: MySQL version String 参数解释: 数据库版本。 取值范围: 5.7、8.0 正常响应样例 { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.7" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 } 异常响应 请参见异常请求结果。
  • 响应消息 正常响应要素说明 表9 要素说明 名称 参数类型 说明 instance Object 参数解释: 实例信息。详情请参见表10。 job_id String 参数解释: 实例创建的任务ID。仅按需实例时返回该参数。 取值范围: 不涉及。 表10 instance说明 名称 参数类型 说明 id String 参数解释: 实例ID。 取值范围: 不涉及。 name String 参数解释: 实例名称。用于表示实例的名称,同一租户下,同类型的实例名称可相同。 取值范围: 与请求参数值相同。 status String 参数解释: 实例状态。 取值范围: BUILD,表示创建中。 datastore Object 参数解释: 数据库信息。详情请参见表11。 ha Object 参数解释: HA配置参数,仅当您选择创建HA实例时该参数才可见。 详情请参见表12。 port String 参数解释: 数据库端口信息。 取值范围: 与请求参数值相同。 backup_strategy Object 参数解释: 自动备份策略。详情请参见表13。 flavor_ref String 参数解释: 规格ID。使用可参考查询数据库规格响应消息表3中的“spec_code”。 volume Object 参数解释: volume信息。详情请参见表14。 region String 参数解释: 区域ID。 取值范围: 与请求参数值相同。 availability_zone String 参数解释: 可用区ID。 取值范围: 与请求参数值相同。 vpc_id String 参数解释: 虚拟私有云ID。 取值范围: vpc-default-smb subnet_id String 参数解释: 子网的网络ID信息。 取值范围: subnet-default-smb security_group_id String 参数解释: 指定实例所属的安全组。 取值范围: sg-default-smb charge_info Object 参数解释: 计费方式信息。详情请参见表7。 表11 datastore字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 参数解释: 数据库引擎。 取值范围: MySQL version 是 String 参数解释: 数据库版本。 取值范围: 5.7、8.0 表12 ha字段数据结构说明 名称 是否必选 参数类型 说明 mode 是 String 参数解释: 实例主备模式。 取值范围: HA,不区分大小写。 replication_mode 是 String 参数解释: 备机同步参数。 取值范围: async:异步模式。 semisync:半同步模式。 表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 参数解释: 磁盘类型。 取值范围: CLOUDSSD:区分大小写,表示SSD云盘,仅支持通用型和独享型规格实例。 size 是 Integer 参数解释: 磁盘大小。 取值范围: 40 GB~4000 GB,必须为10的整数倍。 响应样例中参数“region”和“availability_zone”的值为示例值。 正常响应样例 恢复FlexusRDS备份文件到新实例 { "instance": { "id": "f5ffdd8b1c98434385eb001904209eacin01", "name": "demoname", "status": "BUILD", "datastore": { "type": "MySQL", "version": "5.7.31" }, "port": "3306", "volume": { "type": "ULTRAHIGH", "size": "40" }, "region": "aaa", "backup_strategy": { "start_time": "02:00-03:00", "keep_days": "7" }, "flavor_ref": "rds.mysql.s1.large", "availability_zone": "bbb", "vpc_id": "19e5d45d-70fd-4a91-87e9-b27e71c9891f", "subnet_id": "bd51fb45-2dcb-4296-8783-8623bfe89bb7", "security_group_id": "23fd0cd4-15dc-4d65-bdb3-8844cc291be0" }, "job_id": "bf003379-afea-4aa5-aa83-4543542070bc" } 异常响应 请参见异常请求结果。
  • 请求示例 将FlexusRDS备份文件恢复到新实例。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances { "name": "targetInst", "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "async" }, "flavor_ref": "rds.mysql.y1.xlarge.2.ha", "volume": { "type": "CLOUDSSD", "size": 40 }, "region": "aaa", "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "password": "Demo@12345678", "time_zone": "UTC+04:00", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" } } 将FlexusRDS实例的数据恢复到指定时间点。 { "name": "targetInst", "availability_zone": "bbb,ccc", "ha": { "mode": "ha", "replication_mode": "async" }, "flavor_ref": "rds.mysql.y1.xlarge.2.ha", "volume": { "type": "CLOUDSSD", "size": 40 }, "backup_strategy": { "keep_days": 2, "start_time": "19:00-20:00" }, "password": "Demo@12345678", "time_zone": "UTC+04:00", "restore_point": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "timestamp", "restore_time": 1532001446987 } }
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 参数解释: 实例名称。 约束限制: 同一租户下,同类型的实例名可重名。 取值范围: 实例名称长度最小为4字符,最大为64个字符,如果名称包含中文,则不超过64字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线、英文句号或中文,不能包含其他特殊字符。 默认取值: 不涉及。 password 否 String 参数解释: 数据库密码。 约束限制: 建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。如果您提供的密码被系统视为弱密码,您将收到错误提示,请提供更高强度的密码。 取值范围: 数据库支持的密码长度是8~32个字符,至少包含大写字母、小写字母、数字、特殊字符三种字符的组合。允许输入~!@#$%^*-_=+?,()&特殊字符。 默认取值: 不涉及。 flavor_ref 是 String 参数解释: 规格码。 约束限制: 不涉及。 取值范围: 非空。参考查询数据库规格响应消息表3中的“spec_code”获取。 默认取值: 不涉及。 volume 是 Object 参数解释: 实例存储信息。详情请参见表5。 约束限制: 不涉及。 availability_zone 是 String 参数解释: 可用区ID。 约束限制: 对于数据库实例类型不是单机的实例,需要分别为实例所有节点指定可用区,并用逗号隔开。 取值范围: 非空,请参见地区和终端节点。 默认取值: 不涉及。 restore_point 是 Object 参数解释: 恢复数据源对象。详情请参见表6。 约束限制: 不涉及。 ha 否 Object 参数解释: HA配置参数,详情请参见表3。 约束限制: 仅创建主备实例时使用。 port 否 String 参数解释: 数据库端口信息。 约束限制: 不涉及。 取值范围: 不传该参数时,默认3306。 传入该参数时,取值1024~65535(其中12017和33071被RDS系统占用不可设置)。 默认取值: 3306 backup_strategy 否 Object 参数解释: 高级备份策略。详情请参见表4。 约束限制: 不涉及。 region 否 String 参数解释: 区域ID。 约束限制: 不涉及。 取值范围: 非空,请参见地区和终端节点。 默认取值: 不涉及。 charge_info 是 Object 参数解释: 包周期计费类型。详情请参见表7。 约束限制: 不涉及。 time_zone 否 String 参数解释: UTC时区。 约束限制: 不涉及。 取值范围: 不传该参数,默认为UTC时间。 传入该参数,取值范围为UTC-12:00~UTC+12:00,且只支持整段时间,如UTC+08:00,不支持UTC+08:30。 默认取值: UTC+08:00 tags 否 Array of objects 参数解释: 标签列表,根据标签键值对创建实例。 详情请参见表8。 约束限制: 如果创建实例时同时使用多个标签键值对,中间使用逗号分隔开,最多包含20组。 is_flexus 是 boolean 参数解释: 创建FlexusRDS实例。 约束限制: 不涉及。 取值范围: true 默认取值: 不涉及。 表3 ha字段数据结构说明 名称 是否必选 参数类型 说明 mode 是 String 参数解释: 实例主备模式。 约束限制: 不涉及。 取值范围: HA,不区分大小写。 默认取值: 不涉及。 replication_mode 是 String 参数解释: 备机同步参数。 约束限制: 不涉及。 取值范围: async:异步模式。 semisync:半同步模式。 默认取值: 不涉及。 表4 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 参数解释: 指定备份文件的可保存天数。 约束限制: 不涉及。 取值范围: 不传该参数,默认7天。 传入该参数,0~732。取值为0,表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请,自动备份最长可以保留2562天。 默认取值: 7 表5 volume字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 参数解释: 磁盘类型。 约束限制: 不涉及。 取值范围: CLOUDSSD:区分大小写,表示SSD云盘,仅支持通用型和独享型规格实例。 默认取值: 不涉及。 size 是 Integer 参数解释: 磁盘大小。 约束限制: 新实例磁盘大小必须大于或等于原实例的磁盘大小。 取值范围: 40 GB~4000 GB,必须为10的整数倍。 默认取值: 不涉及。 表6 restore_point字段数据结构说明 名称 是否必选 参数类型 说明 instance_id 是 String 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 type 是 String 参数解释: 恢复方式。 约束限制: 不涉及。 取值范围: “backup”,表示使用备份文件恢复,按照此方式恢复时,当“type”字段为非必选时,“backup_id”必选。 “timestamp”,表示按时间点恢复,按照此方式恢复时,当“type”字段必选时,“restore_time”必选。 默认取值: 不涉及。 backup_id 否 String 参数解释: 用于恢复的备份ID。当使用备份文件恢复时需要指定该参数。 约束限制: 当“type”字段为非必选时,“backup_id”必选。 取值范围: 不涉及。 默认取值: 不涉及。 restore_time 否 Integer 参数解释: 恢复数据的时间点,格式为UNIX时间戳,单位是毫秒,时区为UTC。 约束限制: 当“type”字段必选时,“restore_time”必选。 取值范围: 不涉及。 默认取值: 不涉及。 表7 charge_info字段数据结构说明 名称 是否必选 参数类型 说明 charge_mode 是 String 参数解释: 计费模式。 约束限制: 不涉及。 取值范围: prePaid:预付费,即包年/包月。 默认取值: 不涉及。 period_type 是 String 参数解释: 订购周期类型。 约束限制: 不涉及。 取值范围: month:包月。 year:包年。 默认取值: 不涉及。 period_num 否 Integer 参数解释: 订购时长。 约束限制: 不涉及。 取值范围: 当“period_type”为“month”时,取值为1~9。 当“period_type”为“year”时,取值为1~3。 默认取值: 不涉及。 is_auto_renew 否 boolean 参数解释: 包周期实例是否自动续订,续订的周期和原周期相同,且续订时会自动支付。 约束限制: 不涉及。 取值范围: true,为自动续订。 false,为不自动续订,默认该方式。 默认取值: false is_auto_pay 否 boolean 参数解释: 是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 约束限制: 不涉及。 取值范围: true,为自动支付。 false,为手动支付,默认该方式。 默认取值: false 表8 tags字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 参数解释: 标签键。 约束限制: 不涉及。 取值范围: 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 默认取值: 不涉及。 value 是 String 参数解释: 标签值。 约束限制: 不涉及。 取值范围: 最大长度255个unicode字符,可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。 默认取值: 不涉及。
  • URI URI格式 GET /v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&is_flexus={is_flexus} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 database_name 是 参数解释: 数据库引擎。 约束限制: 不涉及。 取值范围: MySQL,不区分大小写。 默认取值: 不涉及。 version_name 否 参数解释: 数据库版本号,可输入小版本号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 is_flexus 是 参数解释: 是否查询FlexusRDS实例规格。 约束限制: 不涉及。 取值范围: true:查询FlexusRDS规格。 false:查询非FlexusRDS规格。默认值false。 默认取值: false spec_code 否 参数解释: 规格编码。 约束限制: 不涉及。 取值范围: 单机实例: rds.mysql.y1.medium.2 rds.mysql.y1.large.2 rds.mysql.y1.large.4 rds.mysql.y1.xlarge.2 rds.mysql.y1.xlarge.4 主备实例: rds.mysql.y1.large.2.ha rds.mysql.y1.large.4.ha rds.mysql.y1.xlarge.2.ha rds.mysql.y1.xlarge.4.ha 默认取值: 不涉及。
  • 状态码 状态码如表1所示: 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 200 OK 请求成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 203 Non-Authoritative Information 非授权信息,请求成功。 204 NoContent 请求完全成功,同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容,服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置,相应可返回一个资源特征与地址的列表用于用户终端(例如:浏览器)选择。 301 Moved Permanently 永久移动,请求的资源已被永久的移动到新的URI,返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改,服务器返回此状态码时,不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码,表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长(URI通常为网址),服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确,但是由于含有语义错误,无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部,然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 502 Bad Gateway 充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时(Timeout)参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本,无法完成处理。 父主题: 附录
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 restore_time Array of objects 参数解释: 可恢复时间段列表。详情请参见表3。 表3 restore_time字段数据结构说明 名称 参数类型 说明 start_time Integer 参数解释: 可恢复时间段的起始时间点,UNIX时间戳格式,单位是毫秒,时区是UTC。 取值范围: 不涉及。 end_time Integer 参数解释: 可恢复时间段的结束时间点,UNIX时间戳格式,单位是毫秒,时区是UTC。 取值范围: 不涉及。 正常响应样例 { "restore_time": [ { "start_time": 1532001446987, "end_time": 1532742139000 } ] } 异常响应 请参见异常请求结果。
  • 请求消息 请求参数 无。 URI样例 查询实例的所有可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/restore-time 根据指定日期查询实例的可恢复时间段 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/restore-time?date=2020-12-26
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/restore-time?date=2020-12-26 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 String 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 date 否 String 参数解释: 所需查询的日期,为yyyy-mm-dd字符串格式,时区为UTC。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从地区和终端节点获取。 scope参数定义了Token的作用域,上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK 认证方式的接口请求或者多project场景采用AK/SK认证的接口请求则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如 IAM 服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • API概览 通过使用FlexusRDS接口,您可以进行创建实例、备份恢复、修改参数等操作。 类型 子类型 说明 RDS 接口 v3 查询数据库规格 获取指定数据库引擎版本对应的规格信息。 RDS 接口 v3 实例管理 包括创建实例、调整实例规格、重启实例、获取实例列表、获取指定实例详细信息等接口。 RDS 接口 v3 备份与恢复 包括创建手动备份、删除手动备份、恢复到新实例等接口。 RDS 接口 v3 参数管理 包括修改参数、获取参数模板接口。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/configurations 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 String 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 datastore_version_name String 参数解释: 数据库版本名称。 取值范围: 不涉及。 datastore_name String 参数解释: 数据库名称。 取值范围: 不涉及。 created String 参数解释: 创建时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 取值范围: 不涉及。 updated String 参数解释: 更新时间,格式为"yyyy-MM-ddTHH:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 取值范围: 不涉及。 configuration_parameters Array of objects 参数解释: 参数对象,用户基于默认参数模板自定义的参数配置。 详情请参见表3。 表3 configuration_parameters字段数据结构说明 名称 参数类型 说明 name String 参数解释: 参数名称。 取值范围: 不涉及。 value String 参数解释: 参数值。 取值范围: 不涉及。 restart_required Boolean 参数解释: 是否需要重启。 取值范围: “false”表示否。 “true”表示是。 readonly Boolean 参数解释: 是否只读。 取值范围: “false”表示否。 “true”表示是。 value_range String 参数解释: 参数值范围。 取值范围: 如Integer取值0-1、Boolean取值true或者false等。 type String 参数解释: 参数类型。 取值范围: 取值为“string”、“integer”、“boolean”、“list”或“float”之一。 description String 参数解释: 参数描述。 取值范围: 不涉及。 正常响应样例 { "datastore_version_name": "5.7", "datastore_name": "mysql", "created": "2018-10-11 11:40:44", "updated": "2018-10-11 11:40:44", "configuration_parameters": [{ "name": "auto_increment_increment", "value": "1", "restart_required": false, "readonly": false, "value_range": "1-65535", "type": "integer", "description": "auto_increment_increment和auto_increment_offset 用于master-to-master的复制,并可以用来控制AUTO_INCREMENT列的操作。" }] } 异常响应 请参见异常请求结果。
  • 响应消息 正常响应要素说明 表9 要素说明 名称 参数类型 说明 instance Object 参数解释: 实例信息。详情请参见表10。 order_id String 参数解释: 订单号。 取值范围: 不涉及。 表10 instance说明 名称 参数类型 说明 id String 参数解释: 实例ID。 取值范围: 不涉及。 name String 参数解释: 实例名称。用于表示实例的名称,同一租户下,同类型的实例名称可相同。 取值范围: 与请求参数值相同。 status String 参数解释: 实例状态。 取值范围: BUILD,表示创建中。 datastore Object 参数解释: 数据库信息。详情请参见表11。 ha Object 参数解释: HA配置参数,仅当您选择创建HA实例时该参数才可见。 详情请参见表12。 port String 参数解释: 数据库端口信息。 取值范围: 与请求参数值相同。 backup_strategy Object 参数解释: 自动备份策略。详情请参见表13。 flavor_ref String 参数解释: 规格码。 取值范围: 与请求参数值相同。 volume Object 参数解释: volume信息。详情请参见表14。 region String 参数解释: 区域ID。 取值范围: 与请求参数值相同。 availability_zone String 参数解释: 可用区ID。 取值范围: 与请求参数值相同。 vpc_id String 参数解释: 虚拟私有云ID。 取值范围: vpc-default-smb subnet_id String 参数解释: 子网的网络ID信息。 取值范围: subnet-default-smb security_group_id String 参数解释: 指定实例所属的安全组。 取值范围: sg-default-smb charge_info Object 参数解释: 计费方式信息。详情请参见表15。 表11 datastore字段数据结构说明 名称 参数类型 说明 type String 参数解释: 数据库引擎。 取值范围: MySQL version String 参数解释: 数据库版本。 取值范围: 5.7、8.0 表12 ha字段数据结构说明 名称 参数类型 说明 mode String 参数解释: 实例主备模式。 取值范围: HA,不区分大小写。 replication_mode String 参数解释: 备机同步参数。 取值范围: async:异步模式。 semisync:半同步模式。 表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 参数解释: 磁盘类型。 取值范围: CLOUDSSD:区分大小写,表示SSD云盘,仅支持通用型和独享型规格实例。 size Integer 参数解释: 磁盘大小。 取值范围: 40 GB~4000 GB,必须为10的整数倍。 表15 chargeInfo字段数据结构说明 名称 参数类型 说明 charge_mode String 参数解释: 计费模式。 取值范围: prePaid:预付费,即包年/包月。 period_num Integer 参数解释: 订购时长。 取值范围: 与请求参数值相同。 响应样例中参数“region”和“availability_zone”的值为示例值。 正常响应样例 创建FlexusRDS单机实例下发成功。 { "instance": { "id": "dsfae23fsfdsae3435in01", "name": "flexusrds-instance", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.y1.large.2", "volume": { "type": "CLOUDSSD", "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": "3306", "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 3 }, "charge_info": { "charge_mode": "postPaid" } }, "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" } 创建FlexusRDS主备实例下发成功。 { "instance":{ "id": "dsfae23fsfdsae3435in01", "name": "flexusrds-instance-ha", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "ha", "replication_mode": "semisync" }, "flavor_ref": "rds.mysql.y1.xlarge.2.ha", "volume": { "type": "CLOUDSSD", "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": "3306", "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 3 }, "charge_info": { "charge_mode": "postPaid" }, }, "job_id": "dff1d289-4d03-4942-8b9f-463ea07c000d" } 异常响应 请参见异常请求结果。
  • 请求示例 请求样例中参数“region”和“availability_zone”的值为示例值。 创建FlexusRDS单机实例。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances { "name": "flexusrds-instance", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.y1.large.2", "volume": { "type": "CLOUDSSD", "size": 100 }, "region": "aaa", "availability_zone": "bbb", "port": 3306, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "prePaid" }, "password": "****", "time_zone": "UTC+04:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "is_flexus": true } 创建FlexusRDS主备实例。 { "name": "flexusrds-instance-ha", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "ha", "replication_mode": "semisync" }, "flavor_ref": "rds.mysql.y1.xlarge.2.ha", "volume": { "type": "CLOUDSSD", "size": 100 }, "region": "aaa", "availability_zone": "bbb", "port": 3306, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "prePaid" }, "password": "****", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "is_flexus": true }
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 参数解释: 实例名称。 约束限制: 同一租户下,同类型的实例名可重名。 取值范围: 实例名称长度最小为4字符,最大为64个字符,如果名称包含中文,则不超过64字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线、英文句号或中文,不能包含其他特殊字符。 默认取值: 不涉及。 datastore 是 Object 参数解释: 数据库信息。 详情请参见表3。 约束限制: 不涉及。 flavor_ref 是 String 参数解释: 规格码。 约束限制: 不涉及。 取值范围: 非空。参考查询数据库规格响应消息表3中的“spec_code”获取。 默认取值: 不涉及。 volume 是 Object 参数解释: 实例存储信息。详情请参见表6。 约束限制: 不涉及。 region 是 String 参数解释: 区域ID。 约束限制: 不涉及。 取值范围: 非空,请参见地区和终端节点。 默认取值: 不涉及。 availability_zone 是 String 参数解释: 可用区ID。 约束限制: 对于数据库实例类型不是单机的实例,需要分别为实例所有节点指定可用区,并用逗号隔开。 取值范围: 非空,请参见地区和终端节点。 默认取值: 不涉及。 ha 否 Object 参数解释: HA配置参数,详情请参见表4。 约束限制: 仅创建主备实例时使用。 port 否 String 参数解释: 数据库端口信息。 约束限制: 不涉及。 取值范围: 不传该参数时,默认3306。 传入该参数时,取值1024~65535(其中12017和33071被RDS系统占用不可设置)。 默认取值: 3306 password 否 String 参数解释: 数据库密码。 约束限制: 建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。如果您提供的密码被系统视为弱密码,您将收到错误提示,请提供更高强度的密码。 取值范围: 数据库支持的密码长度是8~32个字符,至少包含大写字母、小写字母、数字、特殊字符三种字符的组合。允许输入~!@#$%^*-_=+?,()&特殊字符。 默认取值: 不涉及。 backup_strategy 否 Object 参数解释: 高级备份策略。详情请参见表5。 约束限制: 不涉及。 charge_info 是 Object 参数解释: 包周期计费类型。详情请参见表7。 约束限制: 不涉及。 time_zone 否 String 参数解释: UTC时区。 约束限制: 不涉及。 取值范围: 不传该参数,默认为UTC时间。 传入该参数,取值范围为UTC-12:00~UTC+12:00,且只支持整段时间,如UTC+08:00,不支持UTC+08:30。 默认取值: UTC+08:00 tags 否 Array of objects 参数解释: 标签列表,根据标签键值对创建实例。 详情请参见 表8。 约束限制: 如果创建实例时同时使用多个标签键值对,中间使用逗号分隔开,最多包含20组。 is_flexus 是 boolean 参数解释: 创建FlexusRDS实例。 约束限制: 不涉及。 取值范围: true 默认取值: 不涉及。 表3 datastore字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 参数解释: 数据库引擎。 约束限制: 不涉及。 取值范围: MySQL 默认取值: 不涉及。 version 是 String 参数解释: 数据库版本。 约束限制: 不涉及。 取值范围: 5.7、8.0 默认取值: 不涉及。 表4 ha字段数据结构说明 名称 是否必选 参数类型 说明 mode 是 String 参数解释: 实例主备模式。 约束限制: 不涉及。 取值范围: HA,不区分大小写。 默认取值: 不涉及。 replication_mode 是 String 参数解释: 备机同步参数。 约束限制: 不涉及。 取值范围: async:异步模式。 semisync:半同步模式。 默认取值: 不涉及。 表5 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 参数解释: 指定备份文件的可保存天数。 约束限制: 不涉及。 取值范围: 不传该参数,默认7天。 传入该参数,0~732。取值为0,表示关闭自动备份策略。如果需要延长保留时间请联系客服人员申请,自动备份最长可以保留2562天。 默认取值: 7 表6 volume字段数据结构说明 名称 是否必选 参数类型 说明 type 是 String 参数解释: 磁盘类型。 约束限制: 不涉及。 取值范围: CLOUDSSD:区分大小写,表示SSD云盘,仅支持通用型和独享型规格实例。 默认取值: 不涉及。 size 是 Integer 参数解释: 磁盘大小。 约束限制: 不涉及。 取值范围: 40 GB~4000 GB,必须为10的整数倍。 默认取值: 不涉及。 表7 charge_info字段数据结构说明 名称 是否必选 参数类型 说明 charge_mode 是 String 参数解释: 计费模式。 约束限制: 不涉及。 取值范围: prePaid:预付费,即包年/包月。 默认取值: 不涉及。 period_type 是 String 参数解释: 订购周期类型。 约束限制: 不涉及。 取值范围: month:包月。 year:包年。 默认取值: 不涉及。 period_num 是 Integer 参数解释: 订购时长。 约束限制: 不涉及。 取值范围: 当“period_type”为“month”时,取值为1~9。 当“period_type”为“year”时,取值为1~3。 默认取值: 不涉及。 is_auto_renew 否 boolean 参数解释: 包周期实例是否自动续订,续订的周期和原周期相同,且续订时会自动支付。 约束限制: 不涉及。 取值范围: true,为自动续订。 false,为不自动续订,默认该方式。 默认取值: false is_auto_pay 否 boolean 参数解释: 是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。 约束限制: 不涉及。 取值范围: true,为自动支付。 false,为手动支付,默认该方式。 默认取值: false 表8 tags字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 参数解释: 标签键。 约束限制: 不涉及。 取值范围: 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 默认取值: 不涉及。 value 是 String 参数解释: 标签值。 约束限制: 不涉及。 取值范围: 最大长度255个unicode字符,可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。 默认取值: 不涉及。
  • 基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 父主题: 使用前必读
  • URI URI格式 DELETE /v3/{project_id}/backups/{backup_id} 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 backup_id 是 String 参数解释: 备份ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 table_limit Integer 参数解释: 恢复表数量限制个数。 取值范围: 不涉及。 instances Array of objects 参数解释: 实例信息。详细说明请参见表4。 表4 instances字段数据结构说明 参数 参数类型 描述 id String 参数解释: 实例ID。 取值范围: 不涉及。 name String 参数解释: 实例名称。 取值范围: 不涉及。 total_tables Integer 参数解释: 可恢复表的数量。 取值范围: 不涉及。 databases Array of objects 参数解释: 数据库信息。详细说明请参见表5。 表5 database字段数据结构说明 参数 参数类型 描述 name String 参数解释: 模式名。 取值范围: 不涉及。 total_tables Integer 参数解释: 可恢复表的数量。 取值范围: 不涉及。 tables Array of objects 参数解释: 表信息。详细说明请参见表6。 表6 tables字段数据结构说明 参数 参数类型 描述 name String 参数解释: 表名。 取值范围: 不涉及。 正常响应样例 { "instances": [ { "id": "e38d120bb5a640519fb2a1613140afd9in01", "name": "rds-abc", "total_tables": 1, "databases": [ { "name": "test", "total_tables": 1, "tables": [ { "name": "t1" } ] } ] } ], "table_limit": 2000 } 异常响应 请参见异常请求结果。
  • 请求消息 参数说明 表2 参数说明 名称 是否必选 参数类型 说明 instance_ids 是 Array of strings 参数解释: 实例ID集合。 约束限制: 不涉及。 restore_time 是 Long 参数解释: 恢复时间点。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 database_name_like 否 String 参数解释: 数据库名,模糊查询。 约束限制: 不涉及。 取值范围: 支持的字符长度是1~64个字节,可以包含字母、数字、$、中划线、点或者下划线,不能包含其他的特殊字符。 默认取值: 不涉及。 table_name_like 否 String 参数解释: 数据库表名,模糊查询。 约束限制: 不涉及。 取值范围: 不能包含'、"、\、/、四种字符。 默认取值: 不涉及。 instance_name_like 否 String 参数解释: 实例名称,模糊查询。 约束限制: 不涉及。 取值范围: 支持的字符长度是1~64个字节,可以包含字母、数字、中文字符(一个中文字符占用3个字节)、中划线、点或者下划线,不能包含其他的特殊字符。 默认取值: 不涉及。 请求样例 POST https://{Endpoint}/v3/4879de6859e345c780f1a22d8bc6f229/mysql/instances/history/tables { "instance_ids" : [ "e38d120bb5a640519fb2a1613140afd9in01" ], "restore_time" : 1688554112000, "database_name_like" : "", "table_name_like" : "", "instance_name_like" : "" }
  • URI URI格式 POST /v3/{project_id}/{engine}/instances/history/tables 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 engine 是 String 参数解释: 数据库引擎。 约束限制: 不涉及。 取值范围: 不区分大小写:mysql 默认取值: 不涉及。
  • URI URI格式 POST /v3/{project_id}/instances/{instance_id}/db-upgrade 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 String 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 调用说明 Flexus云数据库RDS提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 同时还提供多种编程语言的SDK供您使用,SDK的使用方法请参见https://sdkcenter.developer.huaweicloud.com/。 调用API时有流控策略,用于限制单位时间内API的被调用次数。单位时间内API请求次数过多,可能会请求失败。 标准流控策略:单用户每分钟60次,API总流量每分钟8000次。 父主题: 使用前必读
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 switch_option 是 Boolean 参数解释: 是否开启自动扩容。 约束限制: 不涉及。 取值范围: true为开启。 false为关闭。 默认取值: 不涉及。 limit_size 否 Integer 参数解释: 扩容上限,单位GB。 约束限制: “switch_option”为true时,该参数必填。 取值范围: 40GB~4000GB,需要大于等于实例当前存储空间总大小。 默认取值: 不涉及。 trigger_threshold 否 Integer 参数解释: 可用存储空间百分比,小于等于此值或者为10GB时触发扩容。 约束限制: “switch_option”为true时,该参数必填。 取值范围: 枚举值: 10 15 20 默认取值: 不涉及。 step_percent 否 Integer 参数解释: 每次自动扩容的步长,单位为百分比,即每次自动扩容当前存储空间的百分比。 约束限制: “switch_option”为true,且开启了自定义扩容步长功能时,该参数可选,不填时默认为20%。 取值范围: 5%~50% 默认取值: 20%
共100000条