zone

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 1, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	OrderAsc  = "asc"  // 按升序排列
	OrderDesc = "desc" // 按降序排列
)

Order 排序方式

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client 区域客户端

func NewClient

func NewClient(host, token, sessid string, httpClient *http.Client) *Client

NewClient 创建新的区域客户端

func (*Client) GetZones

func (c *Client) GetZones(req *GetZonesRequest) (*GetZonesResponse, error)

GetZones 获取区域列表

type GetZonesRequest

type GetZonesRequest struct {
	// 起始位置,从 0 开始 (0-2000000, 默认0)
	Start int
	// 获取最大长度,限制最大值,如果数据不够可能返回小于 length (1-200, 默认100)
	Length int
	// 选择字段,字段用逗号分隔 (最大1000字符)
	Select string
	// 区域名字前缀过滤 (1-95字符)
	NamePrefix string
	// 模糊搜索关键字 (最大95字符)
	Search string
	// 指定排序字段 (最大100字符)
	SortBy string
	// 指定排序方式(正序/倒序)(asc/desc, 默认asc)
	Order string
}

GetZonesRequest 获取区域列表请求参数

type GetZonesResponse

type GetZonesResponse struct {
	Code    int    `json:"code"`    // 错误码
	Message string `json:"message"` // 错误信息
	Data    struct {
		TotalItems    int32      `json:"totalItems"`    // 总共多少项目
		TotalPages    int32      `json:"totalPages"`    // 总共多少页
		PageNumber    int32      `json:"pageNumber"`    // 当前页码,从 1 开始
		PageSize      int32      `json:"pageSize"`      // 每页多大
		ItemsOffset   int32      `json:"itemsOffset"`   // 当前条目偏移,从 0 开始
		ItemLength    int32      `json:"itemLength"`    // 数据列表长度
		PrivateOffset uint64     `json:"privateOffset"` // 内部偏移
		Items         []ZoneItem `json:"items"`         // 有效数据列表
	} `json:"data"`
}

GetZonesResponse 获取区域列表响应

func (*GetZonesResponse) IsSuccess

func (r *GetZonesResponse) IsSuccess() bool

IsSuccess 检查请求是否成功

type ZoneItem

type ZoneItem struct {
	UUID        string   `json:"uuid"`        // 唯一标识ID
	Name        string   `json:"name"`        // 区域名称
	Description string   `json:"description"` // 描述字段
	Interfaces  []string `json:"interfaces"`  // 关联的接口列表
	Priority    int32    `json:"priority"`    // 优先级
	Type        string   `json:"type"`        // 区域类型
	Enable      bool     `json:"enable"`      // 是否启用
}

ZoneItem 区域项

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL