查询刷新任务¶

1. 接口描述¶

接口请求路径：POST /prod-api/acdn/dcdn/refreshCacheRest/describeRefreshTasks

describeRefreshTasks 用于分页查询指定 DCDN 域名下的刷新/预热任务列表，可按操作类型与任务状态筛选。

Token 获取方式见密钥鉴权。

2. 输入参数¶

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
domainName	是	String	加速域名。为空时接口直接返回成功且无任务数据示例值：`demo.ruisuyun.com`
objectType	是	String	操作类型，支持以下值： `file`：URL 刷新 `directory`：目录刷新 `regex`：正则刷新 `preload`：URL 预热示例值：`file`
pageNum	是	Integer	当前页数示例值：`1`
pageSize	是	Integer	每页显示条目个数示例值：`10`
status	否	String	任务状态，支持以下值： `Complete`：完成 `Refreshing`：刷新中 `Failed`：刷新失败示例值：`Complete`
params	否	Object	预留扩展查询参数；无额外条件时可传 `{}`

3. 示例¶

示例1 按域名查询已完成的 URL 刷新任务¶

输入示例¶

{
  "pageSize": 10,
  "objectType": "file",
  "domainName": "demo.ruisuyun.com",
  "status": "Complete",
  "params": {},
  "pageNum": 1
}

代码调用¶

请将 {登录域名}、token 替换为实际值。

JavaGo

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 DescribeRefreshTasksTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/acdn/dcdn/refreshCacheRest/describeRefreshTasks";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"pageSize\":10,"
                + "\"objectType\":\"file\","
                + "\"domainName\":\"demo.ruisuyun.com\","
                + "\"status\":\"Complete\","
                + "\"params\":{},"
                + "\"pageNum\":1"
                + "}";

        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/dcdn/refreshCacheRest/describeRefreshTasks"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "pageSize": 10,
  "objectType": "file",
  "domainName": "demo.ruisuyun.com",
  "status": "Complete",
  "params": {},
  "pageNum": 1
}`)

    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))
}

输出示例¶

{
  "msg": "操作成功",
  "code": 200,
  "data": {
    "total": 1,
    "rows": [
      {
        "taskId": "17671439116",
        "status": "Complete",
        "process": "100%",
        "objectType": "file",
        "objectPath": "https://demo.123.com/",
        "description": "",
        "creationTime": "2024-01-25 18:03:38"
      }
    ]
  }
}

4. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`操作成功`
data	Object	任务分页结果
data.total	Integer	符合条件的总条数。示例值：`1`
data.rows	Array	任务列表
data.rows[].taskId	String	任务 ID。示例值：`17671439116`
data.rows[].status	String	任务状态。示例值：`Complete`
data.rows[].process	String	进度。示例值：`100%`
data.rows[].objectType	String	操作类型。示例值：`file`
data.rows[].objectPath	String	操作内容（URL/目录/正则）。示例值：`https://demo.123.com/`
data.rows[].description	String	任务描述
data.rows[].creationTime	String	创建时间，格式 `yyyy-MM-dd HH:mm:ss` 示例值：`2024-01-25 18:03:38`

5. 错误码¶

HTTP 状态码 / 业务提示	描述
200	成功
401	未鉴权或 Token 无效
403	无权限
请输入查询参数	请求体为空
请输入查询类别	未传入 `objectType`
请输入页码	未传入 `pageNum`
请输入分页参数	未传入 `pageSize`
域名信息不存在	`domainName` 不存在或不属于当前账号