清除缓存¶

1. 接口描述¶

接口请求路径：POST /prod-api/acdn/ccdn/cacheRest/purgeCache

purgeCache 用于清除指定主域名下的节点缓存，支持按 URL、主机名、缓存标记和前缀四种方式。账号需具备 ccdn:domain:edit 权限。

Token 获取方式见密钥鉴权。

注意：

zoneId 为域名 Zone ID，取自查询域名列表返回的 rows[].zoneId。

清除缓存可能会使网站性能暂时降级，并延长在源服务器上加载文件的时间。

上游清除未成功时，本接口仍返回 code 为 200、msg 为 成功，是否成功以 data 为准。

2. 输入参数¶

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

参数名称	必选	类型	描述
zoneId	是	String	域名 Zone ID。示例值：`551290393816e70c5e9765ca020e30a4`
type	是	String	清除方式。取值：`files`（按 URL 清除）、`hosts`（按主机名清除）、`tags`（按缓存标记清除）、`prefixes`（按前缀清除）。示例值：`files`
data	是	Array of String	清除内容，与 `type` 对应。示例值：`["https://www.example.com/a.js"]`

data 元素要求：

type	元素说明
`files`	完整 URL（含 `http://` 或 `https://`），与 URL 完全匹配才清除，不支持通配符，一次最多 30 个
`hosts`	主机名，URL 中主机与之匹配的任何缓存资产都将清除，一次最多 100 个
`tags`	缓存标记（Cache-Tag），一次最多 100 个
`prefixes`	URL 前缀，一次最多 100 个

3. 输出参数¶

参数名称	类型	描述
code	Integer	状态码。示例值：`200`
msg	String	提示信息。示例值：`成功`
data	Boolean	上游清除结果。`true` 成功，`false` 失败。示例值：`true`

4. 示例¶

示例1 按 URL 清除缓存¶

输入示例¶

{
  "zoneId": "551290393816e70c5e9765ca020e30a4",
  "type": "files",
  "data": [
    "https://www.example.com/css/style.css",
    "https://www.example.com/js/app.js"
  ]
}

代码调用¶

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

cURLJavaGo

curl -X POST 'https://{登录域名}/prod-api/acdn/ccdn/cacheRest/purgeCache' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "zoneId": "551290393816e70c5e9765ca020e30a4",
  "type": "files",
  "data": [
    "https://www.example.com/css/style.css",
    "https://www.example.com/js/app.js"
  ]
}'

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

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

        String requestBody = "{"
                + "\"zoneId\":\"551290393816e70c5e9765ca020e30a4\","
                + "\"type\":\"files\","
                + "\"data\":[\"https://www.example.com/css/style.css\",\"https://www.example.com/js/app.js\"]"
                + "}";

        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/ccdn/cacheRest/purgeCache"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "zoneId": "551290393816e70c5e9765ca020e30a4",
  "type": "files",
  "data": [
    "https://www.example.com/css/style.css",
    "https://www.example.com/js/app.js"
  ]
}`)

    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": true
}

5. 错误码¶

参数校验失败时，code 为 500，原因在 msg，没有 data。

HTTP 状态码 / 业务提示	描述
200	请求已返回。须再看 `data`
401	未鉴权或 Token 无效
403	无权限，需具备 `ccdn:domain:edit`
类型[type]不能为空	未传 `type`
状态[type]只能为files、hosts、tags、prefixes	`type` 取值不合法
数据[data]不能为空	未传 `data`
区域ID[zoneId]不能为空	未传 `zoneId`