WAFGOPreparing your page
Setup guide

API documentation

DEVELOPER RESOURCES · API REFERENCE

Explore WAFGO API services, request paths and message definitions. Browse by permission role to find the parameters and response structures for your integration.

Download JSON documentation
151 services1063 interfaces
Statistics dashboards4 matching interfaces

Assemble cluster dashboard data

composeServerStatNodeClusterBoard

POST/ServerStatBoardService/composeServerStatNodeClusterBoard
Original definition
rpc composeServerStatNodeClusterBoard (ComposeServerStatNodeClusterBoardRequest) returns (ComposeServerStatNodeClusterBoardResponse);

Request message

ComposeServerStatNodeClusterBoardRequest

Assemble cluster dashboard data

Request message · Field definitions
message ComposeServerStatNodeClusterBoardRequest {
	int64 nodeClusterId = 1;
}

Response message

ComposeServerStatNodeClusterBoardResponse
Response message · Field definitions
message ComposeServerStatNodeClusterBoardResponse {
	int64 countActiveNodes = 1; // Online nodes
	int64 countInactiveNodes = 2; // Offline nodes
	int64 countServers = 3; // Number of services
	int64 countUsers = 4; // Number of users
	int64 monthlyTrafficBytes = 5; // This month's traffic
	int64 dailyTrafficBytes = 6; // Today's traffic
	int64 lastDailyTrafficBytes = 7; // Yesterday's traffic

	repeated DailyTrafficStat dailyTrafficStats = 30;
	repeated HourlyTrafficStat hourlyTrafficStats = 31;
	repeated NodeStat topNodeStats = 32;

	repeated NodeValue cpuNodeValues = 34;
	repeated NodeValue memoryNodeValues = 35;
	repeated NodeValue loadNodeValues = 36;

	repeated MetricDataChart metricDataCharts = 37; // Metric charts

	// Daily traffic statistics

	message DailyTrafficStat {
		string day = 1;
		int64 bytes = 2;
		int64 cachedBytes = 3;
		int64 countRequests = 4;
		int64 countCachedRequests = 5;
		int64 countAttackRequests = 6;
		int64 attackBytes = 7;
	}

	// Hourly traffic statistics

	message HourlyTrafficStat {
		string hour = 1;
		int64 bytes = 2;
		int64 cachedBytes = 3;
		int64 countRequests = 4;
		int64 countCachedRequests = 5;
		int64 countAttackRequests = 6;
		int64 attackBytes = 7;
	}

	// Node statistics

	message NodeStat {
		int64 nodeId = 1;
		string nodeName = 2;
		int64 countRequests = 3;
		int64 bytes = 4;
		int64 countAttackRequests = 6;
		int64 attackBytes = 7;
	}
}

Descriptions and comments follow your language. Request paths, method names, field names and types match the original API definitions.

Setup guide