CDN加速

文档中心 API文档 域名配置 修改流媒体普通防盗链配置

修改流媒体普通防盗链配置

更新时间:2021-06-29 18:57:56
适用产品:直播加速

接口描述

通过接口自助修改流媒体普通防盗链配置。接口url的*可为域名名称或域名id。

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

请求参数

参数名称类型必填描述
visitControlRulesComplex流媒体防盗链配置,父标签 1.需要设置流媒体防盗链配置时,此项必填 2.为<visitControlRules/>时清空流媒体防盗链配置
visitControlRuleComplex父标签,只能配置一条
controlActionString控制动作,允许或禁止,可选值:allow,forbid 注意:配置或修改流媒体防盗链时,必须同时配置controlAction和ip、referer,ip和referer至少配置一项,否则此防盗链功能无效。
ipsComplex允许或禁止的IP,支持IP或IP段,父标签。必须同时配置controlAction。 格式如 <controlAction>forbid</controlAction> <ips> <ip>1.1.1.1</ip> <ip>2.2.2.0/24</ip> </ips>
ipString允许或禁止的IP,支持IP或IP段
referersComplex允许或禁止的referer,支持输入域名或url格式,父标签,必须以协议头开头,如http://、https://。必须同时配置controlAction。格式如: <controlAction>forbid</controlAction> <referers> <referer>http://www.referer1.com</referer> <referer>http://www.referer2.com</referer> </referers>
refererstring允许或禁止的referer,支持域名或url格式
allowNullRefererBoolean是否允许/禁止空referer,可选值为true、false,默认为否。 当控制动作=forbid,表示是否禁止空referer,为true,表示禁止空referer 当控制动作=allow,表示是否允许空referer,为true,表示允许空referer
controlRelationStringip和refer条件关系,可选值:and,or,默认为and 为and,表示ip和refer都满足,才允许/禁止。为or,表示ip和refer满足一个,就允许/禁止
dataIdInt配置多组配置时,具体某组配置的id。dataId可以通过查询接口获取。 注意: a、如果有传dataId,说明指定修改其中一组配置项内容,不需求修改其他组配置内容不需要入参; b、如果入参多组配置,其中有些组配置有传dataId,有些没有传,则有传dataId的表示修改具体某组配置,没有传dataId的表示在原来基础上新增一组配置; c、如果入参都没有传dataId,表示用本次的配置全量覆盖原先配置; d、如果入参没有传任何配置项参数,只传了域名和二级标签,表示清空这个接口对应域名二级服务所有配置; e、如果一组配置没有具体的配置项,则dataId必填,且值为实际存在的dataId,表示清空这个dataId对应配置项的值;不允许一组配置没有具体的配置项也没有dataId。

返回参数

参数名称类型描述
x-cnc-request-idString唯一标示的id,用于查询每次请求的任务 (适用全部接口)
http status codeInthttpstatus=202; 表示成功调用修改域名配置接口,可使用header中的x-cnc-request-id查看当前修改域名的部署情况

示例

示例说明
请求示例
复制
#!/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/live-visitcontrol/123344" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-d '
{
 "visitControlRules":[{
 "controlAction":"allow",
 "ips":["1.1.1.1","2.2.2.0/24"],
 "allowNullReferer":"false",
 "referers":["http://www.referer1.com","http://www.referer2.com"],
 "controlRelation":"and"
 }]
}'
返回示例
复制
HTTP/1.1 202 Accepted
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":""}