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

部分部分API文档

Browse Source
This commit is contained in:
刘祥超
2024-01-21 14:40:07 +08:00
parent 7073467128
commit 5f9e7e981c
3 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
build/rpc.json
View File

@@ -15845,12 +15845,12 @@
}, },
{ {
"name": "CreateNodeRequest", "name": "CreateNodeRequest",
"code": "message CreateNodeRequest {\n\tstring name = 1;\n\tint64 nodeClusterId = 2;\n\tNodeLogin nodeLogin = 3;\n\tint64 nodeGroupId = 4;\n\tint64 dnsDomainId = 5 [deprecated = true];\n\trepeated string dnsRoutes = 6;\n\tint64 nodeRegionId = 7;\n}", "code": "message CreateNodeRequest {\n\tstring name = 1; // 节点名称\n\tint64 nodeClusterId = 2; // 节点所属集群\n\tNodeLogin nodeLogin = 3; // 节点登录信息\n\tint64 nodeGroupId = 4; // 节点所属分组\n\tint64 dnsDomainId = 5 [deprecated = true]; // 节点域名ID，此参数已过期，请不要再使用\n\trepeated string dnsRoutes = 6; // 节点DNS线路列表\n\tint64 nodeRegionId = 7; // 节点所属区域\n}",
"doc": "创建节点" "doc": "创建节点"
}, },
{ {
"name": "CreateNodeResponse", "name": "CreateNodeResponse",
"code": "message CreateNodeResponse {\n\tint64 nodeId = 1;\n}", "code": "message CreateNodeResponse {\n\tint64 nodeId = 1; // 节点ID\n}",
"doc": "" "doc": ""
}, },
{ {
@@ -18285,12 +18285,12 @@
}, },
{ {
"name": "FindEnabledBasicNodeRequest", "name": "FindEnabledBasicNodeRequest",
"code": "message FindEnabledBasicNodeRequest {\n\tint64 nodeId = 1;\n}", "code": "message FindEnabledBasicNodeRequest {\n\tint64 nodeId = 1; // 节点ID\n}",
"doc": "获取单个节点基本信息" "doc": "获取单个节点基本信息"
}, },
{ {
"name": "FindEnabledBasicNodeResponse", "name": "FindEnabledBasicNodeResponse",
"code": "message FindEnabledBasicNodeResponse {\n\tBasicNode node = 1;\n}", "code": "message FindEnabledBasicNodeResponse {\n\tBasicNode node = 1; // 节点基本信息\n}",
"doc": "" "doc": ""
}, },
{ {
@@ -18775,12 +18775,12 @@
}, },
{ {
"name": "FindEnabledNodeRequest", "name": "FindEnabledNodeRequest",
"code": "message FindEnabledNodeRequest {\n\tint64 nodeId = 1;\n}", "code": "message FindEnabledNodeRequest {\n\tint64 nodeId = 1; // 节点ID\n}",
"doc": "获取单个节点信息" "doc": "获取单个节点信息"
}, },
{ {
"name": "FindEnabledNodeResponse", "name": "FindEnabledNodeResponse",
"code": "message FindEnabledNodeResponse {\n\tNode node = 1;\n}", "code": "message FindEnabledNodeResponse {\n\tNode node = 1; // 节点信息\n}",
"doc": "" "doc": ""
}, },
{ {

24
pkg/rpc/pb/service_node.pb.go
View File

@@ -26,14 +26,14 @@ type CreateNodeRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // 节点名称
NodeClusterId int64 `protobuf:"varint,2,opt,name=nodeClusterId,proto3" json:"nodeClusterId,omitempty"` NodeClusterId int64 `protobuf:"varint,2,opt,name=nodeClusterId,proto3" json:"nodeClusterId,omitempty"` // 节点所属集群
NodeLogin *NodeLogin `protobuf:"bytes,3,opt,name=nodeLogin,proto3" json:"nodeLogin,omitempty"` NodeLogin *NodeLogin `protobuf:"bytes,3,opt,name=nodeLogin,proto3" json:"nodeLogin,omitempty"` // 节点登录信息
NodeGroupId int64 `protobuf:"varint,4,opt,name=nodeGroupId,proto3" json:"nodeGroupId,omitempty"` NodeGroupId int64 `protobuf:"varint,4,opt,name=nodeGroupId,proto3" json:"nodeGroupId,omitempty"` // 节点所属分组
// Deprecated: Marked as deprecated in service_node.proto. // Deprecated: Marked as deprecated in service_node.proto.
DnsDomainId int64 `protobuf:"varint,5,opt,name=dnsDomainId,proto3" json:"dnsDomainId,omitempty"` DnsDomainId int64 `protobuf:"varint,5,opt,name=dnsDomainId,proto3" json:"dnsDomainId,omitempty"` // 节点域名ID，此参数已过期，请不要再使用
DnsRoutes []string `protobuf:"bytes,6,rep,name=dnsRoutes,proto3" json:"dnsRoutes,omitempty"` DnsRoutes []string `protobuf:"bytes,6,rep,name=dnsRoutes,proto3" json:"dnsRoutes,omitempty"` // 节点DNS线路列表
NodeRegionId int64 `protobuf:"varint,7,opt,name=nodeRegionId,proto3" json:"nodeRegionId,omitempty"` NodeRegionId int64 `protobuf:"varint,7,opt,name=nodeRegionId,proto3" json:"nodeRegionId,omitempty"` // 节点所属区域
} }
func (x *CreateNodeRequest) Reset() { func (x *CreateNodeRequest) Reset() {
@@ -123,7 +123,7 @@ type CreateNodeResponse struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
NodeId int64 `protobuf:"varint,1,opt,name=nodeId,proto3" json:"nodeId,omitempty"` NodeId int64 `protobuf:"varint,1,opt,name=nodeId,proto3" json:"nodeId,omitempty"` // 节点ID
} }
func (x *CreateNodeResponse) Reset() { func (x *CreateNodeResponse) Reset() {
@@ -903,7 +903,7 @@ type FindEnabledNodeRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
NodeId int64 `protobuf:"varint,1,opt,name=nodeId,proto3" json:"nodeId,omitempty"` NodeId int64 `protobuf:"varint,1,opt,name=nodeId,proto3" json:"nodeId,omitempty"` // 节点ID
} }
func (x *FindEnabledNodeRequest) Reset() { func (x *FindEnabledNodeRequest) Reset() {
@@ -950,7 +950,7 @@ type FindEnabledNodeResponse struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
Node *Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"` Node *Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"` // 节点信息
} }
func (x *FindEnabledNodeResponse) Reset() { func (x *FindEnabledNodeResponse) Reset() {
@@ -998,7 +998,7 @@ type FindEnabledBasicNodeRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
NodeId int64 `protobuf:"varint,1,opt,name=nodeId,proto3" json:"nodeId,omitempty"` NodeId int64 `protobuf:"varint,1,opt,name=nodeId,proto3" json:"nodeId,omitempty"` // 节点ID
} }
func (x *FindEnabledBasicNodeRequest) Reset() { func (x *FindEnabledBasicNodeRequest) Reset() {
@@ -1045,7 +1045,7 @@ type FindEnabledBasicNodeResponse struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
Node *BasicNode `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"` Node *BasicNode `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"` // 节点基本信息
} }
func (x *FindEnabledBasicNodeResponse) Reset() { func (x *FindEnabledBasicNodeResponse) Reset() {

24
pkg/rpc/protos/service_node.proto
View File

@@ -212,17 +212,17 @@ service NodeService {
// 创建节点 // 创建节点
message CreateNodeRequest { message CreateNodeRequest {
string name = 1; string name = 1; // 节点名称
int64 nodeClusterId = 2; int64 nodeClusterId = 2; // 节点所属集群
NodeLogin nodeLogin = 3; NodeLogin nodeLogin = 3; // 节点登录信息
int64 nodeGroupId = 4; int64 nodeGroupId = 4; // 节点所属分组
int64 dnsDomainId = 5 [deprecated = true]; int64 dnsDomainId = 5 [deprecated = true]; // 节点域名ID，此参数已过期，请不要再使用
repeated string dnsRoutes = 6; repeated string dnsRoutes = 6; // 节点DNS线路列表
int64 nodeRegionId = 7; int64 nodeRegionId = 7; // 节点所属区域
} }
message CreateNodeResponse { message CreateNodeResponse {
int64 nodeId = 1; int64 nodeId = 1; // 节点ID
} }
// 注册集群节点 // 注册集群节点
@@ -308,20 +308,20 @@ message UpdateNodeRequest {
// 获取单个节点信息 // 获取单个节点信息
message FindEnabledNodeRequest { message FindEnabledNodeRequest {
int64 nodeId = 1; int64 nodeId = 1; // 节点ID
} }
message FindEnabledNodeResponse { message FindEnabledNodeResponse {
Node node = 1; Node node = 1; // 节点信息
} }
// 获取单个节点基本信息 // 获取单个节点基本信息
message FindEnabledBasicNodeRequest { message FindEnabledBasicNodeRequest {
int64 nodeId = 1; int64 nodeId = 1; // 节点ID
} }
message FindEnabledBasicNodeResponse { message FindEnabledBasicNodeResponse {
BasicNode node = 1; BasicNode node = 1; // 节点基本信息
} }
// 组合单个节点配置 // 组合单个节点配置