WAFGO正在准备页面
接入指南

API 文档

开发者资源 · API 参考

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

下载 JSON 文档
69 个服务354 个接口
IP条目管理找到 13 个接口

创建IP

createIPItem

POST/IPItemService/createIPItem
原始定义
rpc createIPItem (CreateIPItemRequest) returns (CreateIPItemResponse);

请求消息

CreateIPItemRequest

创建IP

请求消息 · 字段定义
message CreateIPItemRequest {
	int64 ipListId = 1; // 所属IP列表ID
	string value = 15; // IP原始值,比如单个IP、IP范围或者CIDR,指定了原始值后,无需设置ipFrom和ipTo两个参数
	string ipFrom = 2; // 开始IP
	string ipTo = 3; // 结束IP(可选)
	int64 expiredAt = 4; // 过期时间戳(可选)
	string reason = 5; // 加入理由(可选)
	string type = 6; // IP类型,值为ipv4或ipv6
	string eventLevel = 7; // 级别:debug, notice, warning, error, critical, fatal

	int64 nodeId = 8; // 可选项,所属节点ID
	int64 serverId = 9; // 可选项,所属网站ID

	int64 sourceNodeId = 10; // 可选项,来源节点
	int64 sourceServerId = 11;  // 可选项,来源网站ID
	int64 sourceHTTPFirewallPolicyId = 12; // 可选项,来源WAF策略ID
	int64 sourceHTTPFirewallRuleGroupId = 13; // 可选项,来源WAF规则分组ID
	int64 sourceHTTPFirewallRuleSetId = 14; // 可选项,来源WAF规则集ID
}

响应消息

CreateIPItemResponse
响应消息 · 字段定义
message CreateIPItemResponse {
	int64 ipItemId = 1;
}

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

接入指南