WAFGO正在准备页面
接入指南

API 文档

开发者资源 · API 参考

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

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

快速创建基本的TCP网站

createBasicTCPServer

POST/ServerService/createBasicTCPServer
原始定义
rpc createBasicTCPServer(CreateBasicTCPServerRequest) returns (CreateBasicTCPServerResponse);

请求消息

CreateBasicTCPServerRequest

快速创建基本的TCP网站

请求消息 · 字段定义
message CreateBasicTCPServerRequest {
	int64 nodeClusterId = 1; // 部署的集群ID,用户创建时不需要指定此项
	int64 userId = 2; // 管理员创建网站时可以指定此用户ID,也可以为0表示不指定
	repeated int32 tcpPorts = 3; // TCP端口
	repeated int32 tlsPorts = 4; // TLS端口
	repeated int64 sslCertIds = 5; // TLS用到的证书ID列表
	repeated string originAddrs = 6; // 源站地址列表,每一个源站地址需要带协议部分,比如 tcp://example.com, tls://example.com
}

响应消息

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

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

接入指南