Documentation
¶
Overview ¶
Package zerotier 提供 ZeroTier API 的 Go SDK
本 SDK 包含两个子模块：
- client: 本地 Service API（localhost:9993）
- central: 云端 Central API（api.zerotier.com）
快速开始：
import "context"
// 本地节点管理
local := zerotier.NewClient()
status, _ := local.Status(context.Background())
// 云端管理
cloud := zerotier.NewCentral("your_api_token")
networks, _ := cloud.Networks().List(context.Background())
所有方法均接受 context.Context 作为首参以支持超时与取消。
Index ¶
- func NewCentralMemberConfig() *central.MemberConfigBuilder
- func NewCentralNetworkConfig() *central.NetworkConfigBuilder
- func NewControllerMemberConfig() *client.ControllerMemberBuilder
- func NewControllerNetworkConfig() *client.ControllerNetworkBuilder
- func NewNetworkSettings() *client.NetworkSettingsBuilder
- type AssignMode
- type Central
- type CentralOption
- type CentralStatus
- type Client
- type ClientOption
- type ControllerMember
- type ControllerMemberConfig
- type ControllerNetwork
- type ControllerNetworkConfig
- type ControllerStatus
- type CreateNetworkConfig
- type DNS
- type IPAssignmentPool
- type LocalNetwork
- type Member
- type MemberConfig
- type Network
- type NetworkConfig
- type NetworkSettings
- type NodeStatus
- type Peer
- type PeerPath
- type Route
- type StatusUser
- type UpdateMemberConfig
- type UpdateMemberRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCentralMemberConfig ¶
func NewCentralMemberConfig() *central.MemberConfigBuilder
NewCentralMemberConfig 创建云端成员配置构建器
func NewCentralNetworkConfig ¶
func NewCentralNetworkConfig() *central.NetworkConfigBuilder
NewCentralNetworkConfig 创建云端网络配置构建器
func NewControllerMemberConfig ¶
func NewControllerMemberConfig() *client.ControllerMemberBuilder
NewControllerMemberConfig 创建控制器成员配置构建器
func NewControllerNetworkConfig ¶
func NewControllerNetworkConfig() *client.ControllerNetworkBuilder
NewControllerNetworkConfig 创建控制器网络配置构建器
func NewNetworkSettings ¶
func NewNetworkSettings() *client.NetworkSettingsBuilder
NewNetworkSettings 创建本地网络设置构建器
Types ¶
type Central ¶
Central 云端 Central API 客户端
func NewCentral ¶
func NewCentral(token string, opts ...CentralOption) Central
NewCentral 创建云端 Central API 客户端
需要提供 API Token（从 my.zerotier.com 获取）
central := zerotier.NewCentral("your_api_token")
type CentralOption ¶
CentralOption 云端客户端配置选项
func WithCentralBaseURL ¶
func WithCentralBaseURL(url string) CentralOption
WithCentralBaseURL 设置云端 API 地址
type Client ¶
Client 本地 Service API 客户端
func NewClient ¶
func NewClient(opts ...ClientOption) Client
NewClient 创建本地 Service API 客户端
默认连接 localhost:9993，自动读取系统 authtoken.secret
client := zerotier.NewClient()
client := zerotier.NewClient(zerotier.WithClientToken("token"))
type ClientOption ¶
ClientOption 本地客户端配置选项
func WithClientBaseURL ¶
func WithClientBaseURL(url string) ClientOption
WithClientBaseURL 设置本地 API 地址
func WithClientTokenFile ¶
func WithClientTokenFile(path string) ClientOption
WithClientTokenFile 从文件读取本地 Token
type ControllerMemberConfig ¶
type ControllerMemberConfig = client.ControllerMemberConfig
ControllerMemberConfig 控制器成员配置
type ControllerNetworkConfig ¶
type ControllerNetworkConfig = client.ControllerNetworkConfig
ControllerNetworkConfig 控制器网络配置
type CreateNetworkConfig ¶
type CreateNetworkConfig = central.CreateNetworkConfig
CreateNetworkConfig 创建网络配置
type UpdateMemberConfig ¶
type UpdateMemberConfig = central.UpdateMemberConfig
UpdateMemberConfig 更新成员配置
type UpdateMemberRequest ¶
type UpdateMemberRequest = central.UpdateMemberRequest
UpdateMemberRequest 更新成员请求
Source Files
Directories