WAFGO正在准备页面
接入指南

API 文档

开发者资源 · API 参考

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

下载 JSON 文档
69 个服务354 个接口

入门指南

服务和方法

了解 WAFGO 如何组织 API,并把服务名、方法名与 HTTP 接口地址组合成完整请求地址。示例用于说明调用格式,请替换为实际节点地址和业务参数。

什么是服务

API 按功能划分为服务。名称通常以 Service 结尾,例如 ServerService 负责网站相关操作,HTTPAccessLogService 负责访问日志相关操作。

左侧服务目录用于按功能查找接口;目录中的中文或英文说明便于阅读,实际调用仍使用原始服务名,不能用翻译后的目录名称替换。

服务名称示例
ServerService
HTTPAccessLogService
APINodeService

服务下的方法

每个服务可以包含多个方法,每个方法对应一项具体操作。例如,ServerService 提供创建网站、修改基本信息和调整网站分组等方法。

方法的可用角色可能不同。请查看详情中的可用角色和请求消息,不要因为两个方法属于同一服务,就认为它们具有相同权限或参数。

createServer
创建网站;当前接口定义允许管理员和平台用户调用。
updateServerBasic
修改网站基本信息;当前接口定义仅允许管理员调用。
updateServerGroupIds
修改网站所属分组;当前接口定义允许管理员和平台用户调用。

组合 HTTP 调用地址

通过 HTTP 调用时,在已配置的 HTTP API 基础地址后依次添加服务名和方法名,以斜杠分隔。服务名、方法名及大小写均以接口文档给出的 HTTP 路径为准。

例如,HTTP API 基础地址为 http://192.168.2.100 时,创建网站的方法地址如下。该 IP 仅为示例,请替换为自己的 API 节点 HTTP 地址。

地址组成
API接口地址/服务名/方法名
创建网站的 HTTP 地址示例
http://192.168.2.100/ServerService/createServer

阅读方法定义

rpc 声明依次给出方法名、请求消息类型和响应消息类型。下面的定义表示 createServer 接收 CreateServerRequest,并返回 CreateServerResponse。字段含义需继续查看这两种消息的具体定义。

proto3 描述消息结构和 RPC 接口;它本身不规定本平台的 HTTP 地址拼接、认证 Header 或 POST 调用规则。HTTP 调用方式由 API 节点的 HTTP 服务提供,应同时遵循调用概述与认证文档。

createServer 的原始 RPC 定义
rpc createServer (CreateServerRequest) returns (CreateServerResponse);

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

接入指南