TRKJ/EdgeCommon
2
0
Fork 0
mirror of https://github.com/TeaOSLab/EdgeCommon.git synced 2025-11-03 20:40:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

完善API文档

Browse Source
This commit is contained in:
GoEdgeLab
2023-10-09 08:45:44 +08:00
parent 5eca60d7de
commit 8075093e39
3 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
build/rpc.json
View File

@@ -14997,7 +14997,7 @@
}, },
{ {
"name": "CreateIPItemRequest", "name": "CreateIPItemRequest",
"code": "message CreateIPItemRequest {\n\tint64 ipListId = 1; // IP列表ID\n\tstring ipFrom = 2; // 开始IP\n\tstring ipTo = 3; // 结束IP（可选）\n\tint64 expiredAt = 4; // 过期时间戳（可选）\n\tstring reason = 5; // 加入理由（可选）\n\tstring type = 6; // 类型\n\tstring eventLevel = 7; // 级别\n\n\tint64 nodeId = 8; // 所属节点ID\n\tint64 serverId = 9; // 所属服务ID\n\n\tint64 sourceNodeId = 10;\n\tint64 sourceServerId = 11;\n\tint64 sourceHTTPFirewallPolicyId = 12;\n\tint64 sourceHTTPFirewallRuleGroupId = 13;\n\tint64 sourceHTTPFirewallRuleSetId = 14;\n}", "code": "message CreateIPItemRequest {\n\tint64 ipListId = 1; // 所属IP列表ID\n\tstring ipFrom = 2; // 开始IP\n\tstring ipTo = 3; // 结束IP（可选）\n\tint64 expiredAt = 4; // 过期时间戳（可选）\n\tstring reason = 5; // 加入理由（可选）\n\tstring type = 6; // IP类型，值为ipv4或ipv6\n\tstring eventLevel = 7; // 级别：debug, notice, warning, error, critical, fatal\n\n\tint64 nodeId = 8; // 可选项，所属节点ID\n\tint64 serverId = 9; // 可选项，所属网站ID\n\n\tint64 sourceNodeId = 10; // 可选项，来源节点\n\tint64 sourceServerId = 11; // 可选项，来源网站ID\n\tint64 sourceHTTPFirewallPolicyId = 12; // 可选项，来源WAF策略ID\n\tint64 sourceHTTPFirewallRuleGroupId = 13; // 可选项，来源WAF规则分组ID\n\tint64 sourceHTTPFirewallRuleSetId = 14; // 可选项，来源WAF规则集ID\n}",
"doc": "创建IP" "doc": "创建IP"
}, },
{ {

28
pkg/rpc/pb/service_ip_item.pb.go
View File

@@ -26,20 +26,20 @@ type CreateIPItemRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
IpListId int64 `protobuf:"varint,1,opt,name=ipListId,proto3" json:"ipListId,omitempty"` // IP列表ID IpListId int64 `protobuf:"varint,1,opt,name=ipListId,proto3" json:"ipListId,omitempty"` // 所属IP列表ID
IpFrom string `protobuf:"bytes,2,opt,name=ipFrom,proto3" json:"ipFrom,omitempty"` // 开始IP IpFrom string `protobuf:"bytes,2,opt,name=ipFrom,proto3" json:"ipFrom,omitempty"` // 开始IP
IpTo string `protobuf:"bytes,3,opt,name=ipTo,proto3" json:"ipTo,omitempty"` // 结束IP（可选） IpTo string `protobuf:"bytes,3,opt,name=ipTo,proto3" json:"ipTo,omitempty"` // 结束IP（可选）
ExpiredAt int64 `protobuf:"varint,4,opt,name=expiredAt,proto3" json:"expiredAt,omitempty"` // 过期时间戳（可选） ExpiredAt int64 `protobuf:"varint,4,opt,name=expiredAt,proto3" json:"expiredAt,omitempty"` // 过期时间戳（可选）
Reason string `protobuf:"bytes,5,opt,name=reason,proto3" json:"reason,omitempty"` // 加入理由（可选） Reason string `protobuf:"bytes,5,opt,name=reason,proto3" json:"reason,omitempty"` // 加入理由（可选）
Type string `protobuf:"bytes,6,opt,name=type,proto3" json:"type,omitempty"` // 类型 Type string `protobuf:"bytes,6,opt,name=type,proto3" json:"type,omitempty"` // IP类型，值为ipv4或ipv6
EventLevel string `protobuf:"bytes,7,opt,name=eventLevel,proto3" json:"eventLevel,omitempty"` // 级别 EventLevel string `protobuf:"bytes,7,opt,name=eventLevel,proto3" json:"eventLevel,omitempty"` // 级别：debug, notice, warning, error, critical, fatal
NodeId int64 `protobuf:"varint,8,opt,name=nodeId,proto3" json:"nodeId,omitempty"` // 所属节点ID NodeId int64 `protobuf:"varint,8,opt,name=nodeId,proto3" json:"nodeId,omitempty"` // 可选项，所属节点ID
ServerId int64 `protobuf:"varint,9,opt,name=serverId,proto3" json:"serverId,omitempty"` // 所属服务ID ServerId int64 `protobuf:"varint,9,opt,name=serverId,proto3" json:"serverId,omitempty"` // 可选项，所属网站ID
SourceNodeId int64 `protobuf:"varint,10,opt,name=sourceNodeId,proto3" json:"sourceNodeId,omitempty"` SourceNodeId int64 `protobuf:"varint,10,opt,name=sourceNodeId,proto3" json:"sourceNodeId,omitempty"` // 可选项，来源节点
SourceServerId int64 `protobuf:"varint,11,opt,name=sourceServerId,proto3" json:"sourceServerId,omitempty"` SourceServerId int64 `protobuf:"varint,11,opt,name=sourceServerId,proto3" json:"sourceServerId,omitempty"` // 可选项，来源网站ID
SourceHTTPFirewallPolicyId int64 `protobuf:"varint,12,opt,name=sourceHTTPFirewallPolicyId,proto3" json:"sourceHTTPFirewallPolicyId,omitempty"` SourceHTTPFirewallPolicyId int64 `protobuf:"varint,12,opt,name=sourceHTTPFirewallPolicyId,proto3" json:"sourceHTTPFirewallPolicyId,omitempty"` // 可选项，来源WAF策略ID
SourceHTTPFirewallRuleGroupId int64 `protobuf:"varint,13,opt,name=sourceHTTPFirewallRuleGroupId,proto3" json:"sourceHTTPFirewallRuleGroupId,omitempty"` SourceHTTPFirewallRuleGroupId int64 `protobuf:"varint,13,opt,name=sourceHTTPFirewallRuleGroupId,proto3" json:"sourceHTTPFirewallRuleGroupId,omitempty"` // 可选项，来源WAF规则分组ID
SourceHTTPFirewallRuleSetId int64 `protobuf:"varint,14,opt,name=sourceHTTPFirewallRuleSetId,proto3" json:"sourceHTTPFirewallRuleSetId,omitempty"` SourceHTTPFirewallRuleSetId int64 `protobuf:"varint,14,opt,name=sourceHTTPFirewallRuleSetId,proto3" json:"sourceHTTPFirewallRuleSetId,omitempty"` // 可选项，来源WAF规则集ID
} }
func (x *CreateIPItemRequest) Reset() { func (x *CreateIPItemRequest) Reset() {

20
pkg/rpc/protos/service_ip_item.proto
View File

@@ -56,22 +56,22 @@ service IPItemService {
// 创建IP // 创建IP
message CreateIPItemRequest { message CreateIPItemRequest {
int64 ipListId = 1; // IP列表ID int64 ipListId = 1; // 所属IP列表ID
string ipFrom = 2; // 开始IP string ipFrom = 2; // 开始IP
string ipTo = 3; // 结束IP（可选） string ipTo = 3; // 结束IP（可选）
int64 expiredAt = 4; // 过期时间戳（可选） int64 expiredAt = 4; // 过期时间戳（可选）
string reason = 5; // 加入理由（可选） string reason = 5; // 加入理由（可选）
string type = 6; // 类型 string type = 6; // IP类型，值为ipv4或ipv6
string eventLevel = 7; // 级别 string eventLevel = 7; // 级别：debug, notice, warning, error, critical, fatal
int64 nodeId = 8; // 所属节点ID int64 nodeId = 8; // 可选项，所属节点ID
int64 serverId = 9; // 所属服务ID int64 serverId = 9; // 可选项，所属网站ID
int64 sourceNodeId = 10; int64 sourceNodeId = 10; // 可选项，来源节点
int64 sourceServerId = 11; int64 sourceServerId = 11; // 可选项，来源网站ID
int64 sourceHTTPFirewallPolicyId = 12; int64 sourceHTTPFirewallPolicyId = 12; // 可选项，来源WAF策略ID
int64 sourceHTTPFirewallRuleGroupId = 13; int64 sourceHTTPFirewallRuleGroupId = 13; // 可选项，来源WAF规则分组ID
int64 sourceHTTPFirewallRuleSetId = 14; int64 sourceHTTPFirewallRuleSetId = 14; // 可选项，来源WAF规则集ID
} }
message CreateIPItemResponse { message CreateIPItemResponse {