Files
EdgeCommon/pkg/rpc/protos/service_server.proto

782 lines
24 KiB
Protocol Buffer
Raw Normal View History

2020-09-13 19:27:47 +08:00
syntax = "proto3";
option go_package = "./pb";
package pb;
2020-09-17 10:15:55 +08:00
import "models/model_server.proto";
import "models/model_dns_domain.proto";
import "models/model_server_name_auditing_result.proto";
import "models/rpc_messages.proto";
2021-11-28 20:11:54 +08:00
import "models/model_user_plan.proto";
2020-09-13 19:27:47 +08:00
2022-06-22 14:36:33 +08:00
// 网站服务相关服务
2020-09-13 19:27:47 +08:00
service ServerService {
2023-06-16 18:27:16 +08:00
// 创建网站
2020-09-13 19:27:47 +08:00
rpc createServer (CreateServerRequest) returns (CreateServerResponse);
2023-06-18 16:19:52 +08:00
// 快速创建基本的HTTP网站
rpc createBasicHTTPServer(CreateBasicHTTPServerRequest) returns (CreateBasicHTTPServerResponse);
2023-06-18 17:14:29 +08:00
// 快速创建基本的TCP网站
rpc createBasicTCPServer(CreateBasicTCPServerRequest) returns (CreateBasicTCPServerResponse);
2023-06-18 10:57:07 +08:00
// 修改网站基本信息
rpc updateServerBasic (UpdateServerBasicRequest) returns (RPCSuccess);
2022-08-26 19:51:12 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站所在分组
rpc updateServerGroupIds(UpdateServerGroupIdsRequest) returns (RPCSuccess);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站是否启用
2020-12-23 10:30:42 +08:00
rpc updateServerIsOn (UpdateServerIsOnRequest) returns (RPCSuccess);
2023-06-18 10:57:07 +08:00
// 修改网站的HTTP设置
rpc updateServerHTTP (UpdateServerHTTPRequest) returns (RPCSuccess);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站的HTTPS设置
rpc updateServerHTTPS (UpdateServerHTTPSRequest) returns (RPCSuccess);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站的TCP设置
rpc updateServerTCP (UpdateServerTCPRequest) returns (RPCSuccess);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站的TLS设置
rpc updateServerTLS (UpdateServerTLSRequest) returns (RPCSuccess);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站的Unix设置
rpc updateServerUnix (UpdateServerUnixRequest) returns (RPCSuccess);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站的UDP设置
rpc updateServerUDP (UpdateServerUDPRequest) returns (RPCSuccess);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站的Web设置
rpc updateServerWeb (UpdateServerWebRequest) returns (RPCSuccess);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站的反向代理设置
rpc updateServerReverseProxy (UpdateServerReverseProxyRequest) returns (RPCSuccess);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 查找网站的域名设置
rpc findServerNames (FindServerNamesRequest) returns (FindServerNamesResponse);
2023-06-18 10:57:07 +08:00
// 修改网站的域名设置
rpc updateServerNames (UpdateServerNamesRequest) returns (RPCSuccess);
2020-09-13 19:27:47 +08:00
2023-06-18 10:57:07 +08:00
// 审核网站的域名设置
2020-12-23 10:30:42 +08:00
rpc updateServerNamesAuditing (UpdateServerNamesAuditingRequest) returns (RPCSuccess);
2023-06-18 10:57:07 +08:00
// 修改网站的DNS相关设置
2021-10-16 12:03:44 +08:00
rpc updateServerDNS(UpdateServerDNSRequest) returns (RPCSuccess);
// 重新生成CNAME
2022-08-26 19:51:12 +08:00
rpc regenerateServerDNSName(RegenerateServerDNSNameRequest) returns (RPCSuccess);
2023-06-18 10:57:07 +08:00
// 修改网站的CNAME
2022-08-26 19:51:12 +08:00
rpc updateServerDNSName(UpdateServerDNSNameRequest) returns (RPCSuccess);
2023-06-18 10:57:07 +08:00
// 使用CNAME查找网站
2022-08-26 19:51:12 +08:00
rpc findServerIdWithDNSName(FindServerIdWithDNSNameRequest) returns (FindServerIdWithDNSNameResponse);
2021-10-16 12:03:44 +08:00
2023-06-18 10:57:07 +08:00
// 计算匹配的网站数量
2020-11-12 14:41:23 +08:00
rpc countAllEnabledServersMatch (CountAllEnabledServersMatchRequest) returns (RPCCountResponse);
2020-09-13 19:27:47 +08:00
2023-06-18 10:57:07 +08:00
// 列出单页网站
2020-10-31 15:21:35 +08:00
rpc listEnabledServersMatch (ListEnabledServersMatchRequest) returns (ListEnabledServersMatchResponse);
2020-09-13 19:27:47 +08:00
2023-06-18 10:57:07 +08:00
// 禁用某网站
2020-12-23 10:30:42 +08:00
rpc deleteServer (DeleteServerRequest) returns (RPCSuccess);
2020-09-13 19:27:47 +08:00
2023-06-18 10:57:07 +08:00
// 查找单个网站
2020-09-13 19:27:47 +08:00
rpc findEnabledServer (FindEnabledServerRequest) returns (FindEnabledServerResponse);
2020-09-15 14:44:38 +08:00
2023-06-18 10:57:07 +08:00
// 查找网站配置
2020-12-23 10:30:42 +08:00
rpc findEnabledServerConfig (FindEnabledServerConfigRequest) returns (FindEnabledServerConfigResponse);
2023-06-18 10:57:07 +08:00
// 查找网站的网站类型
2020-09-15 14:44:38 +08:00
rpc findEnabledServerType (FindEnabledServerTypeRequest) returns (FindEnabledServerTypeResponse);
// 查找反向代理设置
2020-09-21 11:37:09 +08:00
rpc findAndInitServerReverseProxyConfig (FindAndInitServerReverseProxyConfigRequest) returns (FindAndInitServerReverseProxyConfigResponse);
2020-09-16 09:09:31 +08:00
// 初始化Web设置
2020-09-21 19:52:10 +08:00
rpc findAndInitServerWebConfig (FindAndInitServerWebConfigRequest) returns (FindAndInitServerWebConfigResponse);
2020-09-30 17:46:33 +08:00
2023-06-18 10:57:07 +08:00
// 计算使用某个SSL证书的网站数量
2020-11-12 14:41:23 +08:00
rpc countAllEnabledServersWithSSLCertId (CountAllEnabledServersWithSSLCertIdRequest) returns (RPCCountResponse);
2020-09-30 17:46:33 +08:00
2023-06-18 10:57:07 +08:00
// 查找使用某个SSL证书的所有网站
2020-10-02 17:22:46 +08:00
rpc findAllEnabledServersWithSSLCertId (FindAllEnabledServersWithSSLCertIdRequest) returns (FindAllEnabledServersWithSSLCertIdResponse);
2023-06-18 10:57:07 +08:00
// 计算运行在某个集群上的所有网站数量
2020-11-12 14:41:23 +08:00
rpc countAllEnabledServersWithNodeClusterId (CountAllEnabledServersWithNodeClusterIdRequest) returns (RPCCountResponse);
2020-10-29 20:53:47 +08:00
2023-06-18 10:57:07 +08:00
// 计算使用某个分组的网站数量
2021-05-25 17:08:52 +08:00
rpc countAllEnabledServersWithServerGroupId (CountAllEnabledServersWithServerGroupIdRequest) returns (RPCCountResponse);
// 通知更新
rpc notifyServersChange (NotifyServersChangeRequest) returns (NotifyServersChangeResponse);
2020-11-14 11:05:49 +08:00
2023-06-18 10:57:07 +08:00
// 取得某个集群下的所有网站相关的DNS
2021-05-25 17:08:52 +08:00
rpc findAllEnabledServersDNSWithNodeClusterId (FindAllEnabledServersDNSWithNodeClusterIdRequest) returns (FindAllEnabledServersDNSWithNodeClusterIdResponse);
2020-11-17 11:22:23 +08:00
2023-06-18 10:57:07 +08:00
// 查找单个网站的DNS信息
2020-11-17 11:22:23 +08:00
rpc findEnabledServerDNS (FindEnabledServerDNSRequest) returns (FindEnabledServerDNSResponse);
2020-12-23 10:30:42 +08:00
2023-06-18 10:57:07 +08:00
// 检查网站是否属于某个用户
2020-12-23 10:30:42 +08:00
rpc checkUserServer (CheckUserServerRequest) returns (RPCSuccess);
// 查找一个用户下的所有域名列表
rpc findAllEnabledServerNamesWithUserId (FindAllEnabledServerNamesWithUserIdRequest) returns (FindAllEnabledServerNamesWithUserIdResponse);
2023-09-06 16:31:14 +08:00
// 计算一个用户下的所有域名数量
rpc countAllServerNamesWithUserId (CountAllServerNamesWithUserIdRequest) returns (RPCCountResponse);
// 计算某个网站下的域名数量
rpc countServerNames(CountServerNamesRequest) returns (RPCCountResponse);
2023-06-18 10:57:07 +08:00
// 查找一个用户下的所有网站
rpc findAllUserServers(FindAllUserServersRequest) returns (FindAllUserServersResponse);
2023-09-06 16:31:14 +08:00
// 计算一个用户下的所有网站数量
rpc countAllUserServers(CountAllUserServersRequest) returns (RPCCountResponse);
2023-06-18 10:57:07 +08:00
// 查找某个用户下的网站配置
rpc composeAllUserServersConfig(ComposeAllUserServersConfigRequest) returns (ComposeAllUserServersConfigResponse);
2023-06-18 10:57:07 +08:00
// 查找用户网站基本信息
rpc findEnabledUserServerBasic (FindEnabledUserServerBasicRequest) returns (FindEnabledUserServerBasicResponse);
2023-06-18 10:57:07 +08:00
// 修改用户网站基本信息
rpc updateEnabledUserServerBasic (UpdateEnabledUserServerBasicRequest) returns (RPCSuccess);
// 上传HTTP请求待统计数据
rpc uploadServerHTTPRequestStat (UploadServerHTTPRequestStatRequest) returns (RPCSuccess);
// 检查域名是否在集群中已经存在
rpc checkServerNameDuplicationInNodeCluster (CheckServerNameDuplicationInNodeClusterRequest) returns (CheckServerNameDuplicationInNodeClusterResponse);
2021-05-04 21:02:21 +08:00
// 检查域名是否在网站中已经绑定
rpc checkServerNameInServer(CheckServerNameInServerRequest) returns (CheckServerNameInServerResponse);
2023-06-18 10:57:07 +08:00
// 查找最近访问的网站
2021-05-04 21:02:21 +08:00
rpc findLatestServers (FindLatestServersRequest) returns (FindLatestServersResponse);
2023-06-18 10:57:07 +08:00
// 查找某个网站附近的网站
rpc findNearbyServers(FindNearbyServersRequest) returns (FindNearbyServersResponse);
2021-10-17 17:12:36 +08:00
// 清除缓存
rpc purgeServerCache(PurgeServerCacheRequest) returns (PurgeServerCacheResponse);
2021-11-09 17:36:34 +08:00
// 查找流量限制
rpc findEnabledServerTrafficLimit(FindEnabledServerTrafficLimitRequest) returns (FindEnabledServerTrafficLimitResponse);
2021-11-09 17:36:34 +08:00
// 设置流量限制
rpc updateServerTrafficLimit(UpdateServerTrafficLimitRequest) returns (RPCSuccess);
2021-11-09 15:36:31 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站套餐
2021-11-09 15:36:31 +08:00
rpc updateServerUserPlan(UpdateServerUserPlanRequest) returns (RPCSuccess);
2021-11-28 20:11:54 +08:00
2023-06-18 10:57:07 +08:00
// 获取网站套餐信息
2021-11-28 20:11:54 +08:00
rpc findServerUserPlan(FindServerUserPlanRequest) returns (FindServerUserPlanResponse);
2022-01-19 22:15:52 +08:00
2023-06-18 10:57:07 +08:00
// 获取网站配置
2022-01-19 22:15:52 +08:00
rpc composeServerConfig(ComposeServerConfigRequest) returns (ComposeServerConfigResponse);
2022-03-29 21:24:36 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站UAM设置
2022-03-29 21:24:36 +08:00
rpc updateServerUAM(UpdateServerUAMRequest) returns (RPCSuccess);
2023-06-18 10:57:07 +08:00
// 查找网站UAM设置
2022-03-29 21:24:36 +08:00
rpc findEnabledServerUAM(FindEnabledServerUAMRequest) returns (FindEnabledServerUAMResponse);
2022-12-22 11:42:44 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站所属用户
2022-12-22 11:42:44 +08:00
rpc updateServerUser(UpdateServerUserRequest) returns (RPCSuccess);
2023-03-31 15:30:31 +08:00
2023-06-18 10:57:07 +08:00
// 修改网站名称
2023-03-31 15:30:31 +08:00
rpc updateServerName(UpdateServerNameRequest) returns (RPCSuccess);
2023-06-18 10:57:07 +08:00
// 在网站之间复制配置
rpc copyServerConfig(CopyServerConfigRequest) returns (RPCSuccess);
// 获取域名审核时的提示文字
rpc findServerAuditingPrompt(FindServerAuditingPromptRequest) returns (FindServerAuditingPromptResponse);
2020-09-13 19:27:47 +08:00
}
2023-06-16 18:27:16 +08:00
// 创建网站
2020-09-13 19:27:47 +08:00
message CreateServerRequest {
2023-06-17 21:05:03 +08:00
int64 userId = 1; // 可选项用户ID如果不想指定用户此值可以为0
int64 adminId = 2; // 可选项管理员ID
2023-06-16 18:27:16 +08:00
string type = 3; // 类型httpProxyHTTP反向代理一般CDN服务都选这个、httpWeb静态文件服务只会从服务器上读取文件内容不会转发到源站、tcpProxyTCP反向代理、udpProxyUDP反向代理
string name = 4; // 网站名称,通常可以是一个域名
2023-06-17 21:05:03 +08:00
string description = 5; // 可选项,网站描述
2020-09-15 14:44:38 +08:00
// 配置相关
2023-06-16 18:27:16 +08:00
bytes serverNamesJSON = 8; // 域名列表 @link json:server_names
2023-04-09 20:12:00 +08:00
bytes serverNamesJON = 19 [deprecated = true]; // 已过期,请使用 serverNamesJSON 代替
2023-06-21 08:45:06 +08:00
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
2023-06-16 18:27:16 +08:00
bytes unixJSON = 13; // 备用参数,不用填写
2023-06-21 08:45:06 +08:00
bytes udpJSON = 14; // UDP协议设置当type为udpProxy时填写 @link json:udp_protocol
2023-06-17 21:05:03 +08:00
int64 webId = 15; // 可选项Web配置ID当type为httpProxy或者httpWeb时填写可以通过 /HTTPWebService/createHTTPWeb 接口创建;如果你需要配置缓存等信息时需要在 HTTPWebService 接口操作
bytes reverseProxyJSON = 16; // 反向代理(包含源站)配置引用,此项可以在创建网站后再设置 @link json:reverse_proxy_ref
repeated int64 serverGroupIds = 17; // 可选项所属网站分组ID列表
int64 userPlanId = 18; // 可选项套餐ID
2023-06-16 18:27:16 +08:00
int64 nodeClusterId = 30; // 所部署的集群ID
bytes includeNodesJSON = 31; // 备用参数,不用填写
bytes excludeNodesJSON = 32; // 备用参数,不用填写
2020-09-13 19:27:47 +08:00
}
message CreateServerResponse {
2023-06-18 16:19:52 +08:00
int64 serverId = 1; // 所创建的网站ID
}
// 快速创建基本的HTTP网站
message CreateBasicHTTPServerRequest {
int64 nodeClusterId = 1; // 部署的集群ID用户创建时不需要指定此项
int64 userId = 2; // 管理员创建网站时可以指定此用户ID也可以为0表示不指定
repeated string domains = 3; // 域名列表
repeated int64 sslCertIds = 4; // HTTPS用到的证书ID列表
repeated string originAddrs = 5; // 源站地址列表,每一个源站地址需要带协议部分,比如 http://example.com
bool enableWebsocket = 6; // 可选项是否启用Websocket
}
message CreateBasicHTTPServerResponse {
int64 serverId = 1; // 所创建的网站ID
2020-09-13 19:27:47 +08:00
}
2023-06-18 17:14:29 +08:00
// 快速创建基本的TCP网站
message CreateBasicTCPServerRequest {
int64 nodeClusterId = 1; // 部署的集群ID用户创建时不需要指定此项
int64 userId = 2; // 管理员创建网站时可以指定此用户ID也可以为0表示不指定
repeated int32 tcpPorts = 3; // TCP端口
repeated int32 tlsPorts = 4; // TLS端口
repeated int64 sslCertIds = 5; // TLS用到的证书ID列表
repeated string originAddrs = 6; // 源站地址列表,每一个源站地址需要带协议部分,比如 tcp://example.com, tls://example.com
}
message CreateBasicTCPServerResponse {
int64 serverId = 1; // 所创建的网站ID
}
2023-06-18 10:57:07 +08:00
// 修改网站基本信息
2020-09-15 14:44:38 +08:00
message UpdateServerBasicRequest {
2023-06-18 10:57:07 +08:00
int64 serverId = 1; // 网站ID
string name = 2; // 网站名称
string description = 3; // 可选项,网站描述
int64 nodeClusterId = 4; // 集群ID
bool keepOldConfigs = 7; // 可选项,是否在老节点上保留一段时间配置
bool isOn = 5; // 是否启用
repeated int64 serverGroupIds = 6; // 可选项网站分组ID列表
2020-09-15 14:44:38 +08:00
}
2023-06-18 10:57:07 +08:00
// 修改网站所在分组
message UpdateServerGroupIdsRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
repeated int64 serverGroupIds = 2;
}
2023-06-18 10:57:07 +08:00
// 修改网站启是否启用
2020-12-23 10:30:42 +08:00
message UpdateServerIsOnRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-12-23 10:30:42 +08:00
bool isOn = 2;
}
2023-06-18 10:57:07 +08:00
// 修改网站的HTTP等设置
2020-09-15 14:44:38 +08:00
message UpdateServerHTTPRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
bytes httpJSON = 2; // HTTP协议设置当type为httpProxy或者httpWeb时填写 @link json:http_protocol
2020-09-15 14:44:38 +08:00
}
message UpdateServerHTTPSRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
bytes httpsJSON = 2; // HTTPS协议设置当type为httpProxy或者httpWeb时填写 @link json:https_protocol
2020-09-15 14:44:38 +08:00
}
message UpdateServerTCPRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
bytes tcpJSON = 2; // TCP协议设置当type为tcpProxy时填写 @link json:tcp_protocol
2020-09-15 14:44:38 +08:00
}
message UpdateServerTLSRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
bytes tlsJSON = 2; // TLS协议设置当type为tcpProxy时填写 @link json:tls_protocol
2020-09-15 14:44:38 +08:00
}
message UpdateServerUnixRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-12-23 10:30:42 +08:00
bytes unixJSON = 2;
2020-09-15 14:44:38 +08:00
}
message UpdateServerUDPRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
bytes udpJSON = 2; // UDP协议设置当type为udpProxy时填写 @link json:udp_protocol
2020-09-15 14:44:38 +08:00
}
message UpdateServerWebRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-09-15 14:44:38 +08:00
int64 webId = 2;
2020-09-13 19:27:47 +08:00
}
2023-06-18 10:57:07 +08:00
// 修改网站的反向代理设置
2020-09-15 14:44:38 +08:00
message UpdateServerReverseProxyRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
bytes reverseProxyJSON = 2; // 反向代理(包含源站)配置引用,此项可以在创建网站后再设置 @link json:reverse_proxy_ref
2020-09-15 14:44:38 +08:00
}
2023-06-18 10:57:07 +08:00
// 查找网站的域名设置
message FindServerNamesRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
}
message FindServerNamesResponse {
2023-06-21 08:45:06 +08:00
bytes serverNamesJSON = 1; // 域名列表 @link json:server_names
2020-12-23 10:30:42 +08:00
bool isAuditing = 2;
int64 auditingAt = 5;
2020-12-23 10:30:42 +08:00
bytes auditingServerNamesJSON = 3;
ServerNameAuditingResult auditingResult = 4;
}
2023-06-18 10:57:07 +08:00
// 修改网站的域名设置
2020-09-15 14:44:38 +08:00
message UpdateServerNamesRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
bytes serverNamesJSON = 2; // 域名列表 @link json:server_names
2020-12-23 10:30:42 +08:00
}
2023-06-18 10:57:07 +08:00
// 审核网站的域名设置
2020-12-23 10:30:42 +08:00
message UpdateServerNamesAuditingRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-12-23 10:30:42 +08:00
ServerNameAuditingResult auditingResult = 2;
2020-09-15 14:44:38 +08:00
}
2023-06-18 10:57:07 +08:00
// 修改网站的DNS相关设置
2021-10-16 12:03:44 +08:00
message UpdateServerDNSRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2021-10-16 12:03:44 +08:00
bool supportCNAME = 2;
}
// 重新生成CNAME
2022-08-26 19:51:12 +08:00
message RegenerateServerDNSNameRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2022-08-26 19:51:12 +08:00
}
2023-06-18 10:57:07 +08:00
// 修改网站的CNAME
2022-08-26 19:51:12 +08:00
message UpdateServerDNSNameRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2022-08-26 19:51:12 +08:00
string dnsName = 2;
}
2023-06-18 10:57:07 +08:00
// 使用CNAME查找网站
2022-08-26 19:51:12 +08:00
message FindServerIdWithDNSNameRequest {
int64 nodeClusterId = 1;
string dnsName = 2;
}
message FindServerIdWithDNSNameResponse {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2021-10-16 12:03:44 +08:00
}
2023-06-18 10:57:07 +08:00
// 计算网站数量
2020-10-31 15:21:35 +08:00
message CountAllEnabledServersMatchRequest {
2023-06-18 10:57:07 +08:00
int64 serverGroupId = 1; // 网站分组ID如果为-1表示查找未分组
2020-10-31 15:21:35 +08:00
string keyword = 2;
2020-12-18 21:19:25 +08:00
int64 userId = 3;
2021-05-25 17:08:52 +08:00
int64 nodeClusterId = 4;
2020-12-23 10:30:42 +08:00
int32 auditingFlag = 5;
string protocolFamily = 6;
2023-09-06 16:31:14 +08:00
int64 userPlanId = 7; // 用户套餐ID
2020-09-13 19:27:47 +08:00
}
2023-06-18 10:57:07 +08:00
// 列出单页网站
2020-10-31 15:21:35 +08:00
message ListEnabledServersMatchRequest {
2020-09-13 19:27:47 +08:00
int64 offset = 1;
int64 size = 2;
2023-06-18 10:57:07 +08:00
int64 serverGroupId = 3; // 网站分组ID如果为-1表示查找未分组
2020-10-31 15:21:35 +08:00
string keyword = 4;
2020-12-18 21:19:25 +08:00
int64 userId = 5;
2021-05-25 17:08:52 +08:00
int64 nodeClusterId = 6;
2020-12-23 10:30:42 +08:00
int32 auditingFlag = 7;
string protocolFamily = 8;
bool trafficOutAsc = 9; // 是否流量正排序
bool trafficOutDesc = 10; // 是否流量倒排序
bool requestsAsc = 13; // 请求数正排序
bool requestsDesc = 14; // 请求数倒排序
bool attackRequestsAsc = 15; // 攻击请求数正排序
bool attackRequestsDesc = 16; // 攻击请求数倒排序
2022-12-31 17:22:10 +08:00
bool ignoreServerNames = 11; // 忽略域名
bool ignoreSSLCerts = 12; // 忽略证书
2020-09-13 19:27:47 +08:00
}
2020-10-31 15:21:35 +08:00
message ListEnabledServersMatchResponse {
2020-09-13 19:27:47 +08:00
repeated Server servers = 1;
}
2023-06-18 10:57:07 +08:00
// 禁用网站
2020-12-23 10:30:42 +08:00
message DeleteServerRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-09-13 19:27:47 +08:00
}
2023-06-18 10:57:07 +08:00
// 查找单个网站
2020-09-13 19:27:47 +08:00
message FindEnabledServerRequest {
2023-06-18 10:57:07 +08:00
int64 serverId = 1; // 网站ID
2022-12-31 18:34:09 +08:00
bool ignoreSSLCerts = 2; // 忽略SSL证书数据
2020-09-13 19:27:47 +08:00
}
message FindEnabledServerResponse {
Server server = 1;
2020-09-15 14:44:38 +08:00
}
2023-06-18 10:57:07 +08:00
// 查找网站配置
2020-12-23 10:30:42 +08:00
message FindEnabledServerConfigRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-12-23 10:30:42 +08:00
}
message FindEnabledServerConfigResponse {
bytes serverJSON = 1;
}
2023-06-18 10:57:07 +08:00
// 查找网站的网站类型
2020-09-15 14:44:38 +08:00
message FindEnabledServerTypeRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-09-15 14:44:38 +08:00
}
message FindEnabledServerTypeResponse {
string type = 1;
}
// 查找反向代理设置
2020-09-21 11:37:09 +08:00
message FindAndInitServerReverseProxyConfigRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-09-15 14:44:38 +08:00
}
2020-09-21 11:37:09 +08:00
message FindAndInitServerReverseProxyConfigResponse {
2020-09-21 19:52:10 +08:00
bytes reverseProxyJSON = 1;
bytes reverseProxyRefJSON = 2;
2020-09-16 09:09:31 +08:00
}
// 初始化Web设置
2020-09-21 19:52:10 +08:00
message FindAndInitServerWebConfigRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-09-16 09:09:31 +08:00
}
2020-09-21 19:52:10 +08:00
message FindAndInitServerWebConfigResponse {
bytes webJSON = 1;
2020-09-30 17:46:33 +08:00
}
2023-06-18 10:57:07 +08:00
// 计算使用某个SSL证书的网站数量
2020-10-02 17:22:46 +08:00
message CountAllEnabledServersWithSSLCertIdRequest {
2020-12-18 21:19:25 +08:00
int64 sslCertId = 1;
2020-09-30 17:46:33 +08:00
}
2023-06-18 10:57:07 +08:00
// 查找使用某个SSL证书的所有网站
2020-10-02 17:22:46 +08:00
message FindAllEnabledServersWithSSLCertIdRequest {
2020-12-18 21:19:25 +08:00
int64 sslCertId = 1;
2020-09-30 17:46:33 +08:00
}
2020-10-02 17:22:46 +08:00
message FindAllEnabledServersWithSSLCertIdResponse {
repeated Server servers = 1;
}
2023-06-18 10:57:07 +08:00
// 计算运行在某个集群上的所有网站数量
2020-10-25 16:22:40 +08:00
message CountAllEnabledServersWithNodeClusterIdRequest {
int64 nodeClusterId = 1;
}
2023-06-18 10:57:07 +08:00
// 计算使用某个分组的网站数量
2021-05-25 17:08:52 +08:00
message CountAllEnabledServersWithServerGroupIdRequest {
int64 serverGroupId = 1;
2020-10-29 20:53:47 +08:00
}
// 通知更新
message NotifyServersChangeRequest {
}
message NotifyServersChangeResponse {
2020-11-14 11:05:49 +08:00
}
2023-06-18 10:57:07 +08:00
// 取得某个集群下的所有网站相关的DNS
2021-05-25 17:08:52 +08:00
message FindAllEnabledServersDNSWithNodeClusterIdRequest {
int64 nodeClusterId = 1;
2020-11-14 11:05:49 +08:00
}
2021-05-25 17:08:52 +08:00
message FindAllEnabledServersDNSWithNodeClusterIdResponse {
2020-11-14 11:05:49 +08:00
repeated ServerDNSInfo servers = 1;
}
message ServerDNSInfo {
int64 id = 1;
string name = 2;
string dnsName = 3;
2020-11-17 11:22:23 +08:00
}
2023-06-18 10:57:07 +08:00
// 查找单个网站的DNS信息
2020-11-17 11:22:23 +08:00
message FindEnabledServerDNSRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2020-11-17 11:22:23 +08:00
}
message FindEnabledServerDNSResponse {
string dnsName = 1;
DNSDomain domain = 2;
2021-10-16 12:03:44 +08:00
bool supportCNAME = 3;
2020-12-23 10:30:42 +08:00
}
2023-06-18 10:57:07 +08:00
// 检查网站是否属于某个用户
2020-12-23 10:30:42 +08:00
message CheckUserServerRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
}
// 查找一个用户下的所有域名列表
message FindAllEnabledServerNamesWithUserIdRequest {
int64 userId = 1;
}
message FindAllEnabledServerNamesWithUserIdResponse {
repeated string serverNames = 1;
}
2023-09-06 16:31:14 +08:00
// 计算一个用户下的所有域名数量
message CountAllServerNamesWithUserIdRequest {
int64 userId = 1; // 用户ID
int64 userPlanId = 2; // 用户套餐ID
}
// 计算某个网站下的域名数量
message CountServerNamesRequest {
int64 serverId = 1; // 网站ID
}
2023-06-18 10:57:07 +08:00
// 查找一个用户下的所有网站
message FindAllUserServersRequest {
int64 userId = 1;
}
message FindAllUserServersResponse {
repeated Server servers = 1; // 只返回一些简要信息
}
2023-09-06 16:31:14 +08:00
// 计算一个用户下的所有网站数量
message CountAllUserServersRequest {
int64 userId = 1; // 用户ID
int64 userPlanId = 2; // 用户套餐ID
}
2023-06-18 10:57:07 +08:00
// 查找某个用户下的网站配置
message ComposeAllUserServersConfigRequest {
int64 userId = 1;
}
message ComposeAllUserServersConfigResponse {
bytes serversConfigJSON = 1; // [server config1, server config2, ...]
}
2023-06-18 10:57:07 +08:00
// 查找用户网站基本信息
message FindEnabledUserServerBasicRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
}
message FindEnabledUserServerBasicResponse {
Server server = 1;
}
2023-06-18 10:57:07 +08:00
// 修改用户网站基本信息
message UpdateEnabledUserServerBasicRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
string name = 2;
}
// 上传HTTP请求待统计数据
message UploadServerHTTPRequestStatRequest {
2021-01-26 18:40:08 +08:00
string month = 1;
string day = 2;
repeated RegionCity regionCities = 3;
repeated RegionProvider regionProviders = 4;
repeated System systems = 5;
repeated Browser browsers = 6;
repeated HTTPFirewallRuleGroup httpFirewallRuleGroups = 7;
message RegionCity {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
int64 countRequests = 5;
int64 bytes = 6;
int64 countAttackRequests = 7;
int64 attackBytes = 8;
int64 countryId = 9;
int64 provinceId = 10;
int64 cityId = 11;
}
message RegionProvider {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
int64 count = 3;
int64 providerId = 4;
}
message System {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
string name = 2;
string version = 3;
int64 count = 4;
}
message Browser {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
string name = 2;
string version = 3;
int64 count = 4;
}
2021-01-26 18:40:08 +08:00
message HTTPFirewallRuleGroup {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2021-01-26 18:40:08 +08:00
int64 httpFirewallRuleGroupId = 2;
string action = 3;
int64 count = 4;
}
}
// 检查域名是否在集群中已经存在
message CheckServerNameDuplicationInNodeClusterRequest {
int64 nodeClusterId = 1;
repeated string serverNames = 2; // 可以同时检查一批域名
2023-06-18 10:57:07 +08:00
int64 excludeServerId = 3; // 要排除的网站ID
bool supportWildcard = 4;// 支持泛解析
}
message CheckServerNameDuplicationInNodeClusterResponse {
repeated string duplicatedServerNames = 1;
2021-05-04 21:02:21 +08:00
}
// 检查域名是否在网站中已经绑定
message CheckServerNameInServerRequest {
int64 serverId = 1; // 网站ID
string serverName = 2; // 域名
}
message CheckServerNameInServerResponse {
bool exists = 1; // 是否存在
}
2023-06-18 10:57:07 +08:00
// 查找最近访问的网站
2021-05-04 21:02:21 +08:00
message FindLatestServersRequest {
int64 size = 1;
}
message FindLatestServersResponse {
repeated Server servers = 1;
}
2023-06-18 10:57:07 +08:00
// 查找某个网站附近的网站
message FindNearbyServersRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
}
message FindNearbyServersResponse {
string scope = 1; // 范围 cluster|group
repeated GroupInfo groups = 2;
message GroupInfo {
string name = 1;
repeated Server servers = 2;
}
2021-10-17 17:12:36 +08:00
}
// 清除缓存
message PurgeServerCacheRequest {
repeated string keys = 2;
repeated string prefixes = 3;
string description = 4; // 任务描述
2021-10-17 17:12:36 +08:00
}
message PurgeServerCacheResponse {
bool isOk = 1;
string message = 2;
}
2021-11-09 17:36:34 +08:00
// 查找流量限制
message FindEnabledServerTrafficLimitRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
}
2021-11-09 17:36:34 +08:00
message FindEnabledServerTrafficLimitResponse {
bytes trafficLimitJSON = 1;
}
2021-11-09 17:36:34 +08:00
// 设置流量限制
message UpdateServerTrafficLimitRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2021-11-09 17:36:34 +08:00
bytes trafficLimitJSON = 2;
2021-11-09 15:36:31 +08:00
}
2023-06-18 10:57:07 +08:00
// 修改网站套餐
2021-11-09 15:36:31 +08:00
message UpdateServerUserPlanRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2021-11-09 15:36:31 +08:00
int64 userPlanId = 2;
2021-11-28 20:11:54 +08:00
}
2023-06-18 10:57:07 +08:00
// 获取网站套餐信息
2021-11-28 20:11:54 +08:00
message FindServerUserPlanRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2021-11-28 20:11:54 +08:00
}
message FindServerUserPlanResponse {
UserPlan userPlan = 1;
2022-01-19 22:15:52 +08:00
}
2023-06-18 10:57:07 +08:00
// 获取网站配置
2022-01-19 22:15:52 +08:00
message ComposeServerConfigRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2022-01-19 22:15:52 +08:00
}
message ComposeServerConfigResponse {
bytes serverConfigJSON = 1;
2022-03-29 21:24:36 +08:00
}
// 修改网站UAM5秒盾设置
2022-03-29 21:24:36 +08:00
message UpdateServerUAMRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2022-03-29 21:24:36 +08:00
bytes uamJSON = 2;
}
// 查找网站UAM5秒盾设置
2022-03-29 21:24:36 +08:00
message FindEnabledServerUAMRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
2022-03-29 21:24:36 +08:00
}
message FindEnabledServerUAMResponse {
bytes uamJSON = 1; // UAM设置
2022-12-22 11:42:44 +08:00
}
2023-06-18 10:57:07 +08:00
// 修改网站所属用户
2022-12-22 11:42:44 +08:00
message UpdateServerUserRequest {
2023-06-21 08:45:06 +08:00
int64 serverId = 1; // 网站ID
int64 userId = 2; // 用户ID
2023-03-31 15:30:31 +08:00
}
2023-06-18 10:57:07 +08:00
// 修改网站名称
2023-03-31 15:30:31 +08:00
message UpdateServerNameRequest {
2023-06-18 10:57:07 +08:00
int64 serverId = 1; // 网站ID
string name = 2; // 网站名称
}
2023-06-18 10:57:07 +08:00
// 在网站之间复制配置
message CopyServerConfigRequest {
2023-06-18 10:57:07 +08:00
int64 serverId = 1; // 被复制网站ID
2023-10-09 19:52:44 +08:00
string configCode = 2; // 要拷贝的配置代号stat 统计charset 字符编码userAgent UA名单referers 防盗链webp WebP配置accessLog 访问日志cc CC配置hostRedirects URL跳转root ROOT配置remoteAddr 访客设置requestLimit 请求限制compression 内容压缩设置optimization 页面优化设置cache 缓存设置uam 五秒盾设置websocket Websocket设置pages 自定义页面设置auth 访问鉴权reverseProxy 反向代理设置waf WAF设置
2023-06-18 10:57:07 +08:00
string targetType = 3; // 目标类型servers, groups, cluster当前集群下所有网站只有管理员才有权限、user当前用户下所有网站
repeated int64 targetServerIds = 4; // 目标网站ID列表
repeated int64 targetServerGroupIds = 5; // 目标网站分组ID列表
int64 targetClusterId = 6; // 目标集群ID
int64 targetUserId = 7; // 目标用户ID
2023-10-09 19:52:44 +08:00
bool wafCopyRegions = 30; // 可选项WAF独立配置是否拷贝区域封禁设置
}
// 获取域名审核时的提示文字
message FindServerAuditingPromptRequest {
int64 serverId = 1; // 网站ID
}
message FindServerAuditingPromptResponse {
string promptText = 1; // 提示文字
}