华为云用户手册

  • 配置步骤 登录CDN控制台。 在左侧菜单栏中,选择“域名管理”。 在域名列表中,单击需要修改的域名或域名所在行的“设置”,进入域名配置页面。 选择“高级配置”页签。 在自定义错误页面配置模块,单击“添加”,系统弹出“自定义错误页面配置”对话框。 图1 自定义错误页面配置 表1 参数说明 参数 描述 示例 错误码 需要自定义页面错误码。 404 重定向方式 将错误码页面重定向到新页面的方式,可选301或302重定向。 301 重定向的目标链接 自定义错误码跳转的新页面,必须以http://或https://开头。 https://example.com/error404.html 输入各项参数,单击“确定”,完成配置。
  • 注意事项 当客户端首次访问采用HTTP协议时,您可以通过使用强制跳转功能,将客户端请求协议重定向为HTTPS。 开启HSTS配置后,如果关闭HTTPS证书,请同时关闭HSTS配置。 开启HSTS且浏览器缓存Strict-Transport-Security头部后,如果您将强制跳转类型配置为HTTP,将会进入无限循环,导致域名无法访问,如下图所示: 后台有特殊配置的域名暂不支持自助开启HSTS,请提交工单处理。
  • 配置示例 加速域名www.example.com的HSTS配置如下: 配置效果: 客户端首次使用HTTPS协议访问加速域名,CDN节点将请求内容返回给客户端,同时响应“Strict-Transport-Security”头部。 如果客户端不支持HSTS功能,再次请求到CDN节点的协议遵从客户端发起请求的协议。 如果客户端支持HSTS功能,客户端将缓存“Strict-Transport-Security”头部。再次访问加速域名时,浏览器会自动将HTTP请求强制转换为HTTPS请求到CDN。 浏览器缓存时间超过设置的“过期时间”后,将再次按照1执行。
  • 示例说明 以使用MD5算法为例: 回源请求对象: http://hwcdn.example.com/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3 密钥设为:huaweicloud123(用户自行设置) 鉴权生效开始日期为:2017年6月30日10:00:00,计算出来的秒数为1498788000,并转换为十六进制为5955b0a0。并且设置有效时间为1800s。 CDN服务器构造一个用于计算md5hash的签名字符串: huaweicloud123/T128_2_1_0_sdk/0210/M00/82/3E/test.mp35955b0a0 CDN服务器根据该签名字符串计算md5hash: md5hash = md5sum(huaweicloud123/T128_2_1_0_sdk/0210/M00/82/3E/test.mp35955b0a0) = aecf1b07f481bbb8122eef5cd52a4bc1 请求CDN时URL: http://hwcdn.example.com/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3?auth_key=aecf1b07f481bbb8122eef5cd52a4bc1×tamp=5955b0a0 如果请求在有效时间内(2017年6月30日10:00:00-2017年6月30日10:30:00),并且计算出来的md5hash与用户请求中带的md5hash值(aecf1b07f481bbb8122eef5cd52a4bc1)一致,则鉴权通过。
  • 校验方法 CDN服务器拿到请求后,会按照如下步骤进行校验: 是否携带鉴权参数。如果没有携带鉴权参数,认为请求非法,返回HTTP 403错误。 时间校验:判断系统当前时间是否在区间[timestamp,timestamp+有效时间]内。超出该区间,认为过期失效并返回HTTP 403错误。 加密串校验:时间校验通过后,则以sstring方式构造出一个字符串(参考以下sstring构造方式)。然后使用md5(sha256)算法算出HashValue,并和用户请求中带来的md5hash(sha256)进行对比。结果一致则认为鉴权通过并返回文件,否则鉴权失败返回HTTP 403错误。HashValue计算方式如下: sstring = "PrivateKeyFilenameTimestamp" HashValue = md5sum(sstring) 或: sstring = "PrivateKeyFilenameTimestamp" HashValue = sha256sum(sstring)
  • 配置示例 加速域名“www.example.com”User-Agent黑白名单配置如下图所示: 当HTTP Request Header中User-Agent如下两种情况时: User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; Touch; rv:11.0) like Gecko user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36 命中黑名单,返回403状态码。
  • 支持复制的配置项 复制配置到新的域名时支持的配置项见下表: 表中支持复制的配置项为控制台可见配置。如果您请运维给原域名设置了特殊配置,该特殊配置将无法复制到新域名。若新域名需要该特殊配置,您可以提交工单申请。 表1 支持复制的配置项 配置大类 配置项 基本配置 企业项目(校验子账号是否有权限,子账号如果没有该企业项目的权限,域名将添加失败) 业务类型 服务范围 源站配置 复制源站配置时会复制存量域名的回源HOST,详情如下: 如果存量域名的源站类型是IP或域名,且配置了自定义回源HOST,新域名将复制该HOST。 如果存量域名的源站类型是IP或域名,且回源HOST是存量域名本身,新域名的回源HOST也将是新域名本身。 如果存量域名的源站类型是OBS桶域名,新域名的回源HOST与存量域名保持一致。 IPv6配置 回源配置 回源方式 回源SNI 回源URL改写 高级回源 Range回源 回源跟随 回源是否校验Etag 回源超时时间 回源请求头 缓存配置 缓存规则 浏览器缓存过期时间 状态码缓存时间 访问URL重写 访问控制 防盗链 IP黑白名单 User-Agent黑白名单 URL鉴权配置 远程鉴权配置 高级配置 HTTP header配置(跨域请求) 自定义错误页面 智能压缩 请求限速 用量封顶 WebSocket配置(原域名的业务类型是全站加速时会复制该配置项) 视频配置 视频拖拽 标签 标签
  • 注意事项 存量域名状态为已开启、已停用、审核未通过状态可以复制配置。 存量域名状态为删除中、配置中、审核中、配置失败不允许复制配置。 如果存量域名已被封禁,则不支持复制该域名的配置。 单次最多可添加10个新的域名,新域名会占用账号配额。 复制存量域名配置到新的域名时,支持复制的配置项请参见支持复制的配置项。 如果存量域名在后台有特殊配置项,这些不配置不支持配置,新域名将添加失败。 复制配置到新添加域名,不可复制存量域名的状态。 因HTTPS证书需要绑定域名,不支持复制HTTPS证书。 成功复制配置到新域名后,请检查新域名的各个配置项是否与业务匹配,避免因配置不合适而影响业务。
  • 背景信息 视频拖拽多应用于 视频点播 场景,当您观看视频需要随意拖拽播放进度且不影响观看效果时,您可以配置视频拖拽功能。 如果您配置了视频拖拽,在观看视频时拖拽播放进度时,客户端会向服务器发起类似如下请求: http://www.example.com/test.flv?start=50 此时将返回从第50字节开始的数据。如果CDN节点已缓存本视频,则节点直接将该视频返回给用户。 开启视频拖拽需同步开启忽略参数配置,即缓存规则中mp4、flv的文件配置需为“忽略URL参数”。 开启视频拖拽需要源站支持Range请求。 支持的文件格式为:mp4、flv。 表1 文件格式 文件格式 Meta信息 start参数说明 示例 MP4 源站视频的meta信息必须在文件头部,不支持meta信息在尾部的视频。 start参数表示时间,CDN会自动定位到start参数所表示时间的前一个关键帧(如果当前start不是关键帧)。start参数的单位是秒,支持以小数表示,例如start=1.01,表示开始时间是1.01秒。 http://www.example.com/test.mp4?start=50 表示从第50秒开始播放。 FLV 源站视频必须带有meta信息。 start参数表示字节,CDN会自动定位到start参数所表示字节的前一个关键帧(如果当前start不是关键帧所在位置)。 http://www.example.com/test.flv?start=500 表示从第500字节开始播放。
  • 注意事项 域名添加后,CDN默认回源HOST为您的加速域名。如果加速域名不是您期望CDN在回源时访问的站点域名时,您需要自定义回源HOST来指明站点域名。 如果您的源站类型为IP地址或域名,您的回源HOST类型默认为加速域名。 如果使用华为云OBS桶作为源站时,默认使用OBS域名作为回源HOST。 如果您以源站域名形式将华为云OBS桶或其他云厂商的对象存储桶接入CDN作为源站,请将回源HOST自定义为您的对象存储桶域名,否则会造成回源失败。
  • 背景信息 源站与回源HOST的区别如下所示: 源站:源站决定了用户回源时访问的地址,即源站服务器IP。 回源HOST:回源HOST决定了回源时访问到该IP地址上的具体站点。 示例:用nginx服务器搭建源站,IP为x.x.x.x,域名为:www.test.com。源站中部署了多个server,如下所示。 server { listen 80; server_name www.a.com; location / { root html; } } server { listen 80; server_name www.b.com; location / { root html; } } 如果您想要CDN回源到本服务器,您需要在CDN侧将源站配置为:x.x.x.x或www.test.com,CDN回源请求到了源站后,如果您需要访问到的server name为www.a.com,您就需要将回源HOST配置为www.a.com;如果您需要访问到的server name为www.b.com,您就需要将回源HOST配置为www.b.com。
  • 配置示例 配置详情:加速域名为“www.example.com”,源站域名为“www.origin.com”,回源HOST配置为“www.example01.com”。 当用户访问“http://www.example.com/test.jpg”文件时,CDN节点没有缓存该资源,此时会解析到源站“www.origin.com”对应的服务器IP(假设IP为192.168.1.1),在服务器的站点“www.example01.com”路径下,找到“test.jpg”文件,返回给用户并缓存到CDN节点。
  • 功能介绍 运营报表为您提供了访问区域分布、国家分布、运营商分布、域名排行 (按流量排序)、热门URL (按流量排序)、热门URL (按请求数排序)共6个运营报表,您可以根据业务需要订阅相关报表,报表生成后会发送到您指定的邮箱。 表1 报表内容 报表名称 说明 访问区域分布 统计某个域名在某段时间内中国大陆终端访问者的地域的分布。 说明: 只有域名的服务范围包含中国大陆时才有数据。 国家分布 统计某个域名在某段时间内终端访问者的国家分布。 运营商分布 统计某个域名在某段时间内终端访问者使用的运营商分布。 域名排行 (按流量排序) 按加速域名在CDN节点产生的流量统计域名排行。 热门URL (按流量排序) 按流量统计热门URL。 热门URL (按请求数排序) 按请求次数统计热门URL。
  • 背景说明 您在添加加速域名时配置的源站会被CDN默认为主源站,您也可以在源站配置页面添加备源站,配置备源站可以有效降低回源失败率。 当源站存在多个IP地址时,CDN回源时采用负载均衡机制,详情如下: 一次回源请求最多访问两个高优先级源站IP,如果两个IP均回源失败,切换到低优先级源站IP,最多访问两个低优先级源站IP。一次用户请求CDN会进行四次回源尝试,如果四次均失败,此次用户请求失败。 回源失败指:连接超时、连接失败或者收到源站的5xx错误码。
  • 适用场景 状态码缓存时间功能主要适用于源站响应异常状态码的场景。当源站运行正常时,CDN回源请求资源后将按照设置的缓存规则将资源缓存到节点,再次访问相同资源时不会触发回源。当源站响应异常,且不希望所有请求都由源站响应,可以设置状态码缓存时间,减轻源站压力。 典型应用:图片abc.jpg已从源站删除,CDN节点无缓存,且持续有用户在访问该资源,那么所有访问都将会回源,由源站响应4xx状态码,增加源站压力。此时如果在CDN配置4xx状态码缓存时间,用户再次请求资源将直接由CDN节点响应4xx状态码,无需回源。
  • 清理托管证书 您也可以在页面对托管证书进行删除操作。 注意事项 清理托管证书,该托管证书将从服务器端删除,不会泄露您的相关隐私。 已关联加速域名的托管证书不能清理,请先关闭HTTPS安全配置。 如果您需要再次使用托管证书,请从SSL证书管理中重新推送至CDN。 操作步骤 单击左上角“清理托管证书”。 在弹出页面选择您需要清理的证书,单击“确定”。 在弹出框中单击“确认”,完成托管证书清理。 如果您需要再次使用托管证书,请从SSL证书管理中重新推送至CDN。
  • 配置示例 加速域名为www.example.com,该加速域名配置了referer白名单规则:包含空referer,白名单内容为www.test.com,如下图所示。 用户1:请求URL:https://www.example.com/file.html,该请求携带的referer字段值为空,CDN将会正常返回内容。 用户2:请求URL:https://www.example.com/file.html,该请求携带的referer字段值为:www.test.com,CDN将会正常返回内容。 用户3:请求URL:https://www.example.com/file.html,该请求携带的referer字段值为:www.abc.com,CDN节点将会返回403禁止访问的错误信息。 加速域名为www.example01.com,该加速域名配置了referer黑名单规则:包含空referer,黑名单内容为www.test01.com,如下图所示。 用户1:请求URL:https://www.example01.com/file.html,该请求携带的referer字段值为空,CDN节点将会返回403禁止访问的错误信息。 用户2:请求URL:https://www.example01.com/file.html,该请求携带的referer字段值为:www.test01.com,CDN节点将会返回403禁止访问的错误信息。 用户3:请求URL:https://www.example01.com/file.html,该请求携带的referer字段值为:www.bcd.com,CDN将会正常返回内容。
  • 功能介绍 运营报表为您提供了访问区域分布、国家分布、运营商分布、域名排行 (按流量排序)、热门URL (按流量排序)、热门URL (按请求数排序)共6个运营报表,您可以根据业务需要订阅相关报表,报表生成后会发送到您指定的邮箱。 表1 报表内容 报表名称 说明 访问区域分布 统计某个域名在某段时间内中国大陆终端访问者的地域的分布。 说明: 只有域名的服务范围包含中国大陆时才有数据。 国家分布 统计某个域名在某段时间内终端访问者的国家分布。 运营商分布 统计某个域名在某段时间内终端访问者使用的运营商分布。 域名排行 (按流量排序) 按加速域名在CDN节点产生的流量统计域名排行。 热门URL (按流量排序) 按流量统计热门URL。 热门URL (按请求数排序) 按请求次数统计热门URL。
  • 校验方法 CDN服务器拿到请求后,会按照如下步骤进行校验: 是否携带鉴权参数。如果没有携带鉴权参数,认为请求非法,返回HTTP 403错误。 时间校验:判断系统当前时间是否在区间[timestamp,timestamp+有效时间]内。超出该区间,认为过期失效并返回HTTP 403错误。 加密串校验:时间校验通过后,则以sstring方式构造出一个字符串(参考以下sstring构造方式)。然后使用md5(sha256)算法算出HashValue,并和用户请求中带来的md5hash(sha256)进行对比。结果一致则认为鉴权通过并返回文件,否则鉴权失败返回HTTP 403错误。HashValue计算方式如下: sstring = "Filename-Timestamp-rand-uid-PrivateKey" HashValue = md5sum(sstring) 或: sstring = "Filename-Timestamp-rand-uid-PrivateKey" HashValue = sha256sum(sstring)
  • 示例说明 以使用MD5算法为例: 通过req_auth请求对象: http://hwcdn.example.com/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3 密钥设为:huaweicloud123(由用户自行设置) 鉴权生效开始日期为:2017年6月30日00:00:00,计算出来的秒数为1498752000。并且设置有效时间为1800s。 CDN服务器构造一个用于计算HashValue的签名字符串: /T128_2_1_0_sdk/0210/M00/82/3E/test.mp3-1498752000-0-0-huaweicloud123 CDN服务器根据该签名字符串计算HashValue: HashValue = md5sum(“/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3-1498752000-0-0-huaweicloud123”) = 40e64d69aac7d15edfc6ec8a080042cb 请求时URL为: http://cdn.example.com/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3?auth_key=1498752000-0-0-40e64d69aac7d15edfc6ec8a080042cb 如果请求在有效时间内(2017年6月30日00:00:00-2017年6月30日00:30:00),并且计算出来的HashValue与用户请求中带的md5hash值(40e64d69aac7d15edfc6ec8a080042cb)一致,则鉴权通过。
  • 停用加速域名 对处于“已开启”或“配置失败”状态的域名,您可以对其进行“停用”操作。停用后,CDN将不再为域名提供加速服务,但域名的配置不会改变,如果想恢复 CDN加速 服务请重新启用CDN。 单域名停用 进入CDN控制台的“域名管理”页面,在需要停用的加速域名对应的“操作”列单击“更多”,选择“停用”。 图2 停用域名 确认需要停用的域名信息,单击“确定”完成域名停用操作。 批量停用加速域名 进入CDN控制台的“域名管理”页面,勾选需要停用的加速域名,单击域名列表上方“停用”。 图3 批量停用域名
  • 示例说明 以使用MD5算法为例: 回源请求对象: http://hwcdn.example.com/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3 密钥设为:huaweicloud123(用户自行设置) 用户访问客户源服务器时间为:201706301000(格式为:YYYYMMDDHHMM) CDN服务器构造一个用于计算md5hash的签名字符串: huaweicloud123201706301000/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3 CDN服务器根据该签名字符串计算md5hash: md5hash = md5sum("huaweicloud123201706301000/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3") = 51415b2256b64a9772a30edf69c00b08 请求CDN时URL: http://hwcdn.example.com/201706301000/ 51415b2256b64a9772a30edf69c00b08 /T128_2_1_0_sdk/0210/M00/82/3E/test.mp3 如果请求在有效时间内(2017年6月30日10:00:00-2017年6月30日10:30:00),并且计算出来的md5hash与用户请求中带的md5hash值(51415b2256b64a9772a30edf69c00b08)一致,则鉴权通过。
  • 校验方法 CDN服务器拿到请求后,会按照如下步骤进行校验: 是否携带鉴权参数。如果没有携带鉴权参数,认为请求非法,返回HTTP 403错误。 时间校验:判断系统当前时间是否在区间[timestamp,timestamp+有效时间]内。超出该区间,认为过期失效并返回HTTP 403错误。 加密串校验:时间校验通过后,则以sstring方式构造出一个字符串(参考以下sstring构造方式)。然后使用md5(sha256)算法算出HashValue,并和用户请求中带来的md5hash(sha256)进行对比。结果一致则认为鉴权通过并返回文件,否则鉴权失败返回HTTP 403错误。HashValue计算方式如下: sstring = “PrivateKeytimestampFilename” HashValue = sha256sum(sstring) 或: sstring = “PrivateKeytimestampFilename” HashValue = md5sum(sstring)
  • 校验方法 CDN服务器拿到请求后,会按照如下步骤进行校验: 是否携带鉴权参数。如果没有携带鉴权参数,认为请求非法,返回HTTP 403错误。 时间校验:判断系统当前时间是否在区间[timestamp,timestamp+有效时间]内。超出该区间,认为过期失效并返回HTTP 403错误。 加密串校验:时间校验通过后,则以sstring方式构造出一个字符串(参考以下sstring构造方式)。然后使用md5(sha256)算法算出HashValue,并和用户请求中带来的md5hash(sha256)进行对比。结果一致则认为鉴权通过并返回文件,否则鉴权失败返回HTTP 403错误。HashValue计算方式如下: sstring = "PrivateKeyFilenameTimestamp" HashValue = md5sum(sstring) 或: sstring = "PrivateKeyFilenameTimestamp" HashValue = sha256sum(sstring)
  • 示例说明 以使用MD5算法为例: 回源请求对象: http://hwcdn.example.com/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3 密钥设为:huaweicloud123(用户自行设置) 鉴权生效开始日期为:2017年6月30日10:00:00,计算出来的秒数为1498788000,并转换为十六进制为5955b0a0。并且设置有效时间为1800s。 CDN服务器构造一个用于计算md5hash的签名字符串: huaweicloud123/T128_2_1_0_sdk/0210/M00/82/3E/test.mp35955b0a0 CDN服务器根据该签名字符串计算md5hash: md5hash = md5sum(huaweicloud123/T128_2_1_0_sdk/0210/M00/82/3E/test.mp35955b0a0) = aecf1b07f481bbb8122eef5cd52a4bc1 请求CDN时URL: http://hwcdn.example.com/aecf1b07f481bbb8122eef5cd52a4bc1/5955b0a0/T128_2_1_0_sdk/0210/M00/82/3E/test.mp3 如果请求在有效时间内(2017年6月30日10:00:00-2017年6月30日10:30:00),并且计算出来的md5hash与用户请求中带的md5hash值(aecf1b07f481bbb8122eef5cd52a4bc1)一致,则鉴权通过。
  • 操作步骤 登录CDN控制台。 在左侧菜单栏中,选择“域名管理”。 在域名列表中,单击需要修改的域名或域名所在行的“设置”,进入域名配置页面。 选择“高级配置”页签。 在请求限速配置模块,单击“编辑”,系统弹出“请求限速配置”对话框。 图1 请求限速配置 表1 参数说明 参数 说明 匹配类型 所有文件:所有文件均参与限速。 目录匹配:指定目录内的文件参与限速。 匹配内容 匹配类型为所有文件时不填。 匹配类型为目录匹配时,输入规则如下: 以“/”开头,例如:/test/folder。 不能以“/”结尾。 每条规则对应一个目录,不支持一条规则配置多个目录。 限速类型 支持按传送流量限速,即单个HTTP请求流量达到设定的值,开始限制访问速度。 限速条件 设置限速起始值,当传送流量达到限速条件设置的值后开始限速。 单位为Byte,最大值可设置为1GB,即:1,073,741,824Byte。 限速值 设置开始限速后的最大访问速度。 最大值可设置为100MBps。 优先级 限速规则的优先级,优先级设置具有唯一性,不支持多条规则设置同一优先级,且优先级不能输入为空。多条限速规则下,不同限速规则中的相同资源内容,CDN优先匹配优先级高的限速规则。 取值为1~100之间的整数,数值越大优先级越高。 打开“状态”开关,配置相关参数,单击“确定”完成限速配置。
  • 重新审核不同的情况有不同的处理 如果该加速域名被禁用的原因仅为域名备案过期,单击“重新审核”后有如下两种情况: 域名已重新备案,系统弹出解禁成功提示信息,域名解禁成功。 域名备案未恢复,系统弹出该加速域名尚未备案提示信息。您需要到工信部为该域名恢复备案后重试。 如果该加速域名被禁用的原因不只是备案过期,单击“重新审核”后系统弹出“该域名被禁用原因不是备案过期,无法通过重新审核来尝试解禁”提示信息,您需要重新检查并整改域名内容,整改完成后提交工单或联系客服咨询处理。
  • RDS授权分类 表1 公共查询 权限 对应API接口 授权项(Action) IAM 项目(Project) 企业项目(Enterprise Project) 查询数据库引擎版本 GET /v3/{projectId}/datastores/{database_name} 无需授权 √ √ 查询数据库规格 GET /v3/{project_id}/flavors/{database_name}?version_name={version_name} 无需授权 √ √ 查询数据库存储规格 GET /v3/{project_id}/storage-type/{database_name}?version_name={version_name} 无需授权 √ √ 表2 实例管理 API功能 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建数据库实例 POST /v3/{project_id}/instances rds:instance:create (创建加密实例需要在项目上配置KMS Administrator权限。) √ √ 修改实例名称 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/name rds:instance:modify √ √ 修改实例备注 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/alias rds:instance:modify √ √ 申请内网域名 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/create-dns rds:instance:createDns √ √ 修改内网域名 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-dns rds:instance:modifyDns √ √ 变更数据库实例的规格 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:modifySpec √ √ 扩容数据库实例的磁盘空间 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:extendSpace √ √ 单机转主备实例 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:singleToHa (加密实例需要在项目上配置KMS Administrator权限。) √ √ 重启数据库实例 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:restart √ √ 删除数据库实例 DELETE /v3/{project_id}/instances/{instance_id} rds:instance:delete √ √ 查询数据库实例列表 GET /v3/{project_id}/instances rds:instance:list √ √ 查询跨区域备份实例列表 GET /v3/{project_id}/backups/offsite-backup-instance rds:instance:list √ √ 绑定和解绑弹性公网IP PUT /v3/{project_id}/instances/{instance_id}/public-ip rds:instance:modifyPublicAccess √ √ 修改数据库实例密码 PUT /v3/{project_id}/instances/{instance_id}/password rds:password:update √ √ 手动主备倒换 PUT /v3/{project_id}/instances/{instance_id}/failover rds:instance:switchover √ √ 修改主备切换策略 PUT /v3/{project_id}/instances/{instance_id}/failover/strategy rds:instance:modifyStrategy √ √ 修改主备同步模式 PUT /v3/{project_id}/instances/{instance_id}/failover/mode rds:instance:modifySynchronizeModel √ √ 修改运维时间窗 PUT /v3/{project_id}/instances/{instance_id}/ops-window rds:instance:modify √ √ 备机可用区迁移 POST /v3/{project_id}/instances/{instance_id}/migrateslave rds:instance:create √ √ 表3 灾备实例 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 配置主实例容灾能力 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:buildDrRelation √ √ 配置灾备实例容灾能力 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:buildDrRelation √ √ 灾备升主 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:modifyDRRole √ √ 查询跨云容灾复制状态 GET /v3/{project_id}/instances/{instance_id}/disaster-recovery rds:instance:list √ √ 表4 数据库安全性 API功能 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 设置SSL 数据加密 PUT /v3/{project_id}/instances/{instance_id}/ssl rds:instance:modifySSL √ √ 修改数据库端口 PUT /v3/{project_id}/instances/{instance_id}/port rds:instance:modifyPort √ √ 修改内网地址 PUT /v3/{project_id}/instances/{instance_id}/ip rds:instance:modifyIp √ √ 修改安全组 PUT /v3/{project_id}/instances/{instance_id}/security-group rds:instance:modifySecurityGroup √ √ 表5 参数配置 API功能 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 获取参数模板列表 GET /v3/{project_id}/configurations rds:param:list √ √ 创建参数模板 POST /v3/{project_id}/configurations rds:param:create √ √ 修改参数模板参数 PUT /v3/{project_id}/configurations/{config_id} rds:param:modify √ √ 应用参数模板 PUT /v3/{project_id}/configurations/{config_id}/apply rds:param:apply √ √ 修改指定实例的参数 PUT /v3/{project_id}/instances/{instance_id}/configurations rds:param:modify √ √ 获取指定实例的参数模板 GET /v3/{project_id}/instances/{instance_id}/configurations rds:param:list √ √ 获取指定参数模板的参数 GET /v3/{project_id}/configurations/{config_id} rds:param:list √ √ 删除参数模板 DELETE /v3/{project_id}/configurations/{config_id} rds:param:delete √ √ 表6 备份与恢复 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 设置自动备份策略 PUT /v3/{project_id}/instances/{instance_id}/backups/policy rds:instance:modifyBackupPolicy √ √ 设置跨区域备份策略 PUT /v3/{project_id}/instances/{instance_id}/backups/offsite-policy rds:instance:modifyBackupPolicy √ √ 查询自动备份策略 GET /v3/{project_id}/instances/{instance_id}/backups/policy rds:instance:list √ √ 查询跨区域备份策略 GET /v3/{project_id}/instances/{instance_id}/backups/offsite-policy rds:instance:list √ √ 创建手动备份 POST /v3/{project_id}/backups rds:backup:create √ √ 获取备份列表 GET /v3/{project_id}/backups?instance_id={instance_id} rds:backup:list √ √ 获取跨区域备份列表 GET /v3/{project_id}/offsite-backups?instance_id={instance_id} rds:backup:list √ √ 获取备份下载链接 GET /v3/{project_id}/backup-files?backup_id={backup_id} rds:backup:download √ √ 删除手动备份 DELETE /v3/{project_id}/backups/{backup_id} rds:backup:delete √ √ 查询可恢复时间段 GET /v3/{project_id}/instances/{instance_id}/restore-time rds:instance:list √ √ 查询跨区域备份可恢复时间段 GET /v3/{project_id}/instances/{instance_id}/offsite-restore-time rds:instance:list √ √ 恢复到新实例 POST /v3/{project_id}/instances rds:instance:create (加密实例需要在项目上配置KMS Administrator权限。) √ √ 恢复到已有或当前实例 POST /v3/{project_id}/instances/recovery rds:instance:restoreInPlace √ √ 表7 获取日志信息 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 查询数据库错误日志 GET /v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date} rds:log:list √ √ 查询数据库慢日志 GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date} rds:log:list √ √ 设置审计日志策略 PUT /v3/{project_id}/instances/{instance_id}/auditlog-policy rds:auditlog:operate √ √ 查询审计日志策略 GET /v3/{project_id}/instances/{instance_id}/auditlog-policy rds:auditlog:list √ √ 获取审计日志列表 GET /v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}&offset={offset}&limit={limit} rds:auditlog:list √ √ 生成审计日志下载链接 POST /v3/{project_id}/instances/{instance_id}/auditlog-links rds:auditlog:download √ √ 获取慢日志下载链接 POST /v3/{project_id}/instances/{instance_id}/slowlog-download rds:log:download √ √ 获取binlog本地保留时长 GET /v3/{project_id}/instances/{instance_id}/binlog/clear-policy rds:binlog:get √ √ 设置binlog本地保留时长 PUT /v3/{project_id}/instances/{instance_id}/binlog/clear-policy rds:binlog:setPolicy √ √ 表8 管理数据库和用户(MySQL) API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 创建数据库 POST /v3/{project_id}/instances/{instance_id}/database rds:database:create √ √ 查询数据库列表 GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit} rds:database:list √ √ 查询指定用户的已授权数据库 GET /v3/{project_id}/instances/{instance_id}/db_user/database?user-name={user-name}&page={page}&limit={limit} rds:database:list √ √ 删除数据库 DELETE /v3/{project_id}/instances/{instance_id}/database/{db_name} rds:database:drop √ √ 创建数据库用户 POST /v3/{project_id}/instances/{instance_id}/db_user rds:databaseUser:create √ √ 查询数据库用户列表 GET /v3/{project_id}/instances/{instance_id}/db_user/detail?page={page}&limit={limit} rds:databaseUser:list √ √ 查询指定数据库的已授权用户 GET /v3/{project_id}/instances/{instance_id}/database/db_user?db-name={db-name}&page={page}&limit={limit} rds:databaseUser:list √ √ 删除数据库用户 DELETE /v3/{project_id}/instances/{instance_id}/db_user/{user_name} rds:databaseUser:drop √ √ 授权数据库账号 POST /v3/{project_id}/instances/{instance_id}/db_privilege rds:databasePrivilege:grant √ √ 修改数据库账号密码 POST /v3/{project_id}/instances/{instance_id}/db_user/resetpwd rds:password:update √ √ 解除数据库账号权限 DELETE /v3/{project_id}/instances/{instance_id}/db_privilege rds:databasePrivilege:revoke √ √ 表9 管理数据库和用户(PostgreSQL) API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 创建数据库 POST /v3/{project_id}/instances/{instance_id}/database rds:database:create √ √ 创建数据库用户 POST /v3/{project_id}/instances/{instance_id}/db_user rds:databaseUser:create √ √ 授权数据库账号 POST /v3/{project_id}/instances/{instance_id}/db_privilege rds:databasePrivilege:grant √ √ 创建数据库 schema POST /v3/{project_id}/instances/{instance_id}/schema rds:database:create √ √ 查询数据库列表 GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit} rds:database:list √ √ 查询数据库用户列表 GET /v3/{project_id}/instances/{instance_id}/db_user/detail?page={page}&limit={limit} rds:databaseUser:list √ √ 查询数据库SCHEMA列表 GET /v3/{project_id}/instances/{instance_id}/schema/detail?db_name={name}page={page}&limit={limit} rds:database:list √ √ 表10 回收站 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 设置回收站策略 PUT https://{Endpoint}/v3/{project_id}/instances/recycle-policy rds:instance:setRecycleBin √ √ 表11 标签管理 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 批量添加删除标签 POST /v3/{project_id}/instances/{instance_id}/tags/action rds:instance:dealTag √ √ 查询项目标签 GET /v3/{project_id}/tags rds:tag:list √ √ 表12 配额管理 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 查询配额 GET https://{Endpoint}/v3/{project_id}/quotas rds:instance:list √ √ 表13 任务功能 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 获取任务信息 GET /v3/{project_id}/jobs?id={id} rds:task:list √ √ 父主题: 权限和授权项
  • URI URI格式 GET /v3/{project_id}/recycle-instances?offset={offset}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID。 offset 是 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,必须为数字,不能为负数。 limit 是 每页数据条数,取值范围[1, 50]。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 total_count Integer 回收站数据条数。 instances Array of objects 回收站信息,详细说明请参见表3。 表3 instances字段数据结构说明 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 ha_mode String 实例主备模式,取值:Ha(主备)、Single(单机),不区分大小写。 engine_name String 引擎名称。 engine_version String 数据库引擎版本。 pay_model String 计费方式,取值:0(按需)、1(包周期)。 created_at String 创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 deleted_at String 删除时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 volume_type String 磁盘类型。取值范围如下,区分大小写: ULTRAHIGH,表示超高IO型磁盘。 ULTRAHIGHPRO,表示SSD尊享版,仅支持超高性能型尊享版(需申请权限)。 CLOUDSSD,表示SSD云盘,仅支持通用型和独享型规格实例。 LOCALSSD,表示本地SSD盘。 volume_size Integer 磁盘大小,单位为GB。取值范围:40GB~4000GB,必须为10的整数倍。 部分用户支持40GB~6000GB,如果您想创建存储空间最大为6000GB的数据库实例,或提高扩容上限到10000GB,请联系客服开通。 对于只读实例,该参数无效,只读实例磁盘大小默认和主实例相同。 data_vip String 内网地址。 data_vip_v6 String IPv6内网地址。 enterprise_project_id String 企业项目ID。 retained_until String 保留时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。 recycle_backup_id String 备份ID。 recycle_status String 备份状态取值如下,区分大小写: BUILDING:备份中,不能进行重建。 COMPLETED:备份完成,可以重建实例。 正常响应样例 { "total_count" : 2, "instances" : [ { "id" : "b7dea08c0f0e4fed9f1951fff9013639in01", "name" : "rds-8b86", "ha_mode" : "Ha", "engine_name" : "mysql", "engine_version" : "5.7.38", "pay_model" : "0", "created_at" : "2022-12-26T03:38:10+0000", "deleted_at" : "2023-01-09T08:57:10+0000", "volume_type" : "SSD", "volume_size" : 80, "data_vip" : "192.168.226.188", "enterprise_project_id" : "0", "retained_until" : "2023-01-16T09:20:48+0000", "recycle_backup_id" : "e8e3c329c20442f5aec21b95a8cdaa52br01", "recycle_status" : "COMPLETED" }, { "id" : "cc6d0dff4a9145d0a1335c35a866de23in01", "name" : "rds-82b2", "ha_mode" : "Ha", "engine_name" : "mysql", "engine_version" : "5.7.38", "pay_model" : "0", "created_at" : "2022-12-26T06:17:58+0000", "deleted_at" : "2023-01-09T08:56:49+0000", "volume_type" : "SSD", "volume_size" : 200, "data_vip" : "192.168.2.24", "enterprise_project_id" : "0", "retained_until" : "2023-01-16T09:20:45+0000", "recycle_backup_id" : "3f35a348ae0943979bd302a9788f49e7br01", "recycle_status" : "COMPLETED" } ] } 异常响应 请参见异常请求结果。
共100000条