Documentation
¶
Index ¶
- type CreateNodeRequest
- type CreateServerRequest
- type DeleteNodeRequest
- type DeleteServerRequest
- type EdgeManifestProxy
- type EdgeManifestResponse
- type EdgeManifestSubscription
- type EdgeManifestTLS
- type EdgeManifestTransport
- type FilterNodeListRequest
- type FilterNodeListResponse
- type FilterServerListRequest
- type FilterServerListResponse
- type GetServerConfigRequest
- type GetServerConfigResponse
- type GetServerNodeConfigRequest
- type GetServerNodeConfigResponse
- type GetServerProtocolsRequest
- type GetServerProtocolsResponse
- type GetServerUserListRequest
- type GetServerUserListResponse
- type NetworkServerTotalDataSnapshot
- type NetworkServerTrafficSnapshot
- type NetworkSortItem
- type NetworkUserTrafficSnapshot
- type Node
- type NodeDNS
- type NodeOutbound
- type OnlineUser
- type OnlineUsersRequest
- type Protocol
- type QueryNodeTagResponse
- type QueryServerConfigRequest
- type QueryServerConfigResponse
- type ResetSortRequest
- type Server
- type ServerBasic
- type ServerCommon
- type ServerNodeConfigOverride
- type ServerNodeConfigValues
- type ServerOnlineIP
- type ServerOnlineUser
- type ServerPushStatusRequest
- type ServerPushUserTrafficRequest
- type ServerStatus
- type ServerUser
- type ToggleNodeStatusRequest
- type UpdateNodeRequest
- type UpdateServerNodeConfigRequest
- type UpdateServerRequest
- type UserTraffic
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateNodeRequest ¶
type CreateServerRequest ¶
type DeleteNodeRequest ¶
type DeleteNodeRequest struct {
Id int64 `json:"id"`
}
type DeleteServerRequest ¶
type DeleteServerRequest struct {
Id int64 `json:"id"`
}
type EdgeManifestProxy ¶
type EdgeManifestProxy struct {
Name string `json:"name"`
Protocol string `json:"protocol"`
Server string `json:"server"`
Port uint16 `json:"port"`
UUID string `json:"uuid,omitempty"`
Password string `json:"password,omitempty"`
Cipher string `json:"cipher,omitempty"`
Flow string `json:"flow,omitempty"`
UDP bool `json:"udp"`
TLS *EdgeManifestTLS `json:"tls,omitempty"`
Transport *EdgeManifestTransport `json:"transport,omitempty"`
Tags []string `json:"tags,omitempty"`
Sort int `json:"sort"`
}
type EdgeManifestResponse ¶
type EdgeManifestResponse struct {
SchemaVersion string `json:"schema_version"`
Revision string `json:"revision"`
GeneratedAt string `json:"generated_at"`
Subscription EdgeManifestSubscription `json:"subscription"`
Proxies []EdgeManifestProxy `json:"proxies"`
Notices []string `json:"notices"`
}
EdgeManifestResponse is deliberately independent from SubscribeResponse: it is a data contract for a trusted renderer, not a client configuration.
type EdgeManifestSubscription ¶
type EdgeManifestSubscription struct {
Name string `json:"name"`
State string `json:"state"`
ExpiresAt string `json:"expires_at,omitempty"`
TrafficLimit int64 `json:"traffic_limit"`
Upload int64 `json:"upload"`
Download int64 `json:"download"`
UpdateIntervalHours int64 `json:"update_interval_hours,omitempty"`
WebPageURL string `json:"web_page_url,omitempty"`
}
type EdgeManifestTLS ¶
type EdgeManifestTransport ¶
type FilterNodeListRequest ¶
type FilterNodeListResponse ¶
type FilterServerListRequest ¶
type GetServerConfigRequest ¶
type GetServerConfigRequest struct {
ServerCommon
}
type GetServerConfigResponse ¶
type GetServerConfigResponse struct {
Basic ServerBasic `json:"basic"`
Protocol string `json:"protocol"`
Config interface{} `json:"config"`
}
type GetServerNodeConfigRequest ¶
type GetServerNodeConfigRequest struct {
ServerID int64 `form:"server_id" validate:"required"`
}
type GetServerNodeConfigResponse ¶
type GetServerNodeConfigResponse struct {
Global ServerNodeConfigValues `json:"global"`
Override ServerNodeConfigOverride `json:"override"`
Effective ServerNodeConfigValues `json:"effective"`
}
type GetServerProtocolsRequest ¶
type GetServerProtocolsRequest struct {
Id int64 `form:"id"`
}
type GetServerProtocolsResponse ¶
type GetServerProtocolsResponse struct {
Protocols []Protocol `json:"protocols"`
}
type GetServerUserListRequest ¶
type GetServerUserListRequest struct {
ServerCommon
}
type GetServerUserListResponse ¶
type GetServerUserListResponse struct {
Users []ServerUser `json:"users"`
}
type NetworkServerTotalDataSnapshot ¶
type NetworkServerTotalDataSnapshot struct {
OnlineUsers int64 `json:"online_users"`
OnlineServers int64 `json:"online_servers"`
OfflineServers int64 `json:"offline_servers"`
TodayUpload int64 `json:"today_upload"`
TodayDownload int64 `json:"today_download"`
MonthlyUpload int64 `json:"monthly_upload"`
MonthlyDownload int64 `json:"monthly_download"`
UpdatedAt int64 `json:"updated_at"`
ServerTrafficRankingToday []NetworkServerTrafficSnapshot `json:"server_traffic_ranking_today"`
ServerTrafficRankingYesterday []NetworkServerTrafficSnapshot `json:"server_traffic_ranking_yesterday"`
UserTrafficRankingToday []NetworkUserTrafficSnapshot `json:"user_traffic_ranking_today"`
UserTrafficRankingYesterday []NetworkUserTrafficSnapshot `json:"user_traffic_ranking_yesterday"`
}
type NetworkSortItem ¶
type NetworkUserTrafficSnapshot ¶
type NetworkUserTrafficSnapshot struct {
// SID identifies the user_subscribe row the traffic was billed to, UID the
// user owning it. UID is carried separately so the console can still name
// the user after the subscription row is gone.
SID int64 `json:"sid"`
UID int64 `json:"uid"`
Upload int64 `json:"upload"`
Download int64 `json:"download"`
}
type Node ¶
type Node struct {
Id int64 `json:"id"`
Name string `json:"name"`
Tags []string `json:"tags"`
Port uint16 `json:"port"`
Address string `json:"address"`
ServerId int64 `json:"server_id"`
Protocol string `json:"protocol"`
Enabled *bool `json:"enabled"`
Sort int `json:"sort,omitempty"`
CreatedAt int64 `json:"created_at"`
UpdatedAt int64 `json:"updated_at"`
}
type NodeOutbound ¶
type NodeOutbound struct {
Name string `json:"name"`
Protocol string `json:"protocol"`
Address string `json:"address"`
Port int64 `json:"port"`
User string `json:"user,omitempty"`
Password string `json:"password"`
UUID string `json:"uuid,omitempty"`
Cipher string `json:"cipher,omitempty"`
Plugin string `json:"plugin,omitempty"`
PluginOptions any `json:"plugin_opts,omitempty"`
Security string `json:"security,omitempty"`
SNI string `json:"sni,omitempty"`
ALPN []string `json:"alpn,omitempty"`
AllowInsecure bool `json:"allow_insecure,omitempty"`
Fingerprint string `json:"fingerprint,omitempty"`
Transport string `json:"transport,omitempty"`
Host string `json:"host,omitempty"`
Path string `json:"path,omitempty"`
ServiceName string `json:"service_name,omitempty"`
XHTTPMode string `json:"xhttp_mode,omitempty"`
XHTTPExtra string `json:"xhttp_extra,omitempty"`
Flow string `json:"flow,omitempty"`
Encryption string `json:"encryption,omitempty"`
EncryptionMode string `json:"encryption_mode,omitempty"`
EncryptionRTT string `json:"encryption_rtt,omitempty"`
EncryptionTicket string `json:"encryption_ticket,omitempty"`
EncryptionPadding string `json:"encryption_client_padding,omitempty"`
EncryptionPassword string `json:"encryption_password,omitempty"`
Multiplex string `json:"multiplex,omitempty"`
UoT bool `json:"uot,omitempty"`
UoTVersion int `json:"uot_version,omitempty"`
CongestionController string `json:"congestion_controller,omitempty"`
UDPStream bool `json:"udp_stream,omitempty"`
ReduceRtt bool `json:"reduce_rtt,omitempty"`
Heartbeat int `json:"heartbeat,omitempty"`
RealityPublicKey string `json:"reality_public_key,omitempty"`
RealityShortId string `json:"reality_short_id,omitempty"`
SpiderX string `json:"spider_x,omitempty"`
Settings string `json:"settings,omitempty"`
StreamSettings string `json:"stream_settings,omitempty"`
Rules []string `json:"rules"`
}
type OnlineUser ¶
type OnlineUsersRequest ¶
type OnlineUsersRequest struct {
ServerCommon
Users []OnlineUser `json:"users"`
}
type Protocol ¶
type Protocol struct {
// 通用字段:协议类型标识,例如 shadowsocks、vless、vmess、hysteria2、tuic、nowhere。
Type string `json:"type"`
// 通用字段:入站监听端口。
Port uint16 `json:"port"`
// 版本字段:Snell 接受 5/6,TUIC 接受 5,Nowhere 接受 1;0 表示使用协议默认值。
Version int `json:"version,omitempty"`
// Snell 专属字段:Snell v6 的工作模式;其他协议不应设置。
Mode string `json:"mode,omitempty"`
// 通用字段:是否启用该入站协议。
Enable bool `json:"enable"`
// TLS/REALITY 协议通用字段:选择 none、tls 或 reality;实际可选值由具体协议限制。
Security string `json:"security,omitempty"`
// 监听网络通用字段:选择 tcp、udp 或 both;Nowhere 规范化为 mix、tcp 或 udp,其他协议按各自能力校验。
Network string `json:"network,omitempty"`
// TLS 协议通用字段:证书域名及 TLS ServerName;REALITY 也用它作为服务端名称。
SNI string `json:"sni,omitempty"`
// TLS/HTTP/QUIC 协议通用字段:TLS ALPN 列表;Nowhere 必须且只能设置一个值,默认 now/1。
ALPN []string `json:"alpn,omitempty"`
// TLS 客户端兼容字段:允许跳过证书校验;入站配置通常不消费,不能作为服务端证书配置使用。
AllowInsecure bool `json:"allow_insecure,omitempty"`
// TLS 客户端兼容字段:uTLS 指纹;当前节点入站不消费,仅为出站/旧配置兼容保留。
Fingerprint string `json:"fingerprint,omitempty"`
// VLESS/VMess REALITY 专属字段:REALITY 握手转发目标地址。
RealityServerAddr string `json:"reality_server_addr,omitempty"`
// VLESS/VMess REALITY 专属字段:REALITY 握手转发目标端口。
RealityServerPort int `json:"reality_server_port,omitempty"`
// VLESS/VMess REALITY 服务端专属字段:服务端 X25519 私钥。
RealityPrivateKey string `json:"reality_private_key,omitempty"`
// VLESS/VMess REALITY 客户端信息字段:由私钥对应的公钥,主要用于订阅输出。
RealityPublicKey string `json:"reality_public_key,omitempty"`
// VLESS/VMess REALITY 专属字段:允许客户端使用的 short ID。
RealityShortId string `json:"reality_short_id,omitempty"`
// VLESS/VMess/Trojan 通用传输字段:tcp、ws、httpupgrade、grpc 或 xhttp。
Transport string `json:"transport,omitempty"`
// VLESS/VMess/Trojan 传输字段:WebSocket、HTTPUpgrade 或 XHTTP 的 Host。
Host string `json:"host,omitempty"`
// VLESS/VMess/Trojan 传输字段:WebSocket、HTTPUpgrade 或 XHTTP 的请求路径。
Path string `json:"path,omitempty"`
// VLESS/VMess/Trojan gRPC 传输专属字段:gRPC service name。
ServiceName string `json:"service_name,omitempty"`
// Shadowsocks/SSR 共用字段:Shadowsocks method 或 SSR cipher。
Cipher string `json:"cipher,omitempty"`
// 密钥型协议共用字段:Shadowsocks 2022 服务端密钥、SSR 密码或 Snell PSK。
ServerKey string `json:"server_key,omitempty"`
// Shadowsocks(AEAD/2022)专属字段:入站插件名,如 obfs、v2ray-plugin、shadow-tls、restls。
Plugin string `json:"plugin,omitempty"`
// Shadowsocks(AEAD/2022)专属字段:所选入站插件的结构化参数。
PluginOptions any `json:"plugin_opts,omitempty"`
// VLESS 专属字段:XTLS Vision 流控模式,当前有效值为 xtls-rprx-vision。
Flow string `json:"flow,omitempty"`
// 协议无关能力字段:UDP over TCP 开关,供支持 UoT 的协议使用,并非某一协议专属。
UoT bool `json:"uot,omitempty"`
// 协议无关能力字段:UoT 协议版本,当前支持 1 或 2;0 表示使用默认版本。
UoTVersion int `json:"uot_version,omitempty"`
// 监听器通用兼容字段:是否接收 PROXY protocol;当前节点入站尚未统一启用。
AcceptProxyProtocol bool `json:"accept_proxy_protocol,omitempty"`
// Hysteria2/TUIC 类 QUIC 协议字段:端口跳跃范围;当前节点入站尚未启用该能力。
HopPorts string `json:"hop_ports,omitempty"`
// Hysteria2/TUIC 类 QUIC 协议字段:端口跳跃时间间隔;当前节点入站尚未启用该能力。
HopInterval int `json:"hop_interval,omitempty"`
// Hysteria2 专属字段:Salamander 混淆密码,仅在 obfs=salamander 时使用。
ObfsPassword string `json:"obfs_password,omitempty"`
// TLS 客户端兼容字段:禁用 SNI;当前服务端入站不消费。
DisableSNI bool `json:"disable_sni,omitempty"`
// TUIC 专属字段:启用 QUIC 0-RTT,以减少首次握手往返。
ReduceRtt bool `json:"reduce_rtt,omitempty"`
// TUIC 专属字段:连接心跳间隔,单位为秒;0 使用节点默认值。
Heartbeat int `json:"heartbeat,omitempty"`
// TUIC/Hysteria 兼容字段:旧实现的 UDP relay 模式;当前节点入站不消费。
UDPRelayMode string `json:"udp_relay_mode,omitempty"`
// QUIC 协议共用字段:TUIC 的主拥塞控制字段,也是 Naive 的旧字段别名。
CongestionController string `json:"congestion_controller,omitempty"`
// QUIC 协议共用字段:Naive 的主拥塞控制字段,也是 TUIC 的兼容别名。
QUICCongestionControl string `json:"quic_congestion_control,omitempty"`
// 协议无关能力字段:多路复用级别(off、low、medium、high),适用于支持 mux 的流协议。
Multiplex string `json:"multiplex,omitempty"`
// AnyTLS 专属字段:TLS record padding 方案。
PaddingScheme string `json:"padding_scheme,omitempty"`
// Mieru 专属字段:流量形态/包长分布配置。
TrafficPattern string `json:"traffic_pattern,omitempty"`
// Mieru 专属字段:是否强制客户端携带可识别用户的 user hint。
UserHintIsMandatory bool `json:"user_hint_is_mandatory,omitempty"`
// Hysteria2 专属字段:服务端上行带宽参数,单位为 Mbps。
UpMbps int `json:"up_mbps,omitempty"`
// Hysteria2 专属字段:服务端下行带宽参数,单位为 Mbps。
DownMbps int `json:"down_mbps,omitempty"`
// 混淆协议共用字段:Hysteria2 的 Salamander、Snell v5 的 obfs、SSR 的 obfs 方法。
Obfs string `json:"obfs,omitempty"`
// SSR 专属字段:SSR protocol 方法;JSON 名称 protocol 与顶层 type 不同。
SSRProtocol string `json:"protocol,omitempty"`
// SSR 专属字段:SSR protocol_param。
ProtocolParam string `json:"protocol_param,omitempty"`
// SSR 专属字段:SSR obfs_param。
ObfsParam string `json:"obfs_param,omitempty"`
// 旧混淆实现兼容字段:混淆目标 Host;当前节点入站不消费,Shadowsocks 插件应使用 plugin_opts。
ObfsHost string `json:"obfs_host,omitempty"`
// 旧混淆实现兼容字段:混淆请求路径;当前节点入站不消费,Shadowsocks 插件应使用 plugin_opts。
ObfsPath string `json:"obfs_path,omitempty"`
// VLESS/VMess/Trojan XHTTP 传输专属字段:XHTTP 工作模式,如 auto、packet-up、stream-up。
XhttpMode string `json:"xhttp_mode,omitempty"`
// VLESS/VMess/Trojan XHTTP 传输专属字段:XHTTP 扩展路径/参数。
XhttpExtra string `json:"xhttp_extra,omitempty"`
// VLESS Encryption 专属字段:加密套件,如 none、mlkem768x25519plus。
Encryption string `json:"encryption,omitempty"`
// VLESS Encryption 专属字段:密钥封装模式,如 native、xorpub、random。
EncryptionMode string `json:"encryption_mode,omitempty"`
// VLESS Encryption 专属字段:握手往返模式,取值 0rtt 或 1rtt。
EncryptionRtt string `json:"encryption_rtt,omitempty"`
// VLESS Encryption 服务端专属字段:0-RTT ticket。
EncryptionTicket string `json:"encryption_ticket,omitempty"`
// VLESS Encryption 服务端专属字段:服务端方向 padding 规则。
EncryptionServerPadding string `json:"encryption_server_padding,omitempty"`
// VLESS Encryption 服务端专属字段:ML-KEM/X25519 私钥材料。
EncryptionPrivateKey string `json:"encryption_private_key,omitempty"`
// VLESS Encryption 客户端信息字段:客户端方向 padding 规则,用于订阅输出。
EncryptionClientPadding string `json:"encryption_client_padding,omitempty"`
// VLESS Encryption 客户端信息字段:1-RTT/派生认证密码,用于订阅输出。
EncryptionPassword string `json:"encryption_password,omitempty"`
// 订阅客户端字段:是否启用 Encrypted ClientHello;节点配置下发时会过滤。
EchEnable bool `json:"ech_enable,omitempty"`
// 订阅客户端字段:ECH 外层 ServerName;节点配置下发时会过滤。
EchServerName string `json:"ech_server_name,omitempty"`
// 面板通用字段:流量计费倍率,默认值为 1;不参与节点协议握手。
Ratio float64 `json:"ratio,omitempty"`
// TLS 协议通用字段:证书来源模式,支持 file、self、http、dns;none 表示不配置证书。
CertMode string `json:"cert_mode,omitempty"`
// TLS 协议通用字段:cert_mode=dns 时使用的 DNS 服务商标识。
CertDNSProvider string `json:"cert_dns_provider,omitempty"`
// TLS 协议通用字段:cert_mode=dns 时传给 DNS 服务商的环境变量/凭据配置。
CertDNSEnv string `json:"cert_dns_env,omitempty"`
}
type QueryNodeTagResponse ¶
type QueryNodeTagResponse struct {
Tags []string `json:"tags"`
}
type QueryServerConfigResponse ¶
type QueryServerConfigResponse struct {
TrafficReportThreshold int64 `json:"traffic_report_threshold"`
PushInterval int64 `json:"push_interval"`
PullInterval int64 `json:"pull_interval"`
IPStrategy string `json:"ip_strategy"`
DNS []NodeDNS `json:"dns"`
Block []string `json:"block"`
Outbound []NodeOutbound `json:"outbound"`
Protocols []Protocol `json:"protocols"`
Total int64 `json:"total"`
}
type ResetSortRequest ¶
type ResetSortRequest struct {
Sort []NetworkSortItem `json:"sort"`
}
type Server ¶
type Server struct {
Id int64 `json:"id"`
Name string `json:"name"`
Country string `json:"country"`
City string `json:"city"`
Address string `json:"address"`
Sort int `json:"sort"`
Protocols []Protocol `json:"protocols"`
LastReportedAt int64 `json:"last_reported_at"`
Status ServerStatus `json:"status"`
CreatedAt int64 `json:"created_at"`
UpdatedAt int64 `json:"updated_at"`
}
type ServerBasic ¶
type ServerCommon ¶
type ServerNodeConfigOverride ¶
type ServerNodeConfigOverride struct {
InheritIPStrategy bool `json:"inherit_ip_strategy"`
IPStrategy string `json:"ip_strategy"`
InheritDNS bool `json:"inherit_dns"`
DNS []NodeDNS `json:"dns"`
InheritBlock bool `json:"inherit_block"`
Block []string `json:"block"`
InheritOutbound bool `json:"inherit_outbound"`
Outbound []NodeOutbound `json:"outbound"`
}
type ServerNodeConfigValues ¶
type ServerNodeConfigValues struct {
IPStrategy string `json:"ip_strategy"`
DNS []NodeDNS `json:"dns"`
Block []string `json:"block"`
Outbound []NodeOutbound `json:"outbound"`
}
type ServerOnlineIP ¶
type ServerOnlineUser ¶
type ServerPushStatusRequest ¶
type ServerPushStatusRequest struct {
ServerCommon
Cpu float64 `json:"cpu"`
Mem float64 `json:"mem"`
Disk float64 `json:"disk"`
UpdatedAt int64 `json:"updated_at"`
// CertPinSHA256 is transport metadata carried by the
// X-Node-Certificate-SHA256 request header, not part of the body.
CertPinSHA256 string `json:"-"`
}
type ServerPushUserTrafficRequest ¶
type ServerPushUserTrafficRequest struct {
ServerCommon
Traffic []UserTraffic `json:"traffic"`
}
type ServerStatus ¶
type ServerUser ¶
type ToggleNodeStatusRequest ¶
type UpdateNodeRequest ¶
type UpdateServerNodeConfigRequest ¶
type UpdateServerNodeConfigRequest struct {
ServerID int64 `json:"server_id" validate:"required"`
ServerNodeConfigOverride
}
type UpdateServerRequest ¶
type UpdateServerRequest struct {
Id int64 `json:"id"`
Name string `json:"name"`
Country string `json:"country,omitempty"`
City string `json:"city,omitempty"`
Address string `json:"address"`
Sort int `json:"sort,omitempty"`
Protocols []Protocol `json:"protocols"`
ProtocolFieldSets []map[string]struct{} `json:"-"`
}
type UserTraffic ¶
Click to show internal directories.
Click to hide internal directories.