全部文档
当前文档

暂无内容

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

文档中心

屏蔽URL进度查询接口

最近更新时间:2022-03-17 17:10:27

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/content/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

{
    "TaskId": "444e575c-6661-4baf-939a-0a657f8444f9"
}

返回示例

{
    "StartTime": "2022-03-14T16:48+0800",
    "EndTime": "2022-03-15T16:48+0800",
    "PageSize": 50,
    "PageNumber": 1,
    "TotalCount": 2,
    "Datas": [
        {
            "TaskId": "444e575c-6661-4baf-939a-0a657f8444f9",
            "BlockType": "block",
            "Url": "http://wcdn-20220304-1.ksc-test.com/abc.txt",
            "Progress": 0.0,
            "BlockUrlStatus": "blocking",
            "BlockTime": "2022-03-15T16:47+0800",
            "ExpireTime": "2022-03-15T17:47+0800",
            "Submitter": "ksyun"
        },
        {
            "TaskId": "444e575c-6661-4baf-939a-0a657f8444f9",
            "BlockType": "block",
            "Url": "http://wcdn-20220304-1.ksc-test.com/txa.txt",
            "Progress": 0.0,
            "BlockUrlStatus": "blocking",
            "BlockTime": "2022-03-15T16:47+0800",
            "ExpireTime": "2022-03-15T17:47+0800",
            "Submitter": "ksyun"
        }
    ]
}

错误码

为了帮您快速定位问题,WCDN将错误码集中归类,请到【使用须知】查看详情。

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

纯净模式

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