修改回源uri和host改写
更新时间：2024-04-17 14:52:30
适用产品
网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、上网加速、S-P2P、PCDN、应用性能管理、WEB应用防火墙、BotGuard爬虫管理、WSS、DMS、DDoS云清洗、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案
接口描述
修改回源uri和host改写
- 调用URL： https://open.chinanetcenter.com/api/config/originrulesrewrites/*
- 调用方法：PUT
- 限制说明：接口请求和返回结果支持xml格式和json格式。
调用频率
单用户调用频率：300/5min
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Path 参数
| 参数名称 | 描述 |
|---|---|
*domain-nameString | 需要查询配置的域名或域名id |
Body 参数
| 参数名称 | 描述 |
|---|---|
*originRulesRewritesList | 回源路径改写配置
1.需要设置回源路径改写配置时，此项必填
2.为 |
dataIdLong | 添加grid类型标识，表示客户多组配置时，具体某组配置
注意：添加grid类型标识：data-id，每一组配置对应一个data-id：a、如果客户有传data-id，说明指定修改其中一组配置项内容，不需求修改其他组配置内容不需要入参；b、如果客户入参多组配置，其中有些组配置有传data-id，有些没有传，则有传data-id的表示修改具体某组配置，没有传data-id的表示在原来基础上新增一组配置；c、如果客户入参都没有传data-id,表示用本次的配置全量覆盖原先配置；d、如果客户入参没有传任何配置项参数，只传了域名和二级标签，表示清空这个接口对应域名二级服务所有配置。（c、d内容和当前方案实现一致）；e、一个gird标签下的入参不能为空，如果，没有具体的配置项，则data-id必填，且值为实际存在的data-id,表示清空这个data-id对应配置项的值； |
*pathPatternString | url匹配模式，支持正则，如果是全部匹配，入参可以配置为：.* |
pathPatternHttpString | url匹配模式的协议，该配置项与path-pattern搭配使用；入参支持：默认为空，为空则默认为需要同时支持url匹配模式路径前支持http和https协议；
http：url匹配模式路径前加上http协议
https:url 匹配模式路径前加上HTTPS协议
ignore:url匹配模式路径前不加协议 |
exceptPathPatternString | 例外的url匹配模式，格式同pathPattern |
exceptPathPatternHttpString | 例外的url匹配模式的协议，该配置项与except-path-pattern搭配使用；入参支持：默认为空，为空则默认为需要同时支持url匹配模式路径前支持http和https协议；
http：url匹配模式路径前加上http协议
https:url 匹配模式路径前加上HTTPS协议
ignore:url匹配模式路径前不加协议 |
ignoreLetterCaseString | 是否忽略大小写：允许值为true和false，默认为忽略 |
originInfoString | 回源信息，可以输入ip或者域名
即客户源站IP或域名 |
*priorityString | 表示客户多组重定向内容的优先执行顺序。数字越大，优先级越高。
新增配置项时，不传默认为 10
如果传了值，不能为空 |
originHostString | 回源host,支持入参域名；
示例：域名A的回源host配置了域名B。当A域名请求的回源的时候，请求的url上用B域名代替A域名 |
beforeRewritedUriString | 改写前的uri. 即用户访问的原始请求uri 。支持正则配置 |
afterRewritedUriString | 改写后的uri,即将 before-rewrited-uri配置的请求uri，用改写后的uri回源。实现回源路径改写。支持正则配置 |
返回参数
Body 参数
| 参数名称 | 描述 |
|---|---|
codeString | 错误代码，当HTTPStatus不为202时出现，表示当前请求调用的错误类型 |
messageString | 响应信息，成功时为success |
dataString | 返回数据主体 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| 0 | Success | 202 | 成功 |
| 26938005 | The specified xxx cannot be blank | 400 | 参数格式错误 |
| 26938017 | The body of your HTTP request does not match with the content-type [json]. | 400 | 请求体对象转换异常 |
| 26938018 | The accept header specified in your request is not acceptable | 400 | 请求头格式不支持 |
| 26932001 | The specified domain does not exist. | 404 | 找不到域名 |
| 26932002 | customer not own domain name[XXX] | 400 | 域名不属于该客户 |
| 26933001 | wrong DataId | 400 | 错误DataId |
| 26935001 | The config xxx does not access. | 400 | 套餐未规划xxx配置项 |
| 26939999 | We encountered an internal error. Please try again. | 500 | 系统内部异常 |
示例
JSON
- 请求示例 复制成功
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://open.chinanetcenter.com/api/config/originrulesrewrites/123344" \ -X "PUT" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -H "Content-Type:application/json" \ -d '{ "originRulesRewrites":[ { "dataId":"1222", "pathPattern":".*", "pathPatternHttp":"http", "exceptPathPattern":"", "exceptPathPatternHttp":"", "ignoreLetterCase":"true", "originInfo":"127.0.0.1", "priority":5, "originHost":"b.example.com", "beforeRewritedUri":"", "afterRewritedUri":"" } ] }'- 返回示例 复制成功
HTTP/1.1 202 Accept Date: Sun, 05 May 2019 09:08:53 GMT Content-Type: application/json;charset=utf-8 x-cnc-request-id: 83bbebc7-2c95-47d7 { "code":"0", "message":"success"， “data":"" }
本篇文档内容对您是否有帮助？
有帮助
我要反馈