Documentation ¶
Overview ¶
This package is used for API stability in the types and response to the consumers of the API stats endpoint.
Index ¶
- type AuthResponse
- type BlkioStatEntry
- type BlkioStats
- type Container
- type ContainerChange
- type ContainerCommitResponse
- type ContainerConfig
- type ContainerCreateResponse
- type ContainerExecCreateResponse
- type ContainerJSON
- type ContainerJSONBase
- type ContainerJSONPre120
- type ContainerPathStat
- type ContainerProcessList
- type ContainerState
- type ContainerWaitResponse
- type CopyConfig
- type CpuStats
- type CpuUsage
- type ExecStartCheck
- type GraphDriverData
- type Image
- type ImageDelete
- type ImageHistory
- type ImageInspect
- type Info
- type MemoryStats
- type MountPoint
- type Network
- type Port
- type Stats
- type ThrottlingData
- type Version
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthResponse ¶
type AuthResponse struct { // Status is the authentication status Status string `json:"Status"` }
POST /auth
type BlkioStatEntry ¶
type BlkioStatEntry struct { Major uint64 `json:"major"` Minor uint64 `json:"minor"` Op string `json:"op"` Value uint64 `json:"value"` }
TODO Windows: This can be factored out
type BlkioStats ¶
type BlkioStats struct { // number of bytes tranferred to and from the block device IoServiceBytesRecursive []BlkioStatEntry `json:"io_service_bytes_recursive"` IoServicedRecursive []BlkioStatEntry `json:"io_serviced_recursive"` IoQueuedRecursive []BlkioStatEntry `json:"io_queue_recursive"` IoServiceTimeRecursive []BlkioStatEntry `json:"io_service_time_recursive"` IoWaitTimeRecursive []BlkioStatEntry `json:"io_wait_time_recursive"` IoMergedRecursive []BlkioStatEntry `json:"io_merged_recursive"` IoTimeRecursive []BlkioStatEntry `json:"io_time_recursive"` SectorsRecursive []BlkioStatEntry `json:"sectors_recursive"` }
TODO Windows: This can be factored out
type ContainerChange ¶
GET "/containers/{name:.*}/changes"
type ContainerCommitResponse ¶
type ContainerCommitResponse struct {
ID string `json:"Id"`
}
POST "/commit?container="+containerID
type ContainerConfig ¶
type ContainerCreateResponse ¶
type ContainerCreateResponse struct { // ID is the ID of the created container. ID string `json:"Id"` // Warnings are any warnings encountered during the creation of the container. Warnings []string `json:"Warnings"` }
ContainerCreateResponse contains the information returned to a client on the creation of a new container.
type ContainerExecCreateResponse ¶
type ContainerExecCreateResponse struct { // ID is the exec ID. ID string `json:"Id"` }
POST /containers/{name:.*}/exec
type ContainerJSON ¶
type ContainerJSON struct { *ContainerJSONBase Mounts []MountPoint Config *runconfig.Config }
type ContainerJSONBase ¶
type ContainerJSONBase struct { Id string Created string Path string Args []string State *ContainerState Image string NetworkSettings *network.Settings ResolvConfPath string HostnamePath string HostsPath string LogPath string Name string RestartCount int Driver string ExecDriver string MountLabel string ProcessLabel string AppArmorProfile string ExecIDs []string HostConfig *runconfig.HostConfig GraphDriver GraphDriverData }
GET "/containers/{name:.*}/json"
type ContainerJSONPre120 ¶ added in v0.327.0
type ContainerJSONPre120 struct { *ContainerJSONBase Volumes map[string]string VolumesRW map[string]bool Config *ContainerConfig }
backcompatibility struct along with ContainerConfig
type ContainerPathStat ¶ added in v0.327.0
type ContainerPathStat struct { Name string `json:"name"` Size int64 `json:"size"` Mode os.FileMode `json:"mode"` Mtime time.Time `json:"mtime"` LinkTarget string `json:"linkTarget"` }
ContainerPathStat is used to encode the header from
GET /containers/{name:.*}/archive
"name" is basename of the resource.
type ContainerProcessList ¶
GET "/containers/{name:.*}/top"
type ContainerState ¶
type ContainerWaitResponse ¶
type ContainerWaitResponse struct { // StatusCode is the status code of the wait job StatusCode int `json:"StatusCode"` }
POST "/containers/"+containerID+"/wait"
type CopyConfig ¶
type CopyConfig struct {
Resource string
}
POST "/containers/"+containerID+"/copy"
type CpuStats ¶
type CpuStats struct { CpuUsage CpuUsage `json:"cpu_usage"` SystemUsage uint64 `json:"system_cpu_usage"` ThrottlingData ThrottlingData `json:"throttling_data,omitempty"` }
type CpuUsage ¶
type CpuUsage struct { // Total CPU time consumed. // Units: nanoseconds. TotalUsage uint64 `json:"total_usage"` // Total CPU time consumed per core. // Units: nanoseconds. PercpuUsage []uint64 `json:"percpu_usage"` // Time spent by tasks of the cgroup in kernel mode. // Units: nanoseconds. UsageInKernelmode uint64 `json:"usage_in_kernelmode"` // Time spent by tasks of the cgroup in user mode. // Units: nanoseconds. UsageInUsermode uint64 `json:"usage_in_usermode"` }
All CPU stats are aggregated since container inception.
type ExecStartCheck ¶
type ExecStartCheck struct { // ExecStart will first check if it's detached Detach bool // Check if there's a tty Tty bool }
This struct is a temp struct used by execStart Config fields is part of ExecConfig in runconfig package
type GraphDriverData ¶ added in v0.327.0
type Image ¶
type Image struct { ID string `json:"Id"` ParentId string RepoTags []string RepoDigests []string Created int Size int VirtualSize int Labels map[string]string }
GET "/images/json"
type ImageDelete ¶
DELETE "/images/{name:.*}"
type ImageHistory ¶
type ImageHistory struct { ID string `json:"Id"` Created int64 CreatedBy string Tags []string Size int64 Comment string }
GET "/images/{name:.*}/history"
type ImageInspect ¶
type ImageInspect struct { Id string Parent string Comment string Created string Container string ContainerConfig *runconfig.Config DockerVersion string Author string Config *runconfig.Config Architecture string Os string Size int64 VirtualSize int64 GraphDriver GraphDriverData }
GET "/images/{name:.*}/json"
type Info ¶
type Info struct { ID string Containers int Images int Driver string DriverStatus [][2]string MemoryLimit bool SwapLimit bool CpuCfsPeriod bool CpuCfsQuota bool IPv4Forwarding bool BridgeNfIptables bool BridgeNfIp6tables bool Debug bool NFd int OomKillDisable bool NGoroutines int SystemTime string ExecutionDriver string LoggingDriver string NEventsListener int KernelVersion string OperatingSystem string IndexServerAddress string RegistryConfig interface{} InitSha1 string InitPath string NCPU int MemTotal int64 DockerRootDir string HttpProxy string HttpsProxy string NoProxy string Name string Labels []string ExperimentalBuild bool }
GET "/info"
type MemoryStats ¶
type MemoryStats struct { // current res_counter usage for memory Usage uint64 `json:"usage"` // maximum usage ever recorded. MaxUsage uint64 `json:"max_usage"` // TODO(vishh): Export these as stronger types. // all the stats exported via memory.stat. Stats map[string]uint64 `json:"stats"` // number of times memory usage hits limits. Failcnt uint64 `json:"failcnt"` Limit uint64 `json:"limit"` }
type MountPoint ¶ added in v0.327.0
type MountPoint struct { Name string `json:",omitempty"` Source string Destination string Driver string `json:",omitempty"` Mode string // this is internally named `Relabel` RW bool }
MountPoint represents a mount point configuration inside the container.
type Network ¶
type Network struct { RxBytes uint64 `json:"rx_bytes"` RxPackets uint64 `json:"rx_packets"` RxErrors uint64 `json:"rx_errors"` RxDropped uint64 `json:"rx_dropped"` TxBytes uint64 `json:"tx_bytes"` TxPackets uint64 `json:"tx_packets"` TxErrors uint64 `json:"tx_errors"` TxDropped uint64 `json:"tx_dropped"` }
TODO Windows: This will require refactoring
type Port ¶
type Port struct { IP string `json:",omitempty"` PrivatePort int PublicPort int `json:",omitempty"` Type string }
GET "/containers/json"
type Stats ¶
type Stats struct { Read time.Time `json:"read"` Network Network `json:"network,omitempty"` PreCpuStats CpuStats `json:"precpu_stats,omitempty"` CpuStats CpuStats `json:"cpu_stats,omitempty"` MemoryStats MemoryStats `json:"memory_stats,omitempty"` BlkioStats BlkioStats `json:"blkio_stats,omitempty"` }
type ThrottlingData ¶
type ThrottlingData struct { // Number of periods with throttling active Periods uint64 `json:"periods"` // Number of periods when the container hit its throttling limit. ThrottledPeriods uint64 `json:"throttled_periods"` // Aggregate time the container was throttled for in nanoseconds. ThrottledTime uint64 `json:"throttled_time"` }