查询刷新任务列表
更新时间：2023-04-04 20:22:42
适用产品
CDN Pro
接口描述
获取刷新请求列表。
- 调用URL： https://open.chinanetcenter.com/cdn/purges
- 调用方法：GET
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Params 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
startdate | String | 否 | RFC 3339格式的日期，表示查询的开始时间。必须为UTC时间，如'2019-11-01T01:00:00Z'。 |
enddate | String | 否 | RFC 3339格式的日期，表示查询的结束时间。必须为UTC时间，如'2019-11-01T01:00:00Z'。 |
offset | Integer | 否 | 默认值: 0 取值范围: >= 0 查询起始位置。 |
limit | Integer | 否 | 默认值: 100 取值范围: <= 200 每次查询的最大条数。 |
sortBy | String | 否 | 取值范围: submissionTime, finishTime 默认值: submissionTime 返回结果的排序依据。默认按刷新请求的创建时间降序排序。 |
sortOrder | String | 否 | 取值范围: asc, desc 默认值: desc 返回结果的排序顺序。 |
search | String | 否 | 根据搜索关键字匹配加速域名和刷新任务的ID进行过滤。 |
target | String | 否 | 取值范围: production, staging 根据部署环境来查询刷新请求。默认返回所有环境的刷新请求。 |
action | String | 否 | 取值范围: invalidate, delete 刷新请求的类型。默认返回所有类型的刷新请求。 |
maxSuccessRate | Integer | 否 | 取值范围: [ 0 .. 100 ] 指定最大成功率来查询刷新任务，以十进制值表示。默认返回所有刷新请求。 |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
count | Integer | 取值范围: >= 0 刷新请求的总数。该数值取决于查询参数。 |
purgeRequests | List | 刷新请求列表。 |
id | String | 刷新请求的ID。您可以调用'查询刷新任务详情'接口来获得更多信息。 |
submissionTime | String | RFC 3339格式的日期，表示刷新请求的创建时间。 |
hostnames | List | 刷新请求涉及的加速域名。 |
fileEntries | Integer | 取值范围: >= 0 刷新请求中文件URL的数量。 |
dirEntries | Integer | 取值范围: [ 0 .. 20 ] 刷新请求中目录URL的数量。 |
target | String | 取值范围: staging, production 刷新请求对应的环境，即演练环境或生产环境。 |
successRate | Integer | 取值范围: [ 0 .. 100 ] 刷新请求任务的成功率。 |
status | String | 取值范围: waiting, inprogress, finished 刷新请求的执行状态，包括等待中，进行中，已完成等状态。 |
finishTime | String | RFC 3339格式的日期，表示刷新完成的时间。如果刷新还在进行中，则返回空值。 |
apiRequestId | String | API请求ID。 |
regexEntries | Integer | 取值范围: >= 0 刷新请求中正则表达式的条数。 |
variedFiles | Integer | 取值范围: >= 0 刷新请求中，因源站Vary头部而缓存了多个副本的文件的数量。此类文件的刷新将按照目录方式刷新，并计入目录刷新配额。 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| InvalidListLimit | The value of limit should be an integer. | 400 | limit参数取值必须是整数。 |
| InvalidStartDate | Invalid parameter 'startdate'. 'b' is not a valid RFC3339 timestamp in UTC. The timestamp should be in "yyyy-MM-dd'T'HH:mm:ss'Z'" format. | 400 | startdate参数无效。必须是 RFC3339 日期格式，并采用UTC时区。参考格式："yyyy-MM-dd'T'HH:mm:ss'Z'"。 |
| InvalidSortOrder | The valid sort order values are asc or desc. | 400 | sortOrder参数无效。必须是 'asc'或'desc'。 |
示例
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" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json"
- 返回示例 复制成功
{ "count": 34, "purgeRequests": [ { "id": "7e0a09aa-d341-47a8-82f3-50c1389c106d", "submissionTime": "2019-05-22T08:30:54Z", "finishTime": "2019-05-22T08:35:56Z", "target": "production", "status": "finished", "action": "delete", "apiRequestId": "a104b7ad6ab2e91f", "fileEntries": 1, "dirEntries": 0, "variedFiles": 0, "successRate": 100, "hostnames": [ "mydomain.com" ] }, { "id": "65d634c3-38ec-4a05-ac58-db195a40bece", "submissionTime": "2019-05-22T08:30:39Z", "finishTime": "2019-05-22T08:36:42Z", "target": "staging", "status": "finished", "action": "delete", "apiRequestId": "049ee33603dc1aab", "fileEntries": 1, "dirEntries": 0, "variedFiles": 0, "successRate": 100, "hostnames": [ "dana2.com" ] }, { "id": "a517e611-ed85-4da4-9c6c-62d25237459e", "submissionTime": "2019-05-22T08:29:34Z", "finishTime": "2019-05-22T08:32:28Z", "target": "staging", "status": "finished", "action": "invalidate", "apiRequestId": "646163723701dbfc", "fileEntries": 1, "dirEntries": 0, "variedFiles": 0, "successRate": 100, "hostnames": [ "mydomain.com" ] } ] }
本篇文档内容对您是否有帮助？
有帮助
我要反馈