获取预热任务列表¶
1. 接口描述¶
接口请求路径:POST /prod-api/acdn/tcdn/content/describePushTasks
describePushTasks 用于分页查询指定域名下的 URL 预热任务列表。URL / 目录刷新历史请使用 describeContentTasks。查询域名须属于当前账号。账号需具备 tcdn:DescribeCachePurges 权限。
Token 获取方式见 密钥鉴权。
2. 输入参数¶
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| domain | 是 | String | 加速域名,须属于当前账号。示例值:lw111.demo.com |
| pageNum | 否 | Integer | 当前页。默认值:1。示例值:1 |
| pageSize | 否 | Integer | 每页条数。默认值:10。示例值:10 |
| params | 否 | Params | 时间筛选 |
| searchHeader | 否 | SearchHeader | 表头筛选 |
3. 输出参数¶
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Integer | 状态码。示例值:200 |
| msg | String | 提示信息。示例值:success |
| total | Integer | 任务总条数。示例值:1 |
| rows | [PushLog] | 当前页预热任务列表 |
4. 示例¶
示例1 查询预热任务¶
输入示例¶
{
"domain": "lw111.demo.com",
"pageNum": 1,
"pageSize": 10,
"params": {
"beginTime": "2025-10-15 00:00:00",
"endTime": "2025-10-15 23:59:59"
},
"searchHeader": {}
}
代码调用¶
请将 {登录域名}、token 替换为实际值。
curl -X POST 'https://{登录域名}/prod-api/acdn/tcdn/content/describePushTasks' \
-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
-H 'Content-Type: application/json' \
-d '{
"domain": "lw111.demo.com",
"pageNum": 1,
"pageSize": 10,
"params": {
"beginTime": "2025-10-15 00:00:00",
"endTime": "2025-10-15 23:59:59"
},
"searchHeader": {}
}'
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class DescribePushTasksTest {
public static void main(String[] args) throws Exception {
String url = "https://{登录域名}/prod-api/acdn/tcdn/content/describePushTasks";
String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";
String requestBody = "{"
+ "\"domain\":\"lw111.demo.com\","
+ "\"pageNum\":1,"
+ "\"pageSize\":10,"
+ "\"params\":{\"beginTime\":\"2025-10-15 00:00:00\",\"endTime\":\"2025-10-15 23:59:59\"},"
+ "\"searchHeader\":{}"
+ "}";
try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
HttpPost httpPost = new HttpPost(url);
httpPost.setHeader("Authorization", "Bearer " + token);
httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));
try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
int statusCode = response.getStatusLine().getStatusCode();
String body = EntityUtils.toString(response.getEntity(), "UTF-8");
System.out.println("Status Code: " + statusCode);
System.out.println("Body: " + body);
}
}
}
}
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{登录域名}/prod-api/acdn/tcdn/content/describePushTasks"
token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"
requestBody := []byte(`{
"domain": "lw111.demo.com",
"pageNum": 1,
"pageSize": 10,
"params": {
"beginTime": "2025-10-15 00:00:00",
"endTime": "2025-10-15 23:59:59"
},
"searchHeader": {}
}`)
req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
panic(err)
}
fmt.Println("Status Code:", resp.StatusCode)
fmt.Println("Body:", string(body))
}
输出示例¶
{
"total": 1,
"rows": [
{
"taskId": "153303185323131331",
"url": "http://www.test.com/test.html",
"status": "done",
"percent": 100,
"createTime": "2025-10-15 18:10:53",
"area": "mainland",
"updateTime": "2025-10-15 18:11:20"
}
],
"code": 200,
"msg": "success"
}
5. 错误码¶
| HTTP 状态码 / 业务提示 | 描述 |
|---|---|
| 200 | 成功 |
| 401 | 未鉴权或 Token 无效 |
| 403 | 无权限 |
| 域名不能为空 | 未传入 domain |
| 域名不属于你 | 指定域名未接入或不属于当前账号 |
| error code:{0},message:{1} | 上游查询失败,{0} 为错误码,{1} 为原因 |
6. 数据模型¶
Params¶
时间筛选。格式为 yyyy-MM-dd HH:mm:ss。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| beginTime | 否 | String | 开始时间。示例值:2025-10-15 00:00:00 |
| endTime | 否 | String | 结束时间。示例值:2025-10-15 23:59:59 |
SearchHeader¶
表头筛选。字段均可省略;省略或空字符串表示不按该条件过滤。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| status | 否 | String | 任务状态。取值:done(完成)、process(预热中)、fail(失败)、invalid(预热无效,源站返回 4xx/5xx)。示例值:done |
PushLog¶
预热任务记录。
| 参数名称 | 类型 | 描述 |
|---|---|---|
| taskId | String | 预热任务 ID。示例值:153303185323131331 |
| url | String | 预热的 URL。示例值:http://www.test.com/test.html |
| status | String | 任务状态。取值:done(完成)、process(预热中)、fail(失败)、invalid(预热无效,源站返回 4xx/5xx)。示例值:done |
| percent | Integer | 预热进度百分比。示例值:100 |
| createTime | String | 任务提交时间。示例值:2025-10-15 18:10:53 |
| area | String | 预热地域。取值:mainland(中国境内)、overseas(中国境外)、global(全球)。示例值:mainland |
| updateTime | String | 任务更新时间,可能为 null。示例值:2025-10-15 18:11:20 |