方法列表
创建IP
dns
user
node
admin
RPC
createIPItem (CreateIPItemRequest) returns (CreateIPItemResponse)
HTTP
POST /IPItemService/createIPItem
输入对象：CreateIPItemRequest：
{

	// 所属IP列表ID
	int64 ipListId;

	// IP原始值，比如单个IP、IP范围或者CIDR，指定了原始值后，无需设置ipFrom和ipTo两个参数
	string value;

	// 开始IP
	string ipFrom;

	// 结束IP（可选）
	string ipTo;

	// 过期时间戳（可选）
	int64 expiredAt;

	// 加入理由（可选）
	string reason;

	// IP类型，值为ipv4或ipv6
	string type;

	// 级别：debug, notice, warning, error, critical, fatal
	string eventLevel;


	// 可选项，所属节点ID
	int64 nodeId;

	// 可选项，所属网站ID
	int64 serverId;


	// 可选项，来源节点
	int64 sourceNodeId;

	// 可选项，来源网站ID
	int64 sourceServerId;

	// 可选项，来源WAF策略ID
	int64 sourceHTTPFirewallPolicyId;

	// 可选项，来源WAF规则分组ID
	int64 sourceHTTPFirewallRuleGroupId;

	// 可选项，来源WAF规则集ID
	int64 sourceHTTPFirewallRuleSetId;
}
输出对象：CreateIPItemResponse：
{
	int64 ipItemId;
}
创建一组IP
dns
user
node
admin
RPC
createIPItems (CreateIPItemsRequest) returns (CreateIPItemsResponse)
HTTP
POST /IPItemService/createIPItems
输入对象：CreateIPItemsRequest：
{

	// 要创建的IP列表
	[]IPItem ipItems;


	 IPItem {

		// IP列表ID
		int64 ipListId;

		// IP原始值，比如单个IP、IP范围或者CIDR，指定了原始值后，无需设置ipFrom和ipTo两个参数
		string value;

		// 开始IP
		string ipFrom;

		// 结束IP（可选）
		string ipTo;

		// 过期时间戳（可选）
		int64 expiredAt;

		// 加入理由（可选）
		string reason;

		// 类型
		string type;

		// 级别
		string eventLevel;


		// 所属节点ID
		int64 nodeId;

		// 所属服务ID
		int64 serverId;
		int64 sourceNodeId;
		int64 sourceServerId;
		int64 sourceHTTPFirewallPolicyId;
		int64 sourceHTTPFirewallRuleGroupId;
		int64 sourceHTTPFirewallRuleSetId;
	}
}
输出对象：CreateIPItemsResponse：
{

	// 创建后的IP ID列表
	[]int64 ipItemIds;
}
修改IP
admin
user
RPC
updateIPItem (UpdateIPItemRequest) returns (RPCSuccess)
HTTP
POST /IPItemService/updateIPItem
输入对象：UpdateIPItemRequest：
{
	int64 ipItemId;

	// IP原始值，比如单个IP、IP范围或者CIDR，指定了原始值后，无需设置ipFrom和ipTo两个参数
	string value;

	// 开始IP
	string ipFrom;

	// 结束IP（可选）
	string ipTo;
	int64 expiredAt;
	string reason;

	// 类型
	string type;

	// 级别
	string eventLevel;
}
输出对象：RPCSuccess：
{

}
删除IP
admin
user
RPC
deleteIPItem (DeleteIPItemRequest) returns (RPCSuccess)
HTTP
POST /IPItemService/deleteIPItem
输入对象：DeleteIPItemRequest：
{

	// IP条目的ID
	int64 ipItemId;


	// IP原始值，比如单个IP、IP范围或者CIDR，指定了原始值后，无需设置ipFrom和ipTo两个参数
	string value;

	// v0.4.8新增，开始IP，和ipItemId二选一
	string ipFrom;

	// v0.4.8新增，结束IP，和ipItemId二选一
	string ipTo;

	// v0.4.8新增，IP列表，IP所在的IP列表，如果不指定，则会删除所有IP列表中的相关IP信息
	int64 ipListId;
}
输出对象：RPCSuccess：
{

}
批量删除IP
admin
user
RPC
deleteIPItems (DeleteIPItemsRequest) returns (RPCSuccess)
HTTP
POST /IPItemService/deleteIPItems
输入对象：DeleteIPItemsRequest：
{
	[]int64 ipItemIds;
}
输出对象：RPCSuccess：
{

}
计算IP数量
admin
user
RPC
countIPItemsWithListId (CountIPItemsWithListIdRequest) returns (RPCCountResponse)
HTTP
POST /IPItemService/countIPItemsWithListId
输入对象：CountIPItemsWithListIdRequest：
{
	int64 ipListId;

	// 关键词
	string keyword;
	string ipFrom;
	string ipTo;
	string eventLevel;
}
输出对象：RPCCountResponse：
{

	// 数量
	int64 count;
}
列出单页的IP
admin
user
RPC
listIPItemsWithListId (ListIPItemsWithListIdRequest) returns (ListIPItemsWithListIdResponse)
HTTP
POST /IPItemService/listIPItemsWithListId
输入对象：ListIPItemsWithListIdRequest：
{
	int64 ipListId;

	// 关键词
	string keyword;
	string ipFrom;
	string ipTo;
	string eventLevel;

	// 读取位置
	int64 offset;

	// 数量，通常不能小于0
	int64 size;
}
输出对象：ListIPItemsWithListIdResponse：
{
	[]IPItem ipItems;
}
查找单个IP
admin
user
RPC
findEnabledIPItem (FindEnabledIPItemRequest) returns (FindEnabledIPItemResponse)
HTTP
POST /IPItemService/findEnabledIPItem
输入对象：FindEnabledIPItemRequest：
{
	int64 ipItemId;
}
输出对象：FindEnabledIPItemResponse：
{
	IPItem ipItem;
}
根据版本列出一组IP
node
admin
RPC
listIPItemsAfterVersion (ListIPItemsAfterVersionRequest) returns (ListIPItemsAfterVersionResponse)
HTTP
POST /IPItemService/listIPItemsAfterVersion
输入对象：ListIPItemsAfterVersionRequest：
{

	// 版本号
	int64 version;

	// 数量
	int64 size;
}
输出对象：ListIPItemsAfterVersionResponse：
{
	[]IPItem ipItems;

	// 新的版本号
	int64 version;
}
检查IP状态
admin
RPC
checkIPItemStatus (CheckIPItemStatusRequest) returns (CheckIPItemStatusResponse)
HTTP
POST /IPItemService/checkIPItemStatus
输入对象：CheckIPItemStatusRequest：
{
	int64 ipListId;
	string ip;
}
输出对象：CheckIPItemStatusResponse：
{

	// 是否查询成功
	bool isOk;
	string error;

	// 是否找到
	bool isFound;

	// 是否允许
	bool isAllowed;

	// 匹配的IPItem
	IPItem ipItem;
}
检查IP是否存在
admin
RPC
existsEnabledIPItem (ExistsEnabledIPItemRequest) returns (ExistsEnabledIPItemResponse)
HTTP
POST /IPItemService/existsEnabledIPItem
输入对象：ExistsEnabledIPItemRequest：
{
	int64 ipItemId;
}
输出对象：ExistsEnabledIPItemResponse：
{
	bool exists;
}
计算所有IP数量
admin
user
RPC
countAllEnabledIPItems (CountAllEnabledIPItemsRequest) returns (RPCCountResponse)
HTTP
POST /IPItemService/countAllEnabledIPItems
输入对象：CountAllEnabledIPItemsRequest：
{

	// 关键词
	string keyword;

	// 单个IP，搜索单个IP时需要
	string ip;

	// 是否为自动添加的IP
	bool globalOnly;

	// 是否未读
	bool unread;

	// 事件级别
	string eventLevel;

	// 列表类型：black|white
	string listType;

	// 用户ID，只有管理员才有权限指定用户ID
	int64 userId;
}
输出对象：RPCCountResponse：
{

	// 数量
	int64 count;
}
列出所有名单中的IP
admin
user
RPC
listAllEnabledIPItems (ListAllEnabledIPItemsRequest) returns (ListAllEnabledIPItemsResponse)
HTTP
POST /IPItemService/listAllEnabledIPItems
输入对象：ListAllEnabledIPItemsRequest：
{

	// 关键词
	string keyword;

	// 单个IP，搜索单个IP时需要
	string ip;

	// 是否为自动添加的IP
	bool globalOnly;

	// 是否未读
	bool unread;

	// 事件级别
	string eventLevel;

	// 列表类型：black|white
	string listType;

	// 用户ID，只有管理员才有权限指定用户ID
	int64 userId;

	// 读取位置，从0开始
	int64 offset;

	// 每次读取数量
	int64 size;
}
输出对象：ListAllEnabledIPItemsResponse：
{
	[]Result results;


	 Result {

		// 所属名单
		IPList ipList;

		// IP信息
		IPItem ipItem;

		// 所属服务
		Server server;

		// 所属WAF策略
		HTTPFirewallPolicy httpFirewallPolicy;
	}
}
列出所有名单中的IP ID
admin
user
RPC
listAllIPItemIds (ListAllIPItemIdsRequest) returns (ListAllIPItemIdsResponse)
HTTP
POST /IPItemService/listAllIPItemIds
输入对象：ListAllIPItemIdsRequest：
{

	// 关键词
	string keyword;

	// 单个IP，搜索单个IP时需要
	string ip;

	// 是否为自动添加的IP
	bool globalOnly;

	// 是否未读
	bool unread;

	// 事件级别
	string eventLevel;

	// 列表类型：black|white
	string listType;

	// 用户ID，只有管理员才有权限指定用户ID
	int64 userId;

	// 读取位置，从0开始
	int64 offset;

	// 每次读取数量
	int64 size;
}
输出对象：ListAllIPItemIdsResponse：
{

	// IP ID列表
	[]int64 ipItemIds;
}
设置所有为已读
admin
user
RPC
updateIPItemsRead (UpdateIPItemsReadRequest) returns (RPCSuccess)
HTTP
POST /IPItemService/updateIPItemsRead
输入对象：UpdateIPItemsReadRequest：
{

}
输出对象：RPCSuccess：
{

}
查找IP对应的名单所属网站ID
admin
user
RPC
findServerIdWithIPItemId (FindServerIdWithIPItemIdRequest) returns (FindServerIdWithIPItemIdResponse)
HTTP
POST /IPItemService/findServerIdWithIPItemId
输入对象：FindServerIdWithIPItemIdRequest：
{

	// IP ID
	int64 ipItemId;
}
输出对象：FindServerIdWithIPItemIdResponse：
{

	// 网站ID
	int64 serverId;
}