TRKJ/EdgeCommon
2
0
Fork 0
mirror of https://github.com/TeaOSLab/EdgeCommon.git synced 2025-12-29 06:16:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

完善API注释

Browse Source
This commit is contained in:
GoEdgeLab
2023-06-16 18:27:16 +08:00
parent f62e96bdff
commit e79384e109
12 changed files with 519 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
pkg/rpc/protos/service_server.proto
View File

@@ -11,7 +11,7 @@ import "models/model_user_plan.proto";
// 网站服务相关服务
service ServerService {
// 创建服务
// 创建网站
rpc createServer (CreateServerRequest) returns (CreateServerResponse);
// 修改服务基本信息
@@ -177,31 +177,31 @@ service ServerService {
rpc copyServerConfig(CopyServerConfigRequest) returns (RPCSuccess);
}
// 创建服务
// 创建网站
message CreateServerRequest {
int64 userId = 1;
int64 adminId = 2;
string type = 3;
string name = 4;
string description = 5;
int64 userId = 1; // 可选参数，用户ID，如果不想指定用户，此值可以为0
int64 adminId = 2; // 可选参数，管理员ID
string type = 3; // 类型：httpProxy（HTTP反向代理，一般CDN服务都选这个）、httpWeb（静态文件服务，只会从服务器上读取文件内容，不会转发到源站）、tcpProxy（TCP反向代理）、udpProxy（UDP反向代理）
string name = 4; // 网站名称，通常可以是一个域名
string description = 5; // 可选参数，网站描述
// 配置相关
bytes serverNamesJSON = 8; // @link json:server_names
bytes serverNamesJSON = 8; // 域名列表 @link json:server_names
bytes serverNamesJON = 19 [deprecated = true]; // 已过期，请使用 serverNamesJSON 代替
bytes httpJSON = 9;
bytes httpsJSON = 10;
bytes tcpJSON = 11;
bytes tlsJSON = 12;
bytes unixJSON = 13;
bytes udpJSON = 14;
int64 webId = 15;
bytes reverseProxyJSON = 16;
repeated int64 serverGroupIds = 17;
int64 userPlanId = 18;
bytes httpJSON = 9; // HTTP协议，当type为httpProxy或者httpWeb时填写 @link json:http_protocol
bytes httpsJSON = 10; // HTTPS协议，当type为httpProxy或者httpWeb时填写 @link json:https_protocol
bytes tcpJSON = 11; // TCP协议，当type为tcpProxy时填写 @link json:tcp_protocol
bytes tlsJSON = 12; // TLS协议，当type为tcpProxy时填写 @link json:tls_protocol
bytes unixJSON = 13; // 备用参数，不用填写
bytes udpJSON = 14; // UDP协议，当type为udpProxy时填写 @link json:udp_protocol
int64 webId = 15; // 可选参数，Web配置ID，当type为httpProxy或者httpWeb时填写，可以通过 /HTTPWebService/createHTTPWeb 接口创建；如果你需要配置缓存等信息时需要在 HTTPWebService 接口操作
bytes reverseProxyJSON = 16; // 反向代理（包含源站）设置
repeated int64 serverGroupIds = 17; // 所属网站分组ID列表
int64 userPlanId = 18; // 可选参数，套餐ID
int64 nodeClusterId = 30;
bytes includeNodesJSON = 31;
bytes excludeNodesJSON = 32;
int64 nodeClusterId = 30; // 所部署的集群ID
bytes includeNodesJSON = 31; // 备用参数，不用填写
bytes excludeNodesJSON = 32; // 备用参数，不用填写
}
message CreateServerResponse {