方法列表
创建节点
admin
RPC
createNode (CreateNodeRequest) returns (CreateNodeResponse)
HTTP
POST /NodeService/createNode
输入对象:CreateNodeRequest:
{ // 节点名称 string name; // 节点所属集群 int64 nodeClusterId; // 节点登录信息 NodeLogin nodeLogin; // 节点所属分组 int64 nodeGroupId; // 节点DNS线路列表 []string dnsRoutes; // 节点所属区域 int64 nodeRegionId; }
输出对象:CreateNodeResponse:
{ // 节点ID int64 nodeId; }
所有可用的节点数量
admin
RPC
countAllEnabledNodes (CountAllEnabledNodesRequest) returns (RPCCountResponse)
HTTP
POST /NodeService/countAllEnabledNodes
输入对象:CountAllEnabledNodesRequest:
{ }
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
计算匹配的节点数量
admin
RPC
countAllEnabledNodesMatch (CountAllEnabledNodesMatchRequest) returns (RPCCountResponse)
HTTP
POST /NodeService/countAllEnabledNodesMatch
输入对象:CountAllEnabledNodesMatchRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
列出单页节点
admin
RPC
listEnabledNodesMatch (ListEnabledNodesMatchRequest) returns (ListEnabledNodesMatchResponse)
HTTP
POST /NodeService/listEnabledNodesMatch
输入对象:ListEnabledNodesMatchRequest:
{ // 读取位置 int64 offset; // 读取数量 int64 size; // 集群ID int64 nodeClusterId; // 安装状态 int32 installState; // 在线状态 int32 activeState; // 关键词 string keyword; // 节点分组ID int64 nodeGroupId; // 节点区域ID int64 nodeRegionId; // 节点级别,目前只有1(L1)和2(L2) int32 level; bool cpuAsc; bool cpuDesc; bool memoryAsc; bool memoryDesc; bool trafficInAsc; bool trafficInDesc; bool trafficOutAsc; bool trafficOutDesc; bool loadAsc; bool loadDesc; bool connectionsAsc; bool connectionsDesc; }
输出对象:ListEnabledNodesMatchResponse:
根据集群查找所有节点
admin
RPC
findAllEnabledNodesWithNodeClusterId (FindAllEnabledNodesWithNodeClusterIdRequest) returns (FindAllEnabledNodesWithNodeClusterIdResponse)
HTTP
POST /NodeService/findAllEnabledNodesWithNodeClusterId
输入对象:FindAllEnabledNodesWithNodeClusterIdRequest:
{ // 集群ID int64 nodeClusterId; // 是否检查节点的从集群,如果为false,则只检查主集群ID bool includeSecondary; }
输出对象:FindAllEnabledNodesWithNodeClusterIdResponse:
删除节点
admin
RPC
deleteNode (DeleteNodeRequest) returns (RPCSuccess)
HTTP
POST /NodeService/deleteNode
输入对象:DeleteNodeRequest:
{ // 节点ID int64 nodeId; }
输出对象:RPCSuccess:
{ }
从集群中删除节点
admin
RPC
deleteNodeFromNodeCluster (DeleteNodeFromNodeClusterRequest) returns (RPCSuccess)
HTTP
POST /NodeService/deleteNodeFromNodeCluster
输入对象:DeleteNodeFromNodeClusterRequest:
{ // 节点ID int64 nodeId; // 集群ID int64 nodeClusterId; }
输出对象:RPCSuccess:
{ }
修改节点
admin
RPC
updateNode (UpdateNodeRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNode
输入对象:UpdateNodeRequest:
{ // 节点ID int64 nodeId; // 名称 string name; // 集群ID int64 nodeClusterId; []int64 secondaryNodeClusterIds; // 是否启用 bool isOn; int64 nodeGroupId; int64 nodeRegionId; int32 level; // Ln节点访问地址 []string lnAddrs; // 是否启用IP名单 bool enableIPLists; }
输出对象:RPCSuccess:
{ }
获取单个节点信息
admin
RPC
findEnabledNode (FindEnabledNodeRequest) returns (FindEnabledNodeResponse)
HTTP
POST /NodeService/findEnabledNode
输入对象:FindEnabledNodeRequest:
{ // 节点ID int64 nodeId; }
输出对象:FindEnabledNodeResponse:
{ // 节点信息 Node node; }
获取单个节点基本信息
admin
RPC
findEnabledBasicNode (FindEnabledBasicNodeRequest) returns (FindEnabledBasicNodeResponse)
HTTP
POST /NodeService/findEnabledBasicNode
输入对象:FindEnabledBasicNodeRequest:
{ // 节点ID int64 nodeId; }
输出对象:FindEnabledBasicNodeResponse:
{ // 节点基本信息 BasicNode node; }
向节点发送命令
admin
RPC
sendCommandToNode (NodeStreamMessage) returns (NodeStreamMessage)
HTTP
POST /NodeService/sendCommandToNode
输入对象:NodeStreamMessage:
输出对象:NodeStreamMessage:
修改节点安装状态
admin
RPC
updateNodeIsInstalled (UpdateNodeIsInstalledRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeIsInstalled
输入对象:UpdateNodeIsInstalledRequest:
{ // 节点ID int64 nodeId; bool isInstalled; }
输出对象:RPCSuccess:
{ }
安装节点
admin
RPC
installNode (InstallNodeRequest) returns (InstallNodeResponse)
HTTP
POST /NodeService/installNode
输入对象:InstallNodeRequest:
{ // 节点ID int64 nodeId; }
输出对象:InstallNodeResponse:
{ }
升级节点
admin
RPC
upgradeNode (UpgradeNodeRequest) returns (UpgradeNodeResponse)
HTTP
POST /NodeService/upgradeNode
输入对象:UpgradeNodeRequest:
{ // 节点ID int64 nodeId; }
输出对象:UpgradeNodeResponse:
启动节点
admin
RPC
startNode (StartNodeRequest) returns (StartNodeResponse)
HTTP
POST /NodeService/startNode
输入对象:StartNodeRequest:
{ // 节点ID int64 nodeId; }
输出对象:StartNodeResponse:
停止节点
admin
RPC
stopNode (StopNodeRequest) returns (StopNodeResponse)
HTTP
POST /NodeService/stopNode
输入对象:StopNodeRequest:
{ // 节点ID int64 nodeId; }
输出对象:StopNodeResponse:
{ // 是否成功 bool isOk; // 失败时的错误信息 string error; }
卸载节点
admin
RPC
uninstallNode (UninstallNodeRequest) returns (UninstallNodeResponse)
HTTP
POST /NodeService/uninstallNode
输入对象:UninstallNodeRequest:
{ // 节点ID int64 nodeId; }
输出对象:UninstallNodeResponse:
{ // 是否成功 bool isOk; // 失败时的错误信息 string error; }
计算使用某个认证的节点数量
admin
RPC
countAllEnabledNodesWithNodeGrantId (CountAllEnabledNodesWithNodeGrantIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeService/countAllEnabledNodesWithNodeGrantId
输入对象:CountAllEnabledNodesWithNodeGrantIdRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
查找使用某个认证的所有节点
admin
RPC
findAllEnabledNodesWithNodeGrantId (FindAllEnabledNodesWithNodeGrantIdRequest) returns (FindAllEnabledNodesWithNodeGrantIdResponse)
HTTP
POST /NodeService/findAllEnabledNodesWithNodeGrantId
输入对象:FindAllEnabledNodesWithNodeGrantIdRequest:
输出对象:FindAllEnabledNodesWithNodeGrantIdResponse:
计算没有安装的节点数量
admin
RPC
countAllNotInstalledNodesWithNodeClusterId (CountAllNotInstalledNodesWithNodeClusterIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeService/countAllNotInstalledNodesWithNodeClusterId
输入对象:CountAllNotInstalledNodesWithNodeClusterIdRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
列出所有未安装的节点
admin
RPC
findAllNotInstalledNodesWithNodeClusterId (FindAllNotInstalledNodesWithNodeClusterIdRequest) returns (FindAllNotInstalledNodesWithNodeClusterIdResponse)
HTTP
POST /NodeService/findAllNotInstalledNodesWithNodeClusterId
输入对象:FindAllNotInstalledNodesWithNodeClusterIdRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindAllNotInstalledNodesWithNodeClusterIdResponse:
计算需要升级的节点数量
admin
RPC
countAllUpgradeNodesWithNodeClusterId (CountAllUpgradeNodesWithNodeClusterIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeService/countAllUpgradeNodesWithNodeClusterId
输入对象:CountAllUpgradeNodesWithNodeClusterIdRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
列出所有需要升级的节点
admin
RPC
findAllUpgradeNodesWithNodeClusterId (FindAllUpgradeNodesWithNodeClusterIdRequest) returns (FindAllUpgradeNodesWithNodeClusterIdResponse)
HTTP
POST /NodeService/findAllUpgradeNodesWithNodeClusterId
输入对象:FindAllUpgradeNodesWithNodeClusterIdRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindAllUpgradeNodesWithNodeClusterIdResponse:
读取节点安装状态
admin
RPC
findNodeInstallStatus (FindNodeInstallStatusRequest) returns (FindNodeInstallStatusResponse)
HTTP
POST /NodeService/findNodeInstallStatus
输入对象:FindNodeInstallStatusRequest:
{ // 节点ID int64 nodeId; }
输出对象:FindNodeInstallStatusResponse:
修改节点登录信息
admin
RPC
updateNodeLogin (UpdateNodeLoginRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeLogin
输入对象:UpdateNodeLoginRequest:
{ // 节点ID int64 nodeId; NodeLogin nodeLogin; }
输出对象:RPCSuccess:
{ }
计算某个节点分组内的节点数量
admin
RPC
countAllEnabledNodesWithNodeGroupId (CountAllEnabledNodesWithNodeGroupIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeService/countAllEnabledNodesWithNodeGroupId
输入对象:CountAllEnabledNodesWithNodeGroupIdRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
取得某个集群下的所有节点DNS信息
admin
RPC
findAllEnabledNodesDNSWithNodeClusterId (FindAllEnabledNodesDNSWithNodeClusterIdRequest) returns (FindAllEnabledNodesDNSWithNodeClusterIdResponse)
HTTP
POST /NodeService/findAllEnabledNodesDNSWithNodeClusterId
输入对象:FindAllEnabledNodesDNSWithNodeClusterIdRequest:
输出对象:FindAllEnabledNodesDNSWithNodeClusterIdResponse:
查找单个节点的域名解析信息
admin
RPC
findEnabledNodeDNS (FindEnabledNodeDNSRequest) returns (FindEnabledNodeDNSResponse)
HTTP
POST /NodeService/findEnabledNodeDNS
输入对象:FindEnabledNodeDNSRequest:
{ // 节点ID int64 nodeId; // 集群ID int64 nodeClusterId; int64 nodeIPAddrId; }
输出对象:FindEnabledNodeDNSResponse:
修改节点的DNS解析信息
admin
RPC
updateNodeDNS (UpdateNodeDNSRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeDNS
输入对象:UpdateNodeDNSRequest:
输出对象:RPCSuccess:
{ }
计算某个区域下的节点数量
admin
RPC
countAllEnabledNodesWithNodeRegionId (CountAllEnabledNodesWithNodeRegionIdRequest) returns (RPCCountResponse)
HTTP
POST /NodeService/countAllEnabledNodesWithNodeRegionId
输入对象:CountAllEnabledNodesWithNodeRegionIdRequest:
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
根据一组ID获取节点信息
admin
RPC
findEnabledNodesWithIds (FindEnabledNodesWithIdsRequest) returns (FindEnabledNodesWithIdsResponse)
HTTP
POST /NodeService/findEnabledNodesWithIds
输入对象:FindEnabledNodesWithIdsRequest:
输出对象:FindEnabledNodesWithIdsResponse:
检查新版本
admin
RPC
checkNodeLatestVersion (CheckNodeLatestVersionRequest) returns (CheckNodeLatestVersionResponse)
HTTP
POST /NodeService/checkNodeLatestVersion
输入对象:CheckNodeLatestVersionRequest:
输出对象:CheckNodeLatestVersionResponse:
设置节点上线状态
admin
RPC
updateNodeUp (UpdateNodeUpRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeUp
输入对象:UpdateNodeUpRequest:
{ // 节点ID int64 nodeId; bool isUp; }
输出对象:RPCSuccess:
{ }
修改节点系统信息
admin
RPC
updateNodeSystem (UpdateNodeSystemRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeSystem
输入对象:UpdateNodeSystemRequest:
{ // 节点ID int64 nodeId; int32 maxCPU; }
输出对象:RPCSuccess:
{ }
修改节点缓存设置
admin
RPC
updateNodeCache (UpdateNodeCacheRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeCache
输入对象:UpdateNodeCacheRequest:
{ // 节点ID int64 nodeId; // 磁盘容量限制 SizeCapacity maxCacheDiskCapacity; // 内存容量限制 SizeCapacity maxCacheMemoryCapacity; // 磁盘缓存目录 string cacheDiskDir; // 磁盘缓存子目录 bytes cacheDiskSubDirsJSON; }
输出对象:RPCSuccess:
{ }
读取节点DNS Resolver
admin
RPC
findNodeDNSResolver (FindNodeDNSResolverRequest) returns (FindNodeDNSResolverResponse)
HTTP
POST /NodeService/findNodeDNSResolver
输入对象:FindNodeDNSResolverRequest:
{ // 节点ID int64 nodeId; }
输出对象:FindNodeDNSResolverResponse:
修改DNS Resolver
admin
RPC
updateNodeDNSResolver (UpdateNodeDNSResolverRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeDNSResolver
输入对象:UpdateNodeDNSResolverRequest:
{ // 节点ID int64 nodeId; bytes dnsResolverJSON; }
输出对象:RPCSuccess:
{ }
获取节点的DDoS设置
node
admin
RPC
findNodeDDoSProtection (FindNodeDDoSProtectionRequest) returns (FindNodeDDoSProtectionResponse)
HTTP
POST /NodeService/findNodeDDoSProtection
输入对象:FindNodeDDoSProtectionRequest:
{ // 节点ID int64 nodeId; }
输出对象:FindNodeDDoSProtectionResponse:
修改节点的DDoS设置
admin
RPC
updateNodeDDoSProtection (UpdateNodeDDoSProtectionRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeDDoSProtection
输入对象:UpdateNodeDDoSProtectionRequest:
输出对象:RPCSuccess:
{ }
取得节点的服务全局配置
node
admin
RPC
findNodeGlobalServerConfig (FindNodeGlobalServerConfigRequest) returns (FindNodeGlobalServerConfigResponse)
HTTP
POST /NodeService/findNodeGlobalServerConfig
输入对象:FindNodeGlobalServerConfigRequest:
{ // 节点ID int64 nodeId; }
输出对象:FindNodeGlobalServerConfigResponse:
取得节点的配置概要信息
admin
RPC
findEnabledNodeConfigInfo (FindEnabledNodeConfigInfoRequest) returns (FindEnabledNodeConfigInfoResponse)
HTTP
POST /NodeService/findEnabledNodeConfigInfo
输入对象:FindEnabledNodeConfigInfoRequest:
{ // 节点ID int64 nodeId; }
输出对象:FindEnabledNodeConfigInfoResponse:
{ // 是否有DNS设置 bool hasDNSInfo; // 是否有缓存设置 bool hasCacheInfo; // 是否有阈值设置 bool hasThresholds; // 是否有SSH设置 bool hasSSH; // 是否有系统设置 bool hasSystemSettings; // 是否有DDoS防护设置 bool hasDDoSProtection; // 是否有调度设置 bool hasScheduleSettings; }
查找节点区域信息数量
admin
RPC
countAllNodeRegionInfo (CountAllNodeRegionInfoRequest) returns (RPCCountResponse)
HTTP
POST /NodeService/countAllNodeRegionInfo
输入对象:CountAllNodeRegionInfoRequest:
{ // 区域ID,可选 int64 nodeRegionId; }
输出对象:RPCCountResponse:
{ // 数量 int64 count; }
列出单页节点区域信息
admin
RPC
listNodeRegionInfo (ListNodeRegionInfoRequest) returns (ListNodeRegionInfoResponse)
HTTP
POST /NodeService/listNodeRegionInfo
输入对象:ListNodeRegionInfoRequest:
{ // 区域ID,可选 int64 nodeRegionId; // 读取位置 int64 offset; // 数量,通常不能小于0 int64 size; }
输出对象:ListNodeRegionInfoResponse:
修改节点区域信息
admin
RPC
updateNodeRegionInfo (UpdateNodeRegionInfoRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeRegionInfo
输入对象:UpdateNodeRegionInfoRequest:
{ // 节点ID int64 nodeId; int64 nodeRegionId; }
输出对象:RPCSuccess:
{ }
查找单个节点的API相关配置
admin
RPC
findNodeAPIConfig (FindNodeAPIConfigRequest) returns (FindNodeAPIConfigResponse)
HTTP
POST /NodeService/findNodeAPIConfig
输入对象:FindNodeAPIConfigRequest:
{ // 节点ID int64 nodeId; }
输出对象:FindNodeAPIConfigResponse:
修改某个节点的API相关配置
admin
RPC
updateNodeAPIConfig (UpdateNodeAPIConfigRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeAPIConfig
输入对象:UpdateNodeAPIConfigRequest:
输出对象:RPCSuccess:
{ }
查找节点调度信息
admin
RPC
findNodeScheduleInfo (FindNodeScheduleInfoRequest) returns (FindNodeScheduleInfoResponse)
HTTP
POST /NodeService/findNodeScheduleInfo
输入对象:FindNodeScheduleInfoRequest:
{ // 节点ID int64 nodeId; }
输出对象:FindNodeScheduleInfoResponse:
{ // 调度信息 ScheduleInfo scheduleInfo; ScheduleInfo { // 下线日期,格式YYYYMMDD string offlineDay; // 是否为集群备份节点 bool isBackupForCluster; // 是否为分组备份节点 bool isBackupForGroup; // 备用IP []string backupIPs; // 动作状态 bytes actionStatusJSON; } }
修改节点调度信息
admin
RPC
updateNodeScheduleInfo (UpdateNodeScheduleInfoRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeScheduleInfo
输入对象:UpdateNodeScheduleInfoRequest:
{ // 节点ID int64 nodeId; // 下线日期,格式YYYYMMDD string offlineDay; // 是否为集群备份节点 bool isBackupForCluster; // 是否为分组备份节点 bool isBackupForGroup; // 备用IP []string backupIPs; }
输出对象:RPCSuccess:
{ }
重置节点动作状态
admin
RPC
resetNodeActionStatus (ResetNodeActionStatusRequest) returns (RPCSuccess)
HTTP
POST /NodeService/resetNodeActionStatus
输入对象:ResetNodeActionStatusRequest:
{ // 节点ID int64 nodeId; }
输出对象:RPCSuccess:
{ }
查找集群的节点调度信息
admin
RPC
findAllNodeScheduleInfoWithNodeClusterId (FindAllNodeScheduleInfoWithNodeClusterIdRequest) returns (FindAllNodeScheduleInfoWithNodeClusterIdResponse)
HTTP
POST /NodeService/findAllNodeScheduleInfoWithNodeClusterId
输入对象:FindAllNodeScheduleInfoWithNodeClusterIdRequest:
{ // 集群ID int64 nodeClusterId; }
输出对象:FindAllNodeScheduleInfoWithNodeClusterIdResponse:
{ // 调动信息列表 []ScheduleInfo nodes; ScheduleInfo { // 节点ID int64 nodeId; // 节点名称 string nodeName; // 节点分组ID int64 nodeGroupId; // 节点分组名称 string nodeGroupName; // 下线日期,格式YYYYMMDD string offlineDay; // 是否为集群备份节点 bool isBackupForCluster; // 是否为分组备份节点 bool isBackupForGroup; // 备用IP []string backupIPs; // 动作状态 bytes actionStatusJSON; } }
复制动作设置到分组
admin
RPC
copyNodeActionsToNodeGroup (CopyNodeActionsToNodeGroupRequest) returns (RPCSuccess)
HTTP
POST /NodeService/copyNodeActionsToNodeGroup
输入对象:CopyNodeActionsToNodeGroupRequest:
{ // 节点ID int64 nodeId; }
输出对象:RPCSuccess:
{ }
复制动作设置到集群
admin
RPC
copyNodeActionsToNodeCluster (CopyNodeActionsToNodeClusterRequest) returns (RPCSuccess)
HTTP
POST /NodeService/copyNodeActionsToNodeCluster
输入对象:CopyNodeActionsToNodeClusterRequest:
{ // 节点ID int64 nodeId; }
输出对象:RPCSuccess:
{ }
修改节点的启用状态
admin
RPC
updateNodeIsOn (UpdateNodeIsOnRequest) returns (RPCSuccess)
HTTP
POST /NodeService/updateNodeIsOn
输入对象:UpdateNodeIsOnRequest:
{ // 节点ID int64 nodeId; // 是否启用 bool isOn; }
输出对象:RPCSuccess:
{ }