WAFGO正在准备页面
接入指南

API 文档

开发者资源 · API 参考

查阅 WAFGO API 的服务、请求路径和消息定义。按权限角色浏览接口,快速找到接入所需的参数与返回结构。

下载 JSON 文档
69 个服务354 个接口
缓存任务管理找到 6 个接口

创建任务

createHTTPCacheTask

POST/HTTPCacheTaskService/createHTTPCacheTask
原始定义
rpc createHTTPCacheTask(CreateHTTPCacheTaskRequest) returns (CreateHTTPCacheTaskResponse);

请求消息

CreateHTTPCacheTaskRequest

创建任务

请求消息 · 字段定义
message CreateHTTPCacheTaskRequest {
	string type = 1; // 任务类型,值为 purge 或者 fetch;purge:删除缓存,fetch:预热缓存
	string keyType = 2; // Key类型,值为 key 或者 prefix;如果是 key 表示处理的是URL,如果是 prefix 表示处理的是目录;预热的时候只能为 key
	repeated string keys = 3; // 要清理的Key,根据Key类型(keyType)来输入不同的内容
}

响应消息

CreateHTTPCacheTaskResponse
响应消息 · 字段定义
message CreateHTTPCacheTaskResponse {
	int64 httpCacheTaskId = 1; // 生成的任务ID
	int64 countKeys = 2; // 任务中包含的Key
}

说明与注释按当前语言显示。接口路径、方法名、字段名和类型与原始接口定义保持一致。

接入指南