查询预取任务列表

更新时间:2023-04-04 20:19:20

适用产品

CDN Pro

接口描述

获取预取请求列表。

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Params 参数

参数名称描述
startdateString
RFC 3339格式的日期,表示查询的开始时间。必须为UTC时间,如'2021-03-01T01:00:00Z'。
enddateString
RFC 3339格式的日期,表示查询的结束时间。必须为UTC时间,如'2021-03-01T01:00:00Z'。
offsetInteger
默认值: 0 取值范围: >= 0 查询起始位置。
limitInteger
默认值: 100 取值范围: <= 200 每次查询的最大条数。
sortByString
取值范围: submissionTime,finishTime 返回查询结果的排序依据。默认按预取请求的创建时间降序排序。
sortOrderString
取值范围: asc,desc 返回查询结果的排序顺序。默认按预取请求的创建时间降序排序。
searchString
根据搜索关键字匹配预取请求的名称、ID和相关的加速域名,过滤预取请求。

返回参数

Body 参数

参数名称描述
countInteger
取值范围: >= 0 预取请求的总数。该数量取决于查询参数。
prefetchRequestsList
预取请求列表。
idString
预取请求的ID。
nameString
预取请求的简短描述。
statusString
取值范围: waiting,inprogress,finished 预取请求的任务执行状态,包括等待中,进行中,已完成等状态。
submissionTimeString
RFC 3339格式的日期,表示预取请求的提交时间。
finishTimeString
RFC 3339格式的日期,表示预取任务的完成时间。
successRateInteger
取值范围: [ 0 .. 100 ] 预取任务的成功率。
apiRequestIdString
API请求ID。
fileEntriesInteger
取值范围: >= 1 预取请求中的URL数量。
hostnamesList
预取请求涉及的加速域名。

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidListLimitThe value of limit should be between 1 and 200, inclusive.400limit参数取值范围必须在1-200之间。
InvalidSortByThe valid sort by values for this endpoint are 'submissionTime', 'finishTime'.400sortBy参数取值只允许'submissionTime'和'finishTime'。
InvalidSortOrderThe valid sort order values are asc and desc.400sortOrder参数取值只允许'acs', 'desc'。
InvalidStartDateInvalid parameter 'startdate'. 'a' is not a valid RFC3339 timestamp in UTC. The timestamp should be in "yyyy-MM-dd'T'HH:mm:ss'Z'" format.400startdate参数无效。必须是RFC3339 日期格式,采用UTC时区。具体格式为"yyyy-MM-dd'T'HH:mm:ss'Z'"。
InvalidListOffsetThe offset must be a valid non-negative integer.400offset参数必须是大于等于零的整数。

示例

200
400
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/prefetches" \
-X "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json"
返回示例
复制代码 复制成功
{
    "count": 2,
    "prefetchRequests": [
        {
            "apiRequestId": "889c2c5a2d9d93ce",
            "fileEntries": 2,
            "hostnames": [
                "example.com"
            ],
            "id": "4f8553f7f30942fd8a2d247f05db3602",
            "name": "another prefetch request",
            "status": "waiting",
            "submissionTime": "2021-03-05T00:34:28Z",
            "successRate": 0
        },
        {
            "apiRequestId": "39ac9855a7a7d547",
            "fileEntries": 2,
            "finishTime": "2021-03-04T23:30:28Z",
            "hostnames": [
                "example2.com"
            ],
            "id": "17b36e2902544776a6e0043ce622ab10",
            "name": "my new prefetch request",
            "status": "finished",
            "submissionTime": "2021-03-04T23:30:07Z",
            "successRate": 100
        }
    ]
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!