设置一键屏蔽、解除屏蔽URL接口

最近更新时间:2021-03-08 15:04:13

查看PDF

BlockDomainUrl

描述

本接口用于屏蔽、解除屏蔽URL。

说明:

  • 同一个 ID 设有总屏蔽条数的限制额度,与控制台共享此额度,具体额度可查看控制台或调用,超过上限后屏蔽失败

  • 屏蔽URL:该URL后续访问都是403

  • 解除屏蔽:解除屏蔽后,对该URL的访问回复正常

注意:

  • 解除屏蔽时,如果该url不存在或已经解除屏蔽,返回成功。

  • 每个 URL 必须以http://开头,但后台同时屏蔽http和https的访问

  • 每个 URL 最大长度 1000 字符

  • 每个 URL 所在的域名必须是该用户在金山云加速的域名。

  • URL 如果包含中文字符,请使用urlencode方式提交。

  • 单次调用URL上限为1000条

  • 接口仅支持POST请求格式

请求语法

本接口请求需要包含指定目录/2016-09-01/content/BlockDomainUrl、公共请求header和该接口所特有的请求参数,具体请求语句参照下文请求示例。

请求参数

参数 类型 必要 描述
BlockType String 操作接口名,系统规定参数 取值:block:屏蔽URL;unblock:解除屏蔽
Urls Url[] URL列表
BlockTime Long (仅在屏蔽URL动作时生效),屏蔽的时间,以秒为单位。默认为604800(7天),最大31天,最小1小时。过期后自动解除屏蔽。(注:当前版本该参数可配置,但后台不生效,使用默认值7天。后续下一版将完善。)
RefreshOnUnblock String (仅在解除屏蔽时生效),解除屏蔽时,是否联动触发刷新任务 取值:on:触发刷新任务、off:不触发刷新任务 ,默认为off

数据类型Url

参数 类型 描述
Url String 具体的URL,以http://开头,屏蔽功能同时屏蔽http和https的访问;

返回参数

特殊错误码

ErrorCode 错误码Message HTTP 状态语义
IllegalOperation Illegal domain operate is not permitted. 没有权限执行当前操作
QuotaOverfull 超过配额

示例

请求示例

POST方式:

POST /2016-09-01/content/BlockDomainUrl
Host: cdn.api.ksyun.com 
X-Amz-Date: date  
Authorization:authorization string 
x-action: BlockDomainUrl
x-version: 2016-09-01 
 Content-Type: application/json

{
    "DomainId": "2D08M8V",
    "BlockType":"block",
    "BlockTime":3600,
    "Urls":[{"Url":"http://www.test.com/abc.txt"},
    {"Url":"http://www.test.com/txa.txt"}]
}

返回示例

  • 说明:本接口调用成功只会返回200的状态码,无返回值,若调用失败,则会返回403/400状态码,400的具体错误原因详见【使用须知】中错误代码表说明

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

  • 内容不全,不深入
  • 内容更新不及时
  • 描述不清晰,比较混乱
  • 系统或功能太复杂,缺乏足够的引导
  • 内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈