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

424 lines
10 KiB
Protocol Buffer
Raw Normal View History

2020-09-15 14:44:38 +08:00
syntax = "proto3";
option go_package = "./pb";
package pb;
import "models/model_http_web.proto";
import "models/rpc_messages.proto";
2020-09-15 14:44:38 +08:00
// HTTP Web相关管理服务
2020-09-15 14:44:38 +08:00
service HTTPWebService {
// 创建Web配置
rpc createHTTPWeb (CreateHTTPWebRequest) returns (CreateHTTPWebResponse);
2020-09-21 19:52:10 +08:00
// 查找Web信息
2020-09-15 14:44:38 +08:00
rpc findEnabledHTTPWeb (FindEnabledHTTPWebRequest) returns (FindEnabledHTTPWebResponse);
2020-09-21 19:52:10 +08:00
// 查找Web配置
rpc findEnabledHTTPWebConfig (FindEnabledHTTPWebConfigRequest) returns (FindEnabledHTTPWebConfigResponse);
2020-09-16 09:09:31 +08:00
// 更改Web配置
rpc updateHTTPWeb (UpdateHTTPWebRequest) returns (RPCSuccess);
2020-09-16 09:09:31 +08:00
2021-09-29 19:37:32 +08:00
// 更改压缩配置
rpc updateHTTPWebCompression (UpdateHTTPWebCompressionRequest) returns (RPCSuccess);
2020-09-16 20:29:26 +08:00
// 更改页面优化配置
rpc updateHTTPWebOptimization(UpdateHTTPWebOptimizationRequest) returns (RPCSuccess);
2021-10-01 16:25:31 +08:00
// 更改WebP配置
rpc updateHTTPWebWebP (UpdateHTTPWebWebPRequest) returns (RPCSuccess);
// 更改RemoteAddr配置
rpc updateHTTPWebRemoteAddr(UpdateHTTPWebRemoteAddrRequest) returns (RPCSuccess);
2020-09-16 20:29:26 +08:00
// 更改字符集配置
rpc updateHTTPWebCharset (UpdateHTTPWebCharsetRequest) returns (RPCSuccess);
2020-09-16 20:29:26 +08:00
// 更改请求Header策略
rpc updateHTTPWebRequestHeader (UpdateHTTPWebRequestHeaderRequest) returns (RPCSuccess);
2020-09-16 20:29:26 +08:00
// 更改响应Header策略
rpc updateHTTPWebResponseHeader (UpdateHTTPWebResponseHeaderRequest) returns (RPCSuccess);
2020-09-17 10:15:55 +08:00
// 更改Shutdown
rpc updateHTTPWebShutdown (UpdateHTTPWebShutdownRequest) returns (RPCSuccess);
2020-09-17 10:15:55 +08:00
// 更改Pages
rpc updateHTTPWebPages (UpdateHTTPWebPagesRequest) returns (RPCSuccess);
2020-09-20 11:56:22 +08:00
// 更改系统自定义页面启用状态
rpc updateHTTPWebGlobalPagesEnabled(UpdateHTTPWebGlobalPagesEnabledRequest) returns (RPCSuccess);
2020-09-20 11:56:22 +08:00
// 更改访问日志配置
rpc updateHTTPWebAccessLog (UpdateHTTPWebAccessLogRequest) returns (RPCSuccess);
2020-09-20 14:48:46 +08:00
// 更改统计配置
rpc updateHTTPWebStat (UpdateHTTPWebStatRequest) returns (RPCSuccess);
2020-09-20 16:27:59 +08:00
// 更改缓存配置
rpc updateHTTPWebCache (UpdateHTTPWebCacheRequest) returns (RPCSuccess);
2020-09-20 20:12:53 +08:00
// 更改防火墙设置
rpc updateHTTPWebFirewall (UpdateHTTPWebFirewallRequest) returns (RPCSuccess);
2020-09-21 19:52:10 +08:00
// 更改路径规则配置
rpc updateHTTPWebLocations (UpdateHTTPWebLocationsRequest) returns (RPCSuccess);
2020-09-23 18:43:50 +08:00
2020-09-26 19:54:20 +08:00
// 更改跳转到HTTPS设置
rpc updateHTTPWebRedirectToHTTPS (UpdateHTTPWebRedirectToHTTPSRequest) returns (RPCSuccess);
2020-09-26 19:54:20 +08:00
// 更改Websocket设置
rpc updateHTTPWebWebsocket (UpdateHTTPWebWebsocketRequest) returns (RPCSuccess);
2020-09-28 16:25:49 +08:00
// 更改Fastcgi设置
rpc updateHTTPWebFastcgi (UpdateHTTPWebFastcgiRequest) returns (RPCSuccess);
2020-09-28 16:25:49 +08:00
// 更改重写规则设置
rpc updateHTTPWebRewriteRules (UpdateHTTPWebRewriteRulesRequest) returns (RPCSuccess);
2021-01-10 17:34:48 +08:00
// 更改主机跳转设置
rpc updateHTTPWebHostRedirects (UpdateHTTPWebHostRedirectsRequest) returns (RPCSuccess);
// 查找主机跳转设置
rpc findHTTPWebHostRedirects (FindHTTPWebHostRedirectsRequest) returns (FindHTTPWebHostRedirectsResponse);
2021-06-17 21:18:05 +08:00
// 更改认证设置
rpc updateHTTPWebAuth (UpdateHTTPWebAuthRequest) returns (RPCSuccess);
2021-11-24 12:01:00 +08:00
// 更改通用设置
rpc updateHTTPWebCommon(UpdateHTTPWebCommonRequest) returns (RPCSuccess);
2021-12-12 11:44:58 +08:00
// 修改请求限制
rpc updateHTTPWebRequestLimit(UpdateHTTPWebRequestLimitRequest) returns (RPCSuccess);
// 查找请求限制
rpc findHTTPWebRequestLimit(FindHTTPWebRequestLimitRequest) returns (FindHTTPWebRequestLimitResponse);
2022-01-01 21:51:15 +08:00
// 修改请求脚本
rpc updateHTTPWebRequestScripts(UpdateHTTPWebRequestScriptsRequest) returns (RPCSuccess);
// 查找请求脚本
rpc findHTTPWebRequestScripts(FindHTTPWebRequestScriptsRequest) returns (FindHTTPWebRequestScriptsResponse);
// 修改UAM设置
rpc updateHTTPWebUAM(UpdateHTTPWebUAMRequest) returns (RPCSuccess);
// 查找UAM设置
rpc findHTTPWebUAM(FindHTTPWebUAMRequest) returns (FindHTTPWebUAMResponse);
2022-09-22 16:33:42 +08:00
2023-03-09 12:10:31 +08:00
// 修改CC设置
rpc updateHTTPWebCC(UpdateHTTPWebCCRequest) returns (RPCSuccess);
2023-08-21 15:54:44 +08:00
// 查找CC设置
2023-03-09 12:10:31 +08:00
rpc findHTTPWebCC(FindHTTPWebCCRequest) returns (FindHTTPWebCCResponse);
2022-09-22 16:33:42 +08:00
// 修改防盗链设置
rpc updateHTTPWebReferers(UpdateHTTPWebReferersRequest) returns (RPCSuccess);
// 查找防盗链设置
rpc findHTTPWebReferers(FindHTTPWebReferersRequest) returns (FindHTTPWebReferersResponse);
2022-12-30 20:48:44 +08:00
// 修改UserAgent设置
rpc updateHTTPWebUserAgent(UpdateHTTPWebUserAgentRequest) returns (RPCSuccess);
// 查找UserAgent设置
rpc findHTTPWebUserAgent(FindHTTPWebUserAgentRequest) returns (FindHTTPWebUserAgentResponse);
// 修改HLS设置
rpc updateHTTPWebHLS(UpdateHTTPWebHLSRequest) returns (RPCSuccess);
// 查找HLS设置
rpc findHTTPWebHLS(FindHTTPWebHLSRequest) returns (FindHTTPWebHLSResponse);
// 根据WebId查找ServerId
rpc findServerIdWithHTTPWebId(FindServerIdWithHTTPWebIdRequest) returns (FindServerIdWithHTTPWebIdResponse);
2020-09-15 14:44:38 +08:00
}
// 创建Web配置
message CreateHTTPWebRequest {
2023-02-22 17:36:41 +08:00
bytes rootJSON = 1; // 可选,静态分发配置
2020-09-15 14:44:38 +08:00
}
message CreateHTTPWebResponse {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-15 14:44:38 +08:00
}
2020-09-21 19:52:10 +08:00
// 查找Web信息
2020-09-15 14:44:38 +08:00
message FindEnabledHTTPWebRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-15 14:44:38 +08:00
}
message FindEnabledHTTPWebResponse {
2021-11-24 12:01:00 +08:00
HTTPWeb httpWeb = 1;
2020-09-15 14:44:38 +08:00
}
2020-09-21 19:52:10 +08:00
// 查找Web配置
message FindEnabledHTTPWebConfigRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-21 19:52:10 +08:00
}
message FindEnabledHTTPWebConfigResponse {
2021-11-24 12:01:00 +08:00
bytes httpWebJSON = 1;
2020-09-21 19:52:10 +08:00
}
2020-09-16 09:09:31 +08:00
// 更改Web配置
2020-09-15 14:44:38 +08:00
message UpdateHTTPWebRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-26 11:21:38 +08:00
bytes rootJSON = 2;
2020-09-15 14:44:38 +08:00
}
2021-09-29 19:37:32 +08:00
// 更改压缩配置
message UpdateHTTPWebCompressionRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2021-09-29 19:37:32 +08:00
bytes compressionJSON = 2;
2020-09-16 09:09:31 +08:00
}
// 更改页面优化配置
message UpdateHTTPWebOptimizationRequest {
int64 httpWebId = 1;
bytes optimizationJSON = 2;
}
2021-10-01 16:25:31 +08:00
// 更改WebP配置
message UpdateHTTPWebWebPRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2021-10-01 16:25:31 +08:00
bytes webpJSON = 2;
}
// 更改RemoteAddr配置
message UpdateHTTPWebRemoteAddrRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2022-07-20 18:14:57 +08:00
bytes remoteAddrJSON = 2; // @link json:http_remote_addr_config
}
2020-09-16 20:29:26 +08:00
// 更改字符集配置
message UpdateHTTPWebCharsetRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-23 18:43:50 +08:00
bytes charsetJSON = 2;
2020-09-16 20:29:26 +08:00
}
// 更改请求Header策略
2020-09-23 18:43:50 +08:00
message UpdateHTTPWebRequestHeaderRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-23 18:43:50 +08:00
bytes headerJSON = 2;
2020-09-16 20:29:26 +08:00
}
// 更改响应Header策略
2020-09-23 18:43:50 +08:00
message UpdateHTTPWebResponseHeaderRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-23 18:43:50 +08:00
bytes headerJSON = 2;
2020-09-16 20:29:26 +08:00
}
2020-09-17 10:15:55 +08:00
// 更改Shutdown
message UpdateHTTPWebShutdownRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-17 10:15:55 +08:00
bytes shutdownJSON = 2;
}
2020-09-16 20:29:26 +08:00
2020-09-17 10:15:55 +08:00
// 更改Pages
message UpdateHTTPWebPagesRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-17 10:15:55 +08:00
bytes pagesJSON = 2;
}
2020-09-20 11:56:22 +08:00
// 更改系统自定义页面启用状态
message UpdateHTTPWebGlobalPagesEnabledRequest {
int64 httpWebId = 1; // Web ID
bool isEnabled = 2; // 是否启用
}
2020-09-20 11:56:22 +08:00
// 更改访问日志配置
2020-09-21 19:52:10 +08:00
message UpdateHTTPWebAccessLogRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2022-07-20 18:14:57 +08:00
bytes accessLogJSON = 2; // @link json:http_access_log_ref
2020-09-20 14:48:46 +08:00
}
// 更改统计配置
2020-09-21 19:52:10 +08:00
message UpdateHTTPWebStatRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2022-07-20 18:14:57 +08:00
bytes statJSON = 2; // @link json:http_stat_stat_ref
2020-09-20 16:27:59 +08:00
}
// 更改缓存配置
2020-09-21 19:52:10 +08:00
message UpdateHTTPWebCacheRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2022-07-20 18:14:57 +08:00
bytes cacheJSON = 2; // @link json:http_cache_config
2020-09-20 20:12:53 +08:00
}
// 更改防火墙设置
2020-09-21 19:52:10 +08:00
message UpdateHTTPWebFirewallRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2022-07-20 18:14:57 +08:00
bytes firewallJSON = 2; // @link json:http_firewall_ref
2020-09-21 19:52:10 +08:00
}
// 更改路径规则配置
message UpdateHTTPWebLocationsRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-21 19:52:10 +08:00
bytes locationsJSON = 3;
}
2020-09-23 18:43:50 +08:00
2020-09-26 19:54:20 +08:00
// 更改跳转到HTTPS设置
2020-09-23 18:43:50 +08:00
message UpdateHTTPWebRedirectToHTTPSRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-23 18:43:50 +08:00
bytes redirectToHTTPSJSON = 2;
2020-09-26 19:54:20 +08:00
}
// 更改Websocket设置
message UpdateHTTPWebWebsocketRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2022-07-20 18:14:57 +08:00
bytes websocketJSON = 2; // @link json:http_websocket_ref
2020-09-28 16:25:49 +08:00
}
// 更改Fastcgi设置
message UpdateHTTPWebFastcgiRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
bytes fastcgiJSON = 2;
}
2020-09-28 16:25:49 +08:00
// 更改重写规则设置
message UpdateHTTPWebRewriteRulesRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2020-09-28 16:25:49 +08:00
bytes rewriteRulesJSON = 2;
2021-01-10 17:34:48 +08:00
}
// 更改主机跳转设置
message UpdateHTTPWebHostRedirectsRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2021-01-10 17:34:48 +08:00
bytes hostRedirectsJSON = 2;
}
// 查找主机跳转设置
message FindHTTPWebHostRedirectsRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2021-01-10 17:34:48 +08:00
}
message FindHTTPWebHostRedirectsResponse {
bytes hostRedirectsJSON = 1;
2021-06-17 21:18:05 +08:00
}
// 更改认证设置
message UpdateHTTPWebAuthRequest {
2021-11-24 12:01:00 +08:00
int64 httpWebId = 1;
2021-06-17 21:18:05 +08:00
bytes authJSON = 2;
2021-11-24 12:01:00 +08:00
}
// 更改通用设置
message UpdateHTTPWebCommonRequest {
int64 httpWebId = 1;
bool mergeSlashes = 2;
2021-12-12 11:44:58 +08:00
}
// 修改请求限制
message UpdateHTTPWebRequestLimitRequest {
int64 httpWebId = 1;
bytes requestLimitJSON = 2;
}
// 查找请求限制
message FindHTTPWebRequestLimitRequest {
int64 httpWebId = 1;
}
message FindHTTPWebRequestLimitResponse {
bytes requestLimitJSON = 1;
2022-01-01 21:51:15 +08:00
}
// 修改请求脚本
message UpdateHTTPWebRequestScriptsRequest {
int64 httpWebId = 1;
bytes requestScriptsJSON = 2;
}
// 查找请求脚本
message FindHTTPWebRequestScriptsRequest {
int64 httpWebId = 1;
}
message FindHTTPWebRequestScriptsResponse {
bytes requestScriptsJSON = 1;
}
2023-08-21 15:54:44 +08:00
// 修改网站UAM设置
message UpdateHTTPWebUAMRequest {
int64 httpWebId = 1;
bytes uamJSON = 2;
}
2023-08-21 15:54:44 +08:00
// 查找网站UAM设置
message FindHTTPWebUAMRequest {
int64 httpWebId = 1;
}
message FindHTTPWebUAMResponse {
bytes uamJSON = 1;
2022-09-22 16:33:42 +08:00
}
2023-08-21 15:54:44 +08:00
// 修改网站CC设置
2023-03-09 12:10:31 +08:00
message UpdateHTTPWebCCRequest {
int64 httpWebId = 1;
bytes ccJSON = 2;
}
2023-08-21 15:54:44 +08:00
// 查找网站CC设置
2023-03-09 12:10:31 +08:00
message FindHTTPWebCCRequest {
int64 httpWebId = 1;
}
message FindHTTPWebCCResponse {
bytes ccJSON = 1;
}
2022-09-22 16:33:42 +08:00
// 修改防盗链设置
message UpdateHTTPWebReferersRequest {
int64 httpWebId = 1;
bytes referersJSON = 2;
}
// 查找防盗链设置
message FindHTTPWebReferersRequest {
int64 httpWebId = 1;
}
message FindHTTPWebReferersResponse {
bytes referersJSON = 1;
2022-12-30 20:48:44 +08:00
}
// 修改防盗链设置
message UpdateHTTPWebUserAgentRequest {
int64 httpWebId = 1;
bytes userAgentJSON = 2;
}
// 查找UserAgent设置
message FindHTTPWebUserAgentRequest {
int64 httpWebId = 1;
}
message FindHTTPWebUserAgentResponse {
bytes userAgentJSON = 1;
}
// 修改HLS设置
message UpdateHTTPWebHLSRequest {
int64 httpWebId = 1; // Web配置ID
bytes hlsJSON = 2; // HLS配置
}
// 查找HLS设置
message FindHTTPWebHLSRequest {
int64 httpWebId = 1; // Web配置ID
}
message FindHTTPWebHLSResponse {
bytes hlsJSON = 1; // HLS配置
}
// 根据WebId查找ServerId
message FindServerIdWithHTTPWebIdRequest {
int64 httpWebId = 1; // Web设置ID
}
message FindServerIdWithHTTPWebIdResponse {
int64 serverId = 1; // 网站ID
2020-09-23 18:43:50 +08:00
}