文档中心 API文档 单域名取消CDN加速服务

单域名取消CDN加速服务

更新时间:2023-12-15 10:29:19

适用产品

网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、上网加速、应用加速、S-P2P、PCDN、应用性能管理、WEB应用防火墙、BotGuard爬虫管理、WSS、DMS、DDoS云清洗、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案

接口描述

取消指定域名的CDN加速服务,即从DNS层面强制让域名请求直接回源。多用于客户不及时响应处理涉黄网站。

  • 调用URL: https://open.chinanetcenter.com/api/domain/*/cancel
  • 调用方法:PUT
  • 限制说明:·取消域名CDN加速服务后,该加速域名的配置信息仍保留,针对加速域名的请求系统将做自动回源处理。 ·若需要禁用指定域名的加速服务,推荐使用【禁用单加速域名】接口。 ·在取消加速域名的CDN服务后,可以恢复加速域名的CDN服务。 ·调用频率需控制,可能影响部署性能!

调用频率

单用户调用频率:300/5min

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Path 参数

参数名称描述
*domainIdInteger
加速域名在系统中对应的ID 1. 参看请求示例中的url,123344对应的就是domain-id 2. 可以通过【获取域名配置】和【获取域名列表】接口查询到domain-id

返回参数

Body 参数

参数名称描述
code
错误代码,当HTTPStatus不为202时出现,表示当前请求调用的错误类型
message
响应信息,成功时为success
http status code
httpstatus=202;   表示成功调用新增域名接口,可使用header中的x-cnc-request-id查看当前新增域名的部署情况
x-cnc-request-id
唯一标示的id,用于查询每次请求的任务 (适用全部接口)

错误码

错误代码(code)描述(message)HTTP状态码语义
NoSuchDomaincustomer not own domain id.404域名不属于当前客户
ForbiddenThe domain is being deleted403域名被删除
DomainNotRestoredThe domain you are trying to cancel has not been restored.409您想取消的域名已经被取消加速服务了
InvalidOriginPlease specify at least one IP or hostname.400没有提供回源IP或回源域名
SHARE_CNAME_LABELThe cname-label is being used by other domains. It cannot be cancelled.400和其他域名共用一级别名,不能取消加速服务
PARAM_INVALIDparam: {0} is null or invalid.400参数{}为空或者无效
WRONG_OPERATORWrong operator [$operator] for the customer.400提交人不对应客户

示例

XML
XML
请求示例
复制代码 复制成功
#!/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/123344/cancel" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/xml"
返回示例
复制代码 复制成功
HTTP/1.1 202 OK
Date: Fri, 17 May 2017 06:33:26 GMT
Content-Type: application/xml;charset=utf-8
x-cnc-request-id:c54cbbb4-19fe-407a-930c-3988b62ed2fd
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <message>success</message>
</response>
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!