调用BlockObjectCaches可以封禁CDN节点上的指定URL内容，用户访问被封禁的URL内容时，会收到CDN返回的403状态码，即无法访问到被封禁的内容。

说明
  • 单用户调用频率为：20次/秒。
  • 仅支持有权限调用该接口的白名单用户使用，如果您的阿里云账号的日带宽峰值大于100Gbps，您可以提交工单申请使用，阿里云将根据您业务的实际需求进行评估和开通。
  • 该接口支持使用POST请求方式调用，参数使用form表单方式提交。
封禁规则

  • 封禁支持参数精确匹配

    假设下发封禁URL为http://www.example.com/abc.html?a=1&b=1，则在实际封禁时，只会封禁http://www.example.com/abc.html?a=1&b=1，其他URL例如http://www.example.com/abc.html?a=1&b=2不会被封禁。

  • 封禁支持忽略参数

    在加速域名配置了忽略参数功能的情况下，假设下发封禁URL为http://www.example.com/abc.html，则在实际封禁时，CDN节点收到的用户请求URL如果经过忽略参数处理以后和封禁URL相同，那么这些请求URL都会被封禁，包括但不限于http://www.example.com/abc.html、http://www.example.com/abc.html?a=1、http://www.example.com/abc.html?a=2 或http://www.example.com/abc.html?a=1&b=1。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 BlockObjectCaches

系统规定参数。取值：BlockObjectCaches。
ObjectPath String 是 example.com/image/1.png

封禁的URL，多个URL之间需要用换行符（\n或\r\n）分隔。

说明
  • 每次请求最多支持提交100条URL封禁/解封禁操作。
  • 同一个阿里云账号每天最多可以提交100条URL封禁/解封禁操作。
Type String 是 block

操作类型，取值范围：

  • block：封禁
  • unblock：解封
Maxage Integer 否 86400

封禁生效时长。

  • 取值范围：600~864000
  • 单位：秒
  • 输入值为空时，默认生效时长为90天。

返回数据

名称 类型 示例值 描述
BlockTaskId String 704222904

封禁返回的任务ID，多个任务ID用半角逗号（,）分隔。
RequestId String D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=BlockObjectCaches
&ObjectPath=example.com/image/1.png
&Type=block
&<公共请求参数>

正常返回示例

XML格式 

<BlockObjectCachesResponse>
  <RequestId>D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C</RequestId>
  <BlockTaskId>704222904</BlockTaskId>
</BlockObjectCachesResponse>

JSON格式 

{"RequestId":"D61E4801-EAFF-4A63-AAE1-FBF6CE1CFD1C","BlockTaskId":"704222904"}

错误码

HttpCode 错误码 错误信息 描述
400 QuotaExceeded.Refresh You've exceeded the prescribed refresh limits. 超出当日刷新限制。今日刷新数已用完。您可以通过刷新接口查询今日的刷新次数。
400 InvalidObjectPath.Malformed The specific value of parameter ObjectPath is malformed. 参数ObjectPath值格式错误。输入示例：example.com/image/1.png。多个URL之间需要用换行符（\n 或 \r\n）分隔。
400 InvalidExtensiveDomain.ValueNotSupported Extensive domain not supported. 该操作不支持泛域名。

访问错误中心查看更多错误码。