CDN

屏蔽URL进度查询接口

最近更新时间:2020-09-15 15:53:52

GetBlockUrlTask

描述

本接口用于获取屏蔽URL任务进度百分比及状态,查看任务是否在全网生效。

  • 支持根据 TaskId、URL、StartTime、EndTime 、域名、BlockType 获取数据
  • 支持按指定的起止时间查询,两者需要同时指定
  • 所有参数都不指定,则默认查最近24小时,第一页的数据(20条)
  • 起止时间、TaskId、Url、域名、BlockType可以同时指定,逻辑与的关系
  • 最多可获取7天内的数据

注意:

  • 接口仅支持POST请求格式

请求语法

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

请求参数

参数名 必选 类型及范围 说明
StartTime String 获取数据起始时间点,日期格式按ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800。默认是一天前时间
EndTime String 结束时间需大于起始时间;获取日期格式按照ISO8601表示法,北京时间,格式为:YYYY-MM-DDThh:mm+0800,例如:2016-08-01T21:14+0800。默认是当前时间
TaskId String 支持按任务ID查询,只允许输入单个任务ID
BlockType String 屏蔽类型,取值, block:屏蔽;unblock:解屏蔽。 不传,默认同时查询屏蔽和解屏蔽
DomainName String 支持按域名查询,只允许输入单个域名
Urls Url[] Url组成的数组, 支持按Url路径查询,准确匹配
PageSize Long 分页大小,取值为1-50,最大50,默认20
PageNumber Long 取得第几页,取值为:1-100000,最大100000,默认1

Url

参数名 必选 类型及范围 说明
Url {} 需要查询的Url路径

返回参数

参数名 类型及范围 说明
StartTime Long 开始时间
EndTime Long 结束时间
PageSize Long 整页大小
PageNumber Long 页码
TotalCount Long Url总条数
Datas UrlData[] 任务进度百分比及状态信息

UrlData

参数名 类型及范围 说明
TaskId String 任务Id
BlockType String 屏蔽类型,取值, block:屏蔽URL;unblock:解除屏蔽
Url String 屏蔽的Url地址
Progress Double 任务进度百分比数值。状态为屏蔽中时,为屏蔽的进度;状态为解除屏蔽中时,为解除屏蔽的进度;状态为刷新中时,为刷新的进度。
BlockUrlStatus String 状态信息,取值见附录
BlockTime String Url屏蔽/解屏蔽的操作时间
ExpireTime String 过期自动解除屏蔽的时间。当 BlockType = unblock ,为空值
Submitter String 屏蔽提交者,取值为:customer:客户提交;ksyun:金山云封禁;ISMS:信息安全管理系统封禁

示例

请求示例

post方式

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

{
"Urls":[{"Url":"http://www.zhaofang360.com/abc.txt"},{"Url":"http://www.zhaofang360.com/abc.ed"}]
}

返回示例

{
"StartTime": "2016-09-01T17:55+0800",
"EndTime": "2016-09-02T17:55+0800",
"PageSize":1,
"PageNumber":2,
"TotalCount":10,
"Datas":
[
{
"TaskId": "ad07ce4f-59a5-4c32-b857-2d8ac9a929b8",
"BlockType":"block",
"Url":"http://www.zhaofang360.com/abc.txt",
"Progress":22.0,
"BlockUrlStatus":"blocking",
"BlockTime":"2016-09-01T19:13+0800",
"ExpireTime":"2016-09-08T19:13+0800",
"Submitter":"ksyun"
},
{
"TaskId": "26ba2c41-6f00-438f-b268-30be326f131c",
"BlockType":"block",
"Url":"http://www.zhaofang360.com/abc.ed",
"Progress":22.0,
"BlockUrlStatus":"blocking",
"BlockTime":"2016-09-01T19:13+0800",
"ExpireTime":"2016-09-08T19:13+0800",
"Submitter":"ksyun"
},
]
}

UrlData

BlockUrlStatus结构体

屏蔽URL状态BlockUrlStatus包括:

  • 屏蔽中 - blocking
  • 屏蔽完成 - block_success
  • 屏蔽失败 - block_fail
  • 解除屏蔽中 - unblocking
  • 解除屏蔽完成(该API不返回)- unblock_success
  • 解除屏蔽失败 - ublock_fail
  • 刷新中 - refreshing
  • 刷新完成(该API不返回) - refresh_success
  • 刷新失败 - refresh_fail

金山云,开启您的云计算之旅

免费注册