方法列表
创建集群
admin
RPC
createNodeCluster (CreateNodeClusterRequest) returns (CreateNodeClusterResponse)
HTTP
POST /NodeClusterService/createNodeCluster
输入对象:CreateNodeClusterRequest:
{ // 名称 string name; int64 nodeGrantId; string installDir; int64 dnsDomainId; string dnsName; int32 dnsTTL; int64 httpCachePolicyId; int64 httpFirewallPolicyId; // 系统服务设置 bytes systemServicesJSON; // 服务全局设置 bytes globalServerConfigJSON; // 自动安装nftables bool autoInstallNftables; // 是否自动调节系统参数 bool autoSystemTuning; // 是否自动TRIM硬盘 bool autoTrimDisks; // 最大并发读 int32 maxConcurrentReads; // 最大并发写 int32 maxConcurrentWrites; }
输出对象:CreateNodeClusterResponse:
{ // 集群ID int64 nodeClusterId; }
修改集群
admin
RPC
updateNodeCluster (UpdateNodeClusterRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeCluster
输入对象:UpdateNodeClusterRequest:
输出对象:RPCSuccess:
{ }
删除集群
admin
RPC
deleteNodeCluster (DeleteNodeClusterRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/deleteNodeCluster
输入对象:DeleteNodeClusterRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:RPCSuccess:
{ }
查找单个集群信息
admin
RPC
findEnabledNodeCluster (FindEnabledNodeClusterRequest) returns (FindEnabledNodeClusterResponse)
HTTP
POST /NodeClusterService/findEnabledNodeCluster
输入对象:FindEnabledNodeClusterRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindEnabledNodeClusterResponse:
查找集群的API节点信息
admin
RPC
findAPINodesWithNodeCluster (FindAPINodesWithNodeClusterRequest) returns (FindAPINodesWithNodeClusterResponse)
HTTP
POST /NodeClusterService/findAPINodesWithNodeCluster
输入对象:FindAPINodesWithNodeClusterRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindAPINodesWithNodeClusterResponse:
获取所有可用集群
admin
RPC
findAllEnabledNodeClusters (FindAllEnabledNodeClustersRequest) returns (FindAllEnabledNodeClustersResponse)
HTTP
POST /NodeClusterService/findAllEnabledNodeClusters
输入对象:FindAllEnabledNodeClustersRequest:
{ }
输出对象:FindAllEnabledNodeClustersResponse:
计算所有集群数量
admin
RPC
countAllEnabledNodeClusters (CountAllEnabledNodeClustersRequest) returns (RPCCountResponse)
HTTP
POST /NodeClusterService/countAllEnabledNodeClusters
输入对象:CountAllEnabledNodeClustersRequest:
{ // 关键词 string keyword; }
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
列出单页集群
admin
RPC
listEnabledNodeClusters (ListEnabledNodeClustersRequest) returns (ListEnabledNodeClustersResponse)
HTTP
POST /NodeClusterService/listEnabledNodeClusters
输入对象:ListEnabledNodeClustersRequest:
{ // 读取位置 int64 offset; // 数量,通常不能小于0 int64 size; // 可选项,搜索关键词 string keyword; // 可选项,是否按照ID倒序排列 bool idDesc; // 可选项,是否按照ID正序排列 bool idAsc; }
输出对象:ListEnabledNodeClustersResponse:
查找集群的健康检查配置
admin
RPC
findNodeClusterHealthCheckConfig (FindNodeClusterHealthCheckConfigRequest) returns (FindNodeClusterHealthCheckConfigResponse)
HTTP
POST /NodeClusterService/findNodeClusterHealthCheckConfig
输入对象:FindNodeClusterHealthCheckConfigRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindNodeClusterHealthCheckConfigResponse:
修改集群健康检查设置
admin
RPC
updateNodeClusterHealthCheck (UpdateNodeClusterHealthCheckRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterHealthCheck
输入对象:UpdateNodeClusterHealthCheckRequest:
输出对象:RPCSuccess:
{ }
执行健康检查
admin
RPC
executeNodeClusterHealthCheck (ExecuteNodeClusterHealthCheckRequest) returns (ExecuteNodeClusterHealthCheckResponse)
HTTP
POST /NodeClusterService/executeNodeClusterHealthCheck
输入对象:ExecuteNodeClusterHealthCheckRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:ExecuteNodeClusterHealthCheckResponse:
计算使用某个认证的集群数量
admin
RPC
countAllEnabledNodeClustersWithNodeGrantId (CountAllEnabledNodeClustersWithNodeGrantIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeClusterService/countAllEnabledNodeClustersWithNodeGrantId
输入对象:CountAllEnabledNodeClustersWithNodeGrantIdRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
查找使用某个认证的所有集群
admin
RPC
findAllEnabledNodeClustersWithNodeGrantId (FindAllEnabledNodeClustersWithNodeGrantIdRequest) returns (FindAllEnabledNodeClustersWithNodeGrantIdResponse)
HTTP
POST /NodeClusterService/findAllEnabledNodeClustersWithNodeGrantId
输入对象:FindAllEnabledNodeClustersWithNodeGrantIdRequest:
输出对象:FindAllEnabledNodeClustersWithNodeGrantIdResponse:
查找集群的DNS配置
admin
RPC
findEnabledNodeClusterDNS (FindEnabledNodeClusterDNSRequest) returns (FindEnabledNodeClusterDNSResponse)
HTTP
POST /NodeClusterService/findEnabledNodeClusterDNS
输入对象:FindEnabledNodeClusterDNSRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindEnabledNodeClusterDNSResponse:
计算使用某个DNS服务商的集群数量
admin
RPC
countAllEnabledNodeClustersWithDNSProviderId (CountAllEnabledNodeClustersWithDNSProviderIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeClusterService/countAllEnabledNodeClustersWithDNSProviderId
输入对象:CountAllEnabledNodeClustersWithDNSProviderIdRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
计算使用某个DNS域名的集群数量
admin
RPC
countAllEnabledNodeClustersWithDNSDomainId (CountAllEnabledNodeClustersWithDNSDomainIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeClusterService/countAllEnabledNodeClustersWithDNSDomainId
输入对象:CountAllEnabledNodeClustersWithDNSDomainIdRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
查找使用某个域名的所有集群
admin
RPC
findAllEnabledNodeClustersWithDNSDomainId (FindAllEnabledNodeClustersWithDNSDomainIdRequest) returns (FindAllEnabledNodeClustersWithDNSDomainIdResponse)
HTTP
POST /NodeClusterService/findAllEnabledNodeClustersWithDNSDomainId
输入对象:FindAllEnabledNodeClustersWithDNSDomainIdRequest:
输出对象:FindAllEnabledNodeClustersWithDNSDomainIdResponse:
检查集群域名是否已经被使用
admin
RPC
checkNodeClusterDNSName (CheckNodeClusterDNSNameRequest) returns (CheckNodeClusterDNSNameResponse)
HTTP
POST /NodeClusterService/checkNodeClusterDNSName
输入对象:CheckNodeClusterDNSNameRequest:
{ // 集群ID int64 nodeClusterId; string dnsName; }
输出对象:CheckNodeClusterDNSNameResponse:
修改集群的域名设置
admin
RPC
updateNodeClusterDNS (UpdateNodeClusterDNSRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterDNS
输入对象:UpdateNodeClusterDNSRequest:
输出对象:RPCSuccess:
{ }
检查集群的DNS是否有变化
admin
RPC
checkNodeClusterDNSChanges (CheckNodeClusterDNSChangesRequest) returns (CheckNodeClusterDNSChangesResponse)
HTTP
POST /NodeClusterService/checkNodeClusterDNSChanges
输入对象:CheckNodeClusterDNSChangesRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:CheckNodeClusterDNSChangesResponse:
查找集群的TOA配置
admin
RPC
findEnabledNodeClusterTOA (FindEnabledNodeClusterTOARequest) returns (FindEnabledNodeClusterTOAResponse)
HTTP
POST /NodeClusterService/findEnabledNodeClusterTOA
输入对象:FindEnabledNodeClusterTOARequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindEnabledNodeClusterTOAResponse:
修改集群的TOA设置
admin
RPC
updateNodeClusterTOA (UpdateNodeClusterTOARequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterTOA
输入对象:UpdateNodeClusterTOARequest:
{ // 集群ID int64 nodeClusterId; bytes toaJSON; }
输出对象:RPCSuccess:
{ }
计算使用某个缓存策略的集群数量
admin
RPC
countAllEnabledNodeClustersWithHTTPCachePolicyId (CountAllEnabledNodeClustersWithHTTPCachePolicyIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeClusterService/countAllEnabledNodeClustersWithHTTPCachePolicyId
输入对象:CountAllEnabledNodeClustersWithHTTPCachePolicyIdRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
查找使用缓存策略的所有集群
admin
RPC
findAllEnabledNodeClustersWithHTTPCachePolicyId (FindAllEnabledNodeClustersWithHTTPCachePolicyIdRequest) returns (FindAllEnabledNodeClustersWithHTTPCachePolicyIdResponse)
HTTP
POST /NodeClusterService/findAllEnabledNodeClustersWithHTTPCachePolicyId
输入对象:FindAllEnabledNodeClustersWithHTTPCachePolicyIdRequest:
输出对象:FindAllEnabledNodeClustersWithHTTPCachePolicyIdResponse:
计算使用某个WAF策略的集群数量
admin
RPC
countAllEnabledNodeClustersWithHTTPFirewallPolicyId (CountAllEnabledNodeClustersWithHTTPFirewallPolicyIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeClusterService/countAllEnabledNodeClustersWithHTTPFirewallPolicyId
输入对象:CountAllEnabledNodeClustersWithHTTPFirewallPolicyIdRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
查找使用某个WAF策略的所有集群
admin
RPC
findAllEnabledNodeClustersWithHTTPFirewallPolicyId (FindAllEnabledNodeClustersWithHTTPFirewallPolicyIdRequest) returns (FindAllEnabledNodeClustersWithHTTPFirewallPolicyIdResponse)
HTTP
POST /NodeClusterService/findAllEnabledNodeClustersWithHTTPFirewallPolicyId
输入对象:FindAllEnabledNodeClustersWithHTTPFirewallPolicyIdRequest:
输出对象:FindAllEnabledNodeClustersWithHTTPFirewallPolicyIdResponse:
修改集群的缓存策略
admin
RPC
updateNodeClusterHTTPCachePolicyId (UpdateNodeClusterHTTPCachePolicyIdRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterHTTPCachePolicyId
输入对象:UpdateNodeClusterHTTPCachePolicyIdRequest:
输出对象:RPCSuccess:
{ }
修改集群的WAF策略
admin
RPC
updateNodeClusterHTTPFirewallPolicyId (UpdateNodeClusterHTTPFirewallPolicyIdRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterHTTPFirewallPolicyId
输入对象:UpdateNodeClusterHTTPFirewallPolicyIdRequest:
输出对象:RPCSuccess:
{ }
修改集群的系统服务设置
admin
RPC
updateNodeClusterSystemService (UpdateNodeClusterSystemServiceRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterSystemService
输入对象:UpdateNodeClusterSystemServiceRequest:
输出对象:RPCSuccess:
{ }
查找集群的系统服务设置
admin
RPC
findNodeClusterSystemService (FindNodeClusterSystemServiceRequest) returns (FindNodeClusterSystemServiceResponse)
HTTP
POST /NodeClusterService/findNodeClusterSystemService
输入对象:FindNodeClusterSystemServiceRequest:
{ // 集群ID int64 nodeClusterId; string type; }
输出对象:FindNodeClusterSystemServiceResponse:
获取集群中可以使用的端口
admin
RPC
findFreePortInNodeCluster (FindFreePortInNodeClusterRequest) returns (FindFreePortInNodeClusterResponse)
HTTP
POST /NodeClusterService/findFreePortInNodeCluster
输入对象:FindFreePortInNodeClusterRequest:
输出对象:FindFreePortInNodeClusterResponse:
{ int32 port; }
检查端口是否已经被使用
admin
user
RPC
checkPortIsUsingInNodeCluster (CheckPortIsUsingInNodeClusterRequest) returns (CheckPortIsUsingInNodeClusterResponse)
HTTP
POST /NodeClusterService/checkPortIsUsingInNodeCluster
输入对象:CheckPortIsUsingInNodeClusterRequest:
输出对象:CheckPortIsUsingInNodeClusterResponse:
查找最近访问的集群
admin
RPC
findLatestNodeClusters (FindLatestNodeClustersRequest) returns (FindLatestNodeClustersResponse)
HTTP
POST /NodeClusterService/findLatestNodeClusters
输入对象:FindLatestNodeClustersRequest:
{ // 数量,通常不能小于0 int64 size; }
输出对象:FindLatestNodeClustersResponse:
取得集群的配置概要信息
admin
RPC
findEnabledNodeClusterConfigInfo (FindEnabledNodeClusterConfigInfoRequest) returns (FindEnabledNodeClusterConfigInfoResponse)
HTTP
POST /NodeClusterService/findEnabledNodeClusterConfigInfo
输入对象:FindEnabledNodeClusterConfigInfoRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindEnabledNodeClusterConfigInfoResponse:
{ // 启用了健康检查 bool healthCheckIsOn; // 有防火墙动作设置 bool hasFirewallActions; // 有节点阈值设置 bool hasThresholds; // 已设置消息通知接收人 bool hasMessageReceivers; // 启用了TOA bool isTOAEnabled; // 有指标统计设置 bool hasMetricItems; // 是否定义了WebP策略 bool webPIsOn; // 是否定义了UAM策略 bool uamIsOn; // 是否定义了CC策略 bool httpCCIsOn; // 启用了系统服务 bool hasSystemServices; // 启用了DDoS防护 bool hasDDoSProtection; // 是否设置了自定义页面策略 bool hasHTTPPagesPolicy; // 是否启用HTTP3 bool http3IsOn; // 设置了网络安全策略 bool hasNetworkSecurityPolicy; }
设置集群是否置顶
admin
RPC
updateNodeClusterPinned (UpdateNodeClusterPinnedRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterPinned
输入对象:UpdateNodeClusterPinnedRequest:
{ // 集群ID int64 nodeClusterId; bool isPinned; }
输出对象:RPCSuccess:
{ }
读取集群WebP策略
admin
RPC
findEnabledNodeClusterWebPPolicy (FindEnabledNodeClusterWebPPolicyRequest) returns (FindEnabledNodeClusterWebPPolicyResponse)
HTTP
POST /NodeClusterService/findEnabledNodeClusterWebPPolicy
输入对象:FindEnabledNodeClusterWebPPolicyRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindEnabledNodeClusterWebPPolicyResponse:
设置集群WebP策略
admin
RPC
updateNodeClusterWebPPolicy (UpdateNodeClusterWebPPolicyRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterWebPPolicy
输入对象:UpdateNodeClusterWebPPolicyRequest:
输出对象:RPCSuccess:
{ }
读取集群的UAM策略
admin
RPC
findEnabledNodeClusterUAMPolicy (FindEnabledNodeClusterUAMPolicyRequest) returns (FindEnabledNodeClusterUAMPolicyResponse)
HTTP
POST /NodeClusterService/findEnabledNodeClusterUAMPolicy
输入对象:FindEnabledNodeClusterUAMPolicyRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindEnabledNodeClusterUAMPolicyResponse:
设置集群的UAM策略
admin
RPC
updateNodeClusterUAMPolicy (UpdateNodeClusterUAMPolicyRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterUAMPolicy
输入对象:UpdateNodeClusterUAMPolicyRequest:
输出对象:RPCSuccess:
{ }
读取集群的HTTP CC策略
admin
RPC
findEnabledNodeClusterHTTPCCPolicy (FindEnabledNodeClusterHTTPCCPolicyRequest) returns (FindEnabledNodeClusterHTTPCCPolicyResponse)
HTTP
POST /NodeClusterService/findEnabledNodeClusterHTTPCCPolicy
输入对象:FindEnabledNodeClusterHTTPCCPolicyRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindEnabledNodeClusterHTTPCCPolicyResponse:
设置集群的HTTP CC策略
admin
RPC
updateNodeClusterHTTPCCPolicy (UpdateNodeClusterHTTPCCPolicyRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterHTTPCCPolicy
输入对象:UpdateNodeClusterHTTPCCPolicyRequest:
输出对象:RPCSuccess:
{ }
获取集群的DDoS设置
admin
RPC
findNodeClusterDDoSProtection (FindNodeClusterDDoSProtectionRequest) returns (FindNodeClusterDDoSProtectionResponse)
HTTP
POST /NodeClusterService/findNodeClusterDDoSProtection
输入对象:FindNodeClusterDDoSProtectionRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindNodeClusterDDoSProtectionResponse:
修改集群的DDoS设置
admin
RPC
updateNodeClusterDDoSProtection (UpdateNodeClusterDDoSProtectionRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterDDoSProtection
输入对象:UpdateNodeClusterDDoSProtectionRequest:
输出对象:RPCSuccess:
{ }
获取集群的全局服务设置
admin
RPC
findNodeClusterGlobalServerConfig (FindNodeClusterGlobalServerConfigRequest) returns (FindNodeClusterGlobalServerConfigResponse)
HTTP
POST /NodeClusterService/findNodeClusterGlobalServerConfig
输入对象:FindNodeClusterGlobalServerConfigRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindNodeClusterGlobalServerConfigResponse:
修改集群的全局服务设置
admin
RPC
updateNodeClusterGlobalServerConfig (UpdateNodeClusterGlobalServerConfigRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterGlobalServerConfig
输入对象:UpdateNodeClusterGlobalServerConfigRequest:
{ // 集群ID int64 nodeClusterId; // 网站全局配置 bytes globalServerConfigJSON; }
输出对象:RPCSuccess:
{ }
获取集群的自定义页面设置
admin
RPC
findNodeClusterHTTPPagesPolicy (FindNodeClusterHTTPPagesPolicyRequest) returns (FindNodeClusterHTTPPagesPolicyResponse)
HTTP
POST /NodeClusterService/findNodeClusterHTTPPagesPolicy
输入对象:FindNodeClusterHTTPPagesPolicyRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindNodeClusterHTTPPagesPolicyResponse:
{ // HTTP自定义页面策略配置 bytes httpPagesPolicyJSON; }
修改集群的自定义页面设置
admin
RPC
updateNodeClusterHTTPPagesPolicy (UpdateNodeClusterHTTPPagesPolicyRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterHTTPPagesPolicy
输入对象:UpdateNodeClusterHTTPPagesPolicyRequest:
{ // 集群ID int64 nodeClusterId; // HTTP自定义页面策略配置 bytes httpPagesPolicyJSON; }
输出对象:RPCSuccess:
{ }
获取集群的HTTP3设置
admin
RPC
findNodeClusterHTTP3Policy (FindNodeClusterHTTP3PolicyRequest) returns (FindNodeClusterHTTP3PolicyResponse)
HTTP
POST /NodeClusterService/findNodeClusterHTTP3Policy
输入对象:FindNodeClusterHTTP3PolicyRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindNodeClusterHTTP3PolicyResponse:
{ // HTTP3策略配置 bytes http3PolicyJSON; }
修改集群的HTTP3设置
admin
RPC
updateNodeClusterHTTP3Policy (UpdateNodeClusterHTTP3PolicyRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterHTTP3Policy
输入对象:UpdateNodeClusterHTTP3PolicyRequest:
{ // 集群ID int64 nodeClusterId; // HTTP3策略配置 bytes http3PolicyJSON; }
输出对象:RPCSuccess:
{ }
获取集群的网络安全策略
admin
RPC
findNodeClusterNetworkSecurityPolicy (FindNodeClusterNetworkSecurityPolicyRequest) returns (FindNodeClusterNetworkSecurityPolicyResponse)
HTTP
POST /NodeClusterService/findNodeClusterNetworkSecurityPolicy
输入对象:FindNodeClusterNetworkSecurityPolicyRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindNodeClusterNetworkSecurityPolicyResponse:
{ // 网络安全策略配置 bytes networkSecurityPolicyJSON; }
修改集群的网络安全策略
admin
RPC
updateNodeClusterNetworkSecurityPolicy (UpdateNodeClusterNetworkSecurityPolicyRequest) returns (RPCSuccess)
HTTP
POST /NodeClusterService/updateNodeClusterNetworkSecurityPolicy
输入对象:UpdateNodeClusterNetworkSecurityPolicyRequest:
{ // 集群ID int64 nodeClusterId; // 网络安全策略配置 bytes networkSecurityPolicyJSON; }
输出对象:RPCSuccess:
{ }