server

type Client ¶

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

Client is a Service to work with API Jobs.

func New(c *api.Client) *Client

func (s *Client) GetUpdateWindow(ctx context.Context, request GetUpdateWindowRequest) (response GetUpdateWindowResponse, err error)

func (s *Client) List(ctx context.Context) (response ListResponse, err error)

func (s *Client) SetUpdateWindow(ctx context.Context, request SetUpdateWindowRequest) (response JobResponse, err error)

func (s *Client) UpdateMinimumTLSVersion(ctx context.Context, request UpdateMinimumTLSVersionRequest) (response JobResponse, err error)

type GetUpdateWindowRequest ¶ added in v0.7.0

type GetUpdateWindowRequest struct {
	ServerName string `url:"server_name"`
}

GetUpdateWindowRequest identifies the CCS whose update-window configuration to read.

type GetUpdateWindowResponse ¶ added in v0.7.0

type GetUpdateWindowResponse struct {
	Return UpdateWindow `json:"return"`
	models.APIResponse
}

GetUpdateWindowResponse is the response from cloud/server/get_update_window.json. Returns the current maintenance-window configuration.

type JobResponse ¶ added in v0.7.0

type JobResponse struct {
	Return struct {
		models.Job `json:"job"`
	} `json:"return"`
	models.APIResponse
}

JobResponse is the shared response shape for the asynchronous write operations: SetUpdateWindow, UpdateMinimumTLSVersion. Each queues a scheduler job; the job ID is returned for tracking.

type ListResponse ¶

type ListResponse struct {
	CloudServers []models.CloudServer `json:"return"`
	models.APIResponse
}

ListResponse represents a server response for listing stack servers.

type SetUpdateWindowRequest ¶ added in v0.7.0

type SetUpdateWindowRequest struct {
	ServerName   string `url:"server_name"`
	Enabled      int    `url:"enabled"` // 0 or 1
	DayOfWeek    int    `url:"day_of_week"`
	HourOfDay    int    `url:"hour_of_day"`
	MinuteOfHour int    `url:"minute_of_hour"`
}

SetUpdateWindowRequest configures the maintenance / patching window for a CCS. All fields are required by the API.

DayOfWeek is 1–7 (1 = Monday); HourOfDay is 0–23; MinuteOfHour is 0–59. Enabled controls whether the window is active (false disables auto-maintenance).

type UpdateMinimumTLSVersionRequest ¶ added in v0.7.0

type UpdateMinimumTLSVersionRequest struct {
	ServerName        string `url:"server_name"`
	MinimumTLSVersion string `url:"minimum_tls_version"`
}

UpdateMinimumTLSVersionRequest sets the minimum TLS version the CCS's nginx-proxy will negotiate. The API accepts the "TLSv1.x" format (e.g. "TLSv1.1", "TLSv1.2", "TLSv1.3"); values like "1.2" or "TLS_1_2" are rejected.

Note: there's no corresponding read endpoint. Consumers must either track the value they set or observe it via a TLS handshake against a service running on the CCS.

type UpdateWindow ¶ added in v0.7.0

type UpdateWindow struct {
	Enabled      bool `json:"enabled"`
	DayOfWeek    int  `json:"day_of_week"`
	HourOfDay    int  `json:"hour_of_day"`
	MinuteOfHour int  `json:"minute_of_hour"`
}

UpdateWindow describes a CCS's maintenance/patching window configuration as returned by get_update_window. DayOfWeek is 1–7 (1 = Monday); HourOfDay is 0–23; MinuteOfHour is 0–59.