WAFGO正在准备页面
接入指南

API 文档

开发者资源 · API 参考

查阅 WAFGO API 的服务、请求路径和消息定义。按权限角色浏览接口,快速找到接入所需的参数与返回结构。

下载 JSON 文档
69 个服务354 个接口
网站服务相关服务找到 47 个接口

创建网站

createServer

POST/ServerService/createServer
原始定义
rpc createServer (CreateServerRequest) returns (CreateServerResponse);

请求消息

CreateServerRequest

创建网站

请求消息 · 字段定义
message CreateServerRequest {
	int64 userId = 1; // 可选项,用户ID,如果不想指定用户,此值可以为0
	int64 adminId = 2; // 可选项,管理员ID
	string type = 3; // 类型:httpProxy(HTTP反向代理,一般CDN服务都选这个)、httpWeb(静态文件服务,只会从服务器上读取文件内容,不会转发到源站)、tcpProxy(TCP反向代理)、udpProxy(UDP反向代理)
	string name = 4; // 网站名称,通常可以是一个域名
	string description = 5; // 可选项,网站描述

	// 配置相关
	bytes serverNamesJSON = 8; // 域名列表 @link json:server_names
	bytes serverNamesJON = 19 [deprecated = true]; // 已过期,请使用 serverNamesJSON 代替
	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
	bytes udpJSON = 14; // UDP协议设置,当type为udpProxy时填写 @link json:udp_protocol
	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

	int64 nodeClusterId = 30; // 所部署的集群ID
	bytes includeNodesJSON = 31; // 备用参数,不用填写
	bytes excludeNodesJSON = 32; // 备用参数,不用填写
}

响应消息

CreateServerResponse
响应消息 · 字段定义
message CreateServerResponse {
	int64 serverId = 1; // 所创建的网站ID
}

说明与注释按当前语言显示。接口路径、方法名、字段名和类型与原始接口定义保持一致。

接入指南