全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

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

最近更新时间:2024-04-22 18:16:10

BlockDomainUrl

描述

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

说明:

  • 同一个 ID 设有总屏蔽条数的限制额度,默认限制额度5000条,超过上限后屏蔽失败

  • 屏蔽URL:

    • 该URL后续访问都是403

    • 默认屏蔽时间7天,如需长期屏蔽url,建议固定周期循环调用本接口

  • 解除屏蔽:解除屏蔽后,对该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列表

RefreshOnUnblock

String

(仅在解除屏蔽时生效),解除屏蔽时,是否联动触发刷新任务 取值:on:触发刷新任务、off:不触发刷新任务 ,默认为off

数据类型Url

参数

类型

描述

Url

String

具体的URL,以http://开头,屏蔽功能同时屏蔽http和https的访问;

返回参数

参数名

类型及范围

说明

TaskId

String

任务Id

示例

请求示例

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",
    "Urls":[{"Url":"http://www.test.com/abc.txt"},
    {"Url":"http://www.test.com/txa.txt"}]
}

返回示例

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

文档导读
纯净模式常规模式

纯净模式

点击可全屏预览文档内容
文档反馈