文档中心 API文档 域名新增URL屏蔽

域名新增URL屏蔽

更新时间:2020-11-20 13:35:26

适用产品

网页加速、下载分发、全站加速、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案、点播分发、直播分发、移动加速

接口描述

通过接口自助新增URL屏蔽的功能。客户可以根据自己的需求调用接口,新增URL屏蔽内容

  • 调用URL: https://open.chinanetcenter.com/api/basicconfig/illegalinformation
  • 调用方法:PUT
  • 限制说明:·在中国 加速域名必须已备案完成。 · 加速域名必须不包含如下信息:出售药物和管制刀具类,含有不法言论、信息。 · 视频类加速域名必须有视听许可证;博客论坛或社区类加速域名必须有BBS专项审批资质。 · 接口请求和返回结果接受xml和json格式。

请求参数

Body 参数

XML
参数名称类型必填描述
illegal-informations
complex非法信息屏蔽配置标签 注意:表示需要设置非法信息屏蔽配置时,此项必填
customer-code
String需要非法屏蔽的客户在我司设置的英文名
illegal-information
complex表示一组非法信息屏蔽配置内容 注意:表示需要设置非法信息屏蔽配置时,此项必填
areas
complex需要设置非法信息屏蔽的区域。则此项必填.支持多个。如设置全球,则输入 Global
area
string一组区域配置,如果有多个则,参数多个。
ban-urls
string一个区域下配置需要非法信息屏蔽的url,如果某些区域有多个屏蔽url则有多组
url
String一组url信息,必须是customer下的非挂起域名的url。
method
String匹配方式,支持模糊和精确;模糊入参为:fuzzy;精确匹配:exact 如果没有传默认是exact

返回参数

Body 参数

XML&JSON
参数名称类型描述
http status code
inthttpstatus=202;   表示成功调用新增域名接口,可使用header中的x-cnc-request-id查看当前新增域名的部署情况
x-cnc-request-id
String唯一标示的id,用于查询每次请求的任务 (适用全部接口)
Location
String用于访问该域名信息的URL,其中domain-id为该域名生成的唯一标示,其值为字符串。
cname
String由自动生成的服务域名名称,例如:xxxx.cdn30.com
code
String错误代码,当HTTPStatus不为202时出现,表示当前请求调用的错误类型
message
String响应信息,成功时为success

示例

JSON
XML
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/basicconfig/illegalinformation" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json"
-d ' 
{
    "customer":"xxxx",
     "illegal-information":[
      {
        "areas":["Russia","China"],
        "ban-urls":["https://xxx.xxx.xxx/xxx1.html","https://xxx.xxx.xxx/xxx2.html"],
        "method":"fuzzy"
       },
      {
        
         "areas":["Russia"],
        "ban-urls":["https://xxx.xxx.xxx/xxx3.html","https://xxx.xxx.xxx/xxx4.html"],
        "method":"exact"
      }
   ]
}'
返回示例
复制代码 复制成功
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
x-cnc-deploy-version:1420084740000
{"message":"success"}
本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!