跳转至

添加缓存刷新任务

1. 接口描述

接口请求路径:POST /prod-api/multiCdn/cache/addCachePurges

addCachePurges 用于为指定域名创建缓存刷新任务。

Token 获取方式见 密钥鉴权

2. 输入参数

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

参数名称 必选 类型 描述
domainGrnId String 域名唯一 ID
示例值:grn:test:multi-cdn:279:domain/0745d675d9409df7e1291408e553de8e
contents Array of String 待刷新的 URL 或路径列表。例如:/test/test/file.jpg/test/*https://example.com/file.jpg。清除泛域名缓存时需传入完整 URL
示例值:["https://demo.dev.com/test/file.jpg"]

3. 示例

示例1 添加缓存刷新任务

输入示例

{
  "domainGrnId": "grn:test:multi-cdn:279:domain/0745d675d9409df7e1291408e553de8e",
  "contents": ["https://demo.dev.com/test/file.jpg", "/test/*"]
}

代码调用

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

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

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

        String requestBody = "{"
                + "\"domainGrnId\":\"grn:test:multi-cdn:279:domain/0745d675d9409df7e1291408e553de8e\","
                + "\"contents\":[\"https://demo.dev.com/test/file.jpg\",\"/test/*\"]"
                + "}";

        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/multiCdn/cache/addCachePurges"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "domainGrnId": "grn:test:multi-cdn:279:domain/0745d675d9409df7e1291408e553de8e",
  "contents": ["https://demo.dev.com/test/file.jpg", "/test/*"]
}`)

    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
}

4. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:操作成功

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
更新缓存刷新任务失败:缓存内容不能为空 contents 为空或未传
更新缓存刷新任务失败 创建或更新任务失败
更新缓存刷新任务失败:缓存内容[{0}]不属于当前域名[{1}] 刷新内容不属于当前域名