Skip to content

POST /api/v1/projects/{projectId}/files/purge

POST/api/v1/projects/{projectId}/files/purge

刷新 CDN 缓存(需 admin 及以上,API Key 不可用;异步 cdn:purge 任务)

projectoperationId: projectFilePurge

请求参数

名称类型位置必填说明
projectIdstringpath是项目 ID(UUID)。携带 `X-API-Key` 时按 API Key scope 鉴权,否则按 JWT + 项目成员角色鉴权

请求体

请求数据

Content-Type · application/json

{
  "type": "object",
  "required": [
    "storage_id",
    "keys"
  ],
  "properties": {
    "storage_id": {
      "type": "string",
      "format": "uuid",
      "description": "须属于本项目"
    },
    "keys": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "非空"
    }
  }
}

请求示例

cURL
curl -X POST 'http://localhost:8080/api/v1/projects/{projectId}/files/purge' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: <PROJECT_API_KEY>'
# 也可使用登录会话:-H 'Authorization: Bearer <JWT>'
JavaScript
const res = await fetch('http://localhost:8080/api/v1/projects/{projectId}/files/purge', {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'X-API-Key': '<PROJECT_API_KEY>'
  },
});
const data = await res.json();
Python
import requests

res = requests.post(
    'http://localhost:8080/api/v1/projects/{projectId}/files/purge',
    headers={'Accept': 'application/json', 'X-API-Key': '<PROJECT_API_KEY>'}
)
print(res.json())

响应

200已入队

application/json

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "example": "queued"
    }
  }
}
400请求参数错误

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}
403无权限(未通过 RBAC 或 2FA)

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}

在线调试

在线调试
凭证仅保存在当前页面内存中
自定义请求 Header