设置域名的回源策略
更新时间：2023-05-30 17:13:13
适用产品
网页加速、下载分发、全站加速、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案、点播分发、移动加速
接口描述
设置域名的回源配置策略，包括：高级源、Rangel回源、301和302回源跟随。
- 调用URL： https://open.chinanetcenter.com/api/domain/setsrcconfig
- 调用方法：POST
- 限制说明：· 接口请求和返回结果接受json和xml格式。
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Body 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
domainName | 是 | 要修改配置的加速域名，一次仅支持修改一个域名的配置信息 | |
useRange | 否 | 设置range回源功能的开启或关闭，可选值为true、false true：开启range回源 false：关闭range回源 不传：表示不修改 注意： 1、Range是Http请求头，用于文件指定部分的请求。如：Range: bytes=0-999 就是请求该文件的前1000个字节。开启Range回源配置能够有效提高大文件分发效率，提升响应速度。源站需要支持range请求，否则会导致回源失败。 2、下载加速的域名默认range回源为开启状态，网页加速的域名默认为关闭状态 | |
follow301 | 否 | 设置回源跟随301。当节点回源请求返回301状态码时，CDN节点会直接向跳转地址请求资源而不返回301给用户。可选值为true、false true：开启301跟随 false：关闭301跟随 不传：表示不修改 | |
follow302 | 否 | 设置回源跟随302。当节点回源请求返回302状态码时，CDN节点会直接向跳转地址请求资源而不返回302给用户。可选值为true、false true：开启302跟随 false：关闭302跟随 不传：表示不修改 | |
advSrcSetting | 否 | 设置高级源策略 | |
useAdvSrc | 是 | 是否使用高级源，可选值为true、false true：开启高级源 false：关闭高级源 注意： 1、当useAdvSrc=true时，至少要设置一个高级源的回源IP/域名 2、当useAdvSrc=true时，如果域名已经通过后台人工配置了高级源，并且存在高级源其他特殊配置时，则不允许通过API接口修改高级源 | |
detectUrl | 否 | 高级源监控url，通过该url请求 | |
detectPeriod | 否 | 高级源监控周期，单位秒，可选值为大于等于0的整数，0表示不监控 | |
advSrcConfigs | 否 | ||
masterIps | 否 | 高级源主要回源IP/域名，支持多个IP/域名，不能重复 | |
backupIps | 否 | 高级源备用回源IP/域名，支持多个IP/域名，不能重复 |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
http status code | httpstatus=202; 表示成功调用新增域名接口，可使用header中的x-cnc-request-id查看当前新增域名的部署情况 | |
x-cnc-request-id | 唯一标示的id，用于查询每次请求的任务 （适用全部接口） | |
code | 错误代码，当HTTPStatus不为202时出现，表示当前请求调用的错误类型 | |
message | 响应信息，成功时为success |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| InternalError | We encountered an internal error. Please try again. | 500 | 内部错误 |
| HttpRequestNotReadable | The body of your HTTP request does not match with the content-type [xml]. | 400 | 请求的Xml或者Json格式不正确 |
| InvalidParameter | The advance source master/backup ip could not has duplicate value. | 400 | masterIp/backupIp中不能存在重复的IP或者域名 |
| NoSuchDomain | The specified domain does not exist. | 404 | 请求的域名不存在 |
| ConfigError | The config redrectfile does not access. | 400 | 域名关联的套餐没有规划配置项-“拉取跳转后的文件” |
| UnModifiableAdvSrc | The advance source can not modify. | 400 | 高级源无法被修改 |
| DOMAIN_ATTRIBUTE_ERROR | Can not change advanced source ip or source domain name. | 400 | 无法修改高级源 |
| WRONG_OPERATOR | Operator [] can not deal with domain name []. | 400 | 请求用户无法操作该域名 |
| CONFIG_NOT_OWN_DOMAIN_NAME | Customer not own domain name[]. | 400 | 该域名不属于该用户 |
| DomainNotRestored | The domain you are trying to cancel has not been restored. | 409 | 请求的域名已经取消加速域名 |
| Forbidden | The domain is being deleted | 403 | 请求的域名已经被删除 |
示例
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/domain/setsrcconfig" \ -X "POST" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "domainName": "www.example.com", "useRange": true, "follow301": true, "follow302": true, "advSrcSetting": { "useAdvSrc": true, "detectUrl": "http://a.example.com/test.html", "detectPeriod": 600, "advSrcConfigs": [ { "masterIps": [ "1.1.1.1", "2.2.2.2" ], "backupIps": [ "www.abc.com" ] } ] } }'- 返回示例 复制成功
HTTP/1.1 202 Accepted Date: Fri, 17 May 2017 06:33:26 GMT Content-Type: application/json;charset=utf-8 x-cnc-request-id:c54cbbb4-19fe-407a-930c-3988b62ed2fd { "message":"success", "code":"" }
本篇文档内容对您是否有帮助？
有帮助
我要反馈