cfapi

Documentation

Index

• type Client
  • func New(apiToken, accountID string) *Client
  • func (c *Client) API() *cf.Client
  • func (c *Client) AccountID() string
  • func (c *Client) CreateCNAME(ctx context.Context, zoneID, name, target string) (string, error)
  • func (c *Client) CreateTunnel(ctx context.Context, name string) (*shared.CloudflareTunnel, error)
  • func (c *Client) DeleteDNSRecord(ctx context.Context, zoneID, recordID string) error
  • func (c *Client) DeleteTunnel(ctx context.Context, tunnelID string) error
  • func (c *Client) FindDNSRecord(ctx context.Context, zoneID, name string) (string, error)
  • func (c *Client) FindZoneByDomain(ctx context.Context, domain string) (*zones.Zone, error)
  • func (c *Client) GetTunnelToken(ctx context.Context, tunnelID string) (string, error)
  • func (c *Client) ListTunnels(ctx context.Context) ([]shared.CloudflareTunnel, error)
  • func (c *Client) ListZones(ctx context.Context) ([]zones.Zone, error)
  • func (c *Client) PushIngressConfig(ctx context.Context, tunnelID string, routes []IngressRule) error
  • func (c *Client) UpdateCNAME(ctx context.Context, zoneID, recordID, name, target string) error
• type IngressRule
• type ZoneInfo

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(apiToken, accountID string) *Client

func (*Client) API

func (c *Client) API() *cf.Client

func (*Client) AccountID

func (c *Client) AccountID() string

func (*Client) CreateCNAME

func (c *Client) CreateCNAME(ctx context.Context, zoneID, name, target string) (string, error)

CreateCNAME 创建 CNAME 记录指向隧道

func (*Client) CreateTunnel

func (c *Client) CreateTunnel(ctx context.Context, name string) (*shared.CloudflareTunnel, error)

CreateTunnel 创建 Cloudflare Tunnel

func (*Client) DeleteDNSRecord

func (c *Client) DeleteDNSRecord(ctx context.Context, zoneID, recordID string) error

DeleteDNSRecord 删除 DNS 记录

func (*Client) DeleteTunnel

func (c *Client) DeleteTunnel(ctx context.Context, tunnelID string) error

DeleteTunnel 删除隧道

func (*Client) FindDNSRecord

func (c *Client) FindDNSRecord(ctx context.Context, zoneID, name string) (string, error)

FindDNSRecord 查找指定域名的 DNS 记录

func (*Client) FindZoneByDomain

func (c *Client) FindZoneByDomain(ctx context.Context, domain string) (*zones.Zone, error)

FindZoneByDomain 根据域名查找 Zone

func (*Client) GetTunnelToken

func (c *Client) GetTunnelToken(ctx context.Context, tunnelID string) (string, error)

GetTunnelToken 获取隧道运行 Token

func (*Client) ListTunnels

func (c *Client) ListTunnels(ctx context.Context) ([]shared.CloudflareTunnel, error)

ListTunnels 列出所有隧道

func (*Client) ListZones

func (c *Client) ListZones(ctx context.Context) ([]zones.Zone, error)

ListZones 列出账户下所有域名

func (*Client) PushIngressConfig

func (c *Client) PushIngressConfig(ctx context.Context, tunnelID string, routes []IngressRule) error

PushIngressConfig 推送 ingress 配置到 Cloudflare 远端

func (*Client) UpdateCNAME

func (c *Client) UpdateCNAME(ctx context.Context, zoneID, recordID, name, target string) error

UpdateCNAME 更新 CNAME 记录

type IngressRule

type IngressRule struct {
	Hostname string
	Service  string
}

IngressRule ingress 路由规则

type ZoneInfo

type ZoneInfo struct {
	ID   string
	Name string
}

ZoneInfo 简化的 Zone 信息