查询刷新任务详情
更新时间：2023-04-04 20:21:56
适用产品
CDN Pro
接口描述
获取刷新请求的详细信息，包括涉及的加速域名和刷新任务的执行状态等。
- 调用URL： https://open.chinanetcenter.com/cdn/purges/*
- 调用方法：GET
调用频率
单用户调用频率：300/5min
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Path 参数
| 参数名称 | 描述 |
|---|---|
*idString | 刷新任务的ID。 |
返回参数
Body 参数
| 参数名称 | 描述 |
|---|---|
nameString | 刷新请求的名称。 |
fileUrlsList | 被刷新的文件。 |
fileHeadersList | 如果文件的缓存键与请求头相关，则可以指定请求头和值来刷新相应的缓存文件。此处指定的请求头和值将应用于fileUrls中的所有条目。 |
nameString | HTTP头部名称。 |
valueString | HTTP头部值。 |
dirUrlsList | <= 20 条目
被刷新的目录。 |
dirHeadersList | 如果目录的缓存键与请求头相关，则可以指定请求头和值来刷新相应的缓存目录。此处指定的请求头和值将应用于dirUrls中的所有条目。 |
nameString | HTTP头部名称。 |
valueString | HTTP头部值。 |
regexPatternsList | <= 2 条目
用于匹配缓存键的正则表达式。每一个表达式必须以以下格式开始:
{协议}://{域名}/. {协议}可以是http, https或any（表示不限协议）。
示例:
https://test.domain.com/my.*\.(jpg|png)\?q=
出于性能考虑，使用正则表达式有以下限制： 在域名后面的正则表达式最多只能包含126个字符。 最多只能包含两个限定符('*'、'+'或',}')。 限定符的上限不能超过59，例如{1,59} |
targetString | 取值范围: staging, production
刷新任务对应的环境，即演练环境或生产环境。 |
submissionTimeString | RFC 3339格式的日期，表示刷新请求的创建时间。 |
successRateInteger | 取值范围: [ 0 .. 100 ]
刷新请求任务的成功率。 |
statusString | 取值范围: waiting, inprogress, finished
刷新请求的任务执行状态，包括等待中，执行中，已完成等状态。 |
actionString | 取值范围: delete, invalidate
刷新请求的类型，包括完全删除(delete)和标记为无效(invalidate)。 |
finishTimeString | RFC 3339格式的日期，表示刷新任务完成的时间。如果刷新还在进行中，则返回空值。 |
apiRequestIdString | API请求ID。 |
webhookString | 刷新任务完成时要调用的webhook的ID。 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| InvalidPurgeTaskId | The specified purge task ID does not exist. | 404 | 指定的刷新任务ID不存在。 |
示例
200
- 请求示例 复制成功
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "https://open.chinanetcenter.com/cdn/purges/{id}" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json"- 返回示例 复制成功
{ "submissionTime": "2019-11-21T12:00:42Z", "finishTime": "2019-11-21T12:03:47Z", "status": "finished", "fileUrls": [ "http://download.info/sun.jpg" ], "fileHeaders": [ { "name": "customheader1", "value": "test1" } ], "dirUrls": [ "http://download.info/*.png" ], "action": "invalidate", "target": "production", "apiRequestId": "38738aeb12406c27", "customerId": 10000021, "successRate": 100 }
本篇文档内容对您是否有帮助？
有帮助
我要反馈