Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.Minio.AdminAPI

Contents

MinIO Admin API

Synopsis

data DriveInfo = DriveInfo {
- diUuid :: Text
- diEndpoint :: Text
- diState :: Text
}
data ErasureInfo = ErasureInfo {
- eiOnlineDisks :: Int
- eiOfflineDisks :: Int
- eiStandard :: StorageClass
- eiReducedRedundancy :: StorageClass
- eiSets :: [[DriveInfo]]
}
data Backend
- = BackendFS
- | BackendErasure ErasureInfo
data ConnStats = ConnStats {
- csTransferred :: Int64
- csReceived :: Int64
}
data HttpStats = HttpStats {
- hsTotalHeads :: CountNAvgTime
- hsSuccessHeads :: CountNAvgTime
- hsTotalGets :: CountNAvgTime
- hsSuccessGets :: CountNAvgTime
- hsTotalPuts :: CountNAvgTime
- hsSuccessPuts :: CountNAvgTime
- hsTotalPosts :: CountNAvgTime
- hsSuccessPosts :: CountNAvgTime
- hsTotalDeletes :: CountNAvgTime
- hsSuccessDeletes :: CountNAvgTime
}
data ServerProps = ServerProps {
- spUptime :: NominalDiffTime
- spVersion :: Text
- spCommitId :: Text
- spRegion :: Text
- spSqsArns :: [Text]
}
data CountNAvgTime = CountNAvgTime {
- caCount :: Int64
- caAvgDuration :: Text
}
data StorageClass = StorageClass {
- scParity :: Int
- scData :: Int
}
data StorageInfo = StorageInfo {
- siUsed :: Int64
- siBackend :: Backend
}
data SIData = SIData {
- sdStorage :: StorageInfo
- sdConnStats :: ConnStats
- sdHttpStats :: HttpStats
- sdProps :: ServerProps
}
data ServerInfo = ServerInfo {
- siError :: Text
- siAddr :: Text
- siData :: SIData
}
getServerInfo :: Minio [ServerInfo]
data HealOpts = HealOpts {
- hoRecursive :: Bool
- hoDryRun :: Bool
}
data HealResultItem = HealResultItem {
- hriResultIdx :: Int
- hriType :: HealItemType
- hriBucket :: Bucket
- hriObject :: Object
- hriDetail :: Text
- hriParityBlocks :: Maybe Int
- hriDataBlocks :: Maybe Int
- hriDiskCount :: Int
- hriSetCount :: Int
- hriObjectSize :: Int
- hriBefore :: [DriveInfo]
- hriAfter :: [DriveInfo]
}
data HealStatus = HealStatus {
- hsSummary :: Text
- hsStartTime :: UTCTime
- hsSettings :: HealOpts
- hsNumDisks :: Int
- hsFailureDetail :: Maybe Text
- hsItems :: Maybe [HealResultItem]
}
data HealStartResp = HealStartResp {
- hsrClientToken :: Text
- hsrClientAddr :: Text
- hsrStartTime :: UTCTime
}
startHeal :: Maybe Bucket -> Maybe Text -> HealOpts -> Minio HealStartResp
forceStartHeal :: Maybe Bucket -> Maybe Text -> HealOpts -> Minio HealStartResp
getHealStatus :: Maybe Bucket -> Maybe Text -> Text -> Minio HealStatus
data SetConfigResult = SetConfigResult {
- scrStatus :: Bool
- scrNodeSummary :: [NodeSummary]
}
data NodeSummary = NodeSummary {
- nsName :: Text
- nsErrSet :: Bool
- nsErrMessage :: Text
}
setConfig :: ByteString -> Minio SetConfigResult
getConfig :: Minio ByteString
data ServerVersion = ServerVersion {
- svVersion :: Text
- svCommitId :: Text
}
data ServiceStatus = ServiceStatus {
- ssVersion :: ServerVersion
- ssUptime :: NominalDiffTime
}
serviceStatus :: Minio ServiceStatus
data ServiceAction
- = ServiceActionRestart
- | ServiceActionStop
serviceSendAction :: ServiceAction -> Minio ()

MinIO Admin API

Provides MinIO admin API and related types. It is in experimental state.

data DriveInfo Source #

Constructors

DriveInfo
Fields diUuid :: Text diEndpoint :: Text diState :: Text

Instances

Instances details

FromJSON DriveInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser DriveInfo # parseJSONList :: Value -> Parser [DriveInfo] #
Show DriveInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> DriveInfo -> ShowS # show :: DriveInfo -> String # showList :: [DriveInfo] -> ShowS #
Eq DriveInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: DriveInfo -> DriveInfo -> Bool # (/=) :: DriveInfo -> DriveInfo -> Bool #

data ErasureInfo Source #

Constructors

ErasureInfo
Fields eiOnlineDisks :: Int eiOfflineDisks :: Int eiStandard :: StorageClass eiReducedRedundancy :: StorageClass eiSets :: [[DriveInfo]]

Instances

Instances details

FromJSON ErasureInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser ErasureInfo # parseJSONList :: Value -> Parser [ErasureInfo] #
Show ErasureInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> ErasureInfo -> ShowS # show :: ErasureInfo -> String # showList :: [ErasureInfo] -> ShowS #
Eq ErasureInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: ErasureInfo -> ErasureInfo -> Bool # (/=) :: ErasureInfo -> ErasureInfo -> Bool #

data Backend Source #

Constructors

BackendFS
BackendErasure ErasureInfo

Instances

Instances details

FromJSON Backend Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser Backend # parseJSONList :: Value -> Parser [Backend] #
Show Backend Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> Backend -> ShowS # show :: Backend -> String # showList :: [Backend] -> ShowS #
Eq Backend Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: Backend -> Backend -> Bool # (/=) :: Backend -> Backend -> Bool #

data ConnStats Source #

Constructors

ConnStats
Fields csTransferred :: Int64 csReceived :: Int64

Instances

Instances details

FromJSON ConnStats Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser ConnStats # parseJSONList :: Value -> Parser [ConnStats] #
Show ConnStats Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> ConnStats -> ShowS # show :: ConnStats -> String # showList :: [ConnStats] -> ShowS #
Eq ConnStats Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: ConnStats -> ConnStats -> Bool # (/=) :: ConnStats -> ConnStats -> Bool #

data HttpStats Source #

Constructors

HttpStats
Fields hsTotalHeads :: CountNAvgTime hsSuccessHeads :: CountNAvgTime hsTotalGets :: CountNAvgTime hsSuccessGets :: CountNAvgTime hsTotalPuts :: CountNAvgTime hsSuccessPuts :: CountNAvgTime hsTotalPosts :: CountNAvgTime hsSuccessPosts :: CountNAvgTime hsTotalDeletes :: CountNAvgTime hsSuccessDeletes :: CountNAvgTime

Instances

Instances details

FromJSON HttpStats Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser HttpStats # parseJSONList :: Value -> Parser [HttpStats] #
Show HttpStats Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> HttpStats -> ShowS # show :: HttpStats -> String # showList :: [HttpStats] -> ShowS #
Eq HttpStats Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: HttpStats -> HttpStats -> Bool # (/=) :: HttpStats -> HttpStats -> Bool #

data ServerProps Source #

Constructors

ServerProps
Fields spUptime :: NominalDiffTime spVersion :: Text spCommitId :: Text spRegion :: Text spSqsArns :: [Text]

Instances

Instances details

FromJSON ServerProps Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser ServerProps # parseJSONList :: Value -> Parser [ServerProps] #
Show ServerProps Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> ServerProps -> ShowS # show :: ServerProps -> String # showList :: [ServerProps] -> ShowS #
Eq ServerProps Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: ServerProps -> ServerProps -> Bool # (/=) :: ServerProps -> ServerProps -> Bool #

data CountNAvgTime Source #

Constructors

CountNAvgTime
Fields caCount :: Int64 caAvgDuration :: Text

Instances

Instances details

FromJSON CountNAvgTime Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser CountNAvgTime # parseJSONList :: Value -> Parser [CountNAvgTime] #
Show CountNAvgTime Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> CountNAvgTime -> ShowS # show :: CountNAvgTime -> String # showList :: [CountNAvgTime] -> ShowS #
Eq CountNAvgTime Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: CountNAvgTime -> CountNAvgTime -> Bool # (/=) :: CountNAvgTime -> CountNAvgTime -> Bool #

data StorageClass Source #

Constructors

StorageClass
Fields scParity :: Int scData :: Int

Instances

Instances details

Show StorageClass Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> StorageClass -> ShowS # show :: StorageClass -> String # showList :: [StorageClass] -> ShowS #
Eq StorageClass Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: StorageClass -> StorageClass -> Bool # (/=) :: StorageClass -> StorageClass -> Bool #

data StorageInfo Source #

Constructors

StorageInfo
Fields siUsed :: Int64 siBackend :: Backend

Instances

Instances details

FromJSON StorageInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser StorageInfo # parseJSONList :: Value -> Parser [StorageInfo] #
Show StorageInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> StorageInfo -> ShowS # show :: StorageInfo -> String # showList :: [StorageInfo] -> ShowS #
Eq StorageInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: StorageInfo -> StorageInfo -> Bool # (/=) :: StorageInfo -> StorageInfo -> Bool #

data SIData Source #

Constructors

SIData
Fields sdStorage :: StorageInfo sdConnStats :: ConnStats sdHttpStats :: HttpStats sdProps :: ServerProps

Instances

Instances details

FromJSON SIData Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser SIData # parseJSONList :: Value -> Parser [SIData] #
Show SIData Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> SIData -> ShowS # show :: SIData -> String # showList :: [SIData] -> ShowS #
Eq SIData Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: SIData -> SIData -> Bool # (/=) :: SIData -> SIData -> Bool #

data ServerInfo Source #

Constructors

ServerInfo
Fields siError :: Text siAddr :: Text siData :: SIData

Instances

Instances details

FromJSON ServerInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser ServerInfo # parseJSONList :: Value -> Parser [ServerInfo] #
Show ServerInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> ServerInfo -> ShowS # show :: ServerInfo -> String # showList :: [ServerInfo] -> ShowS #
Eq ServerInfo Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: ServerInfo -> ServerInfo -> Bool # (/=) :: ServerInfo -> ServerInfo -> Bool #

getServerInfo :: Minio [ServerInfo] Source #

Fetches information for all cluster nodes, such as server properties, storage information, network statistics, etc.

data HealOpts Source #

Constructors

HealOpts
Fields hoRecursive :: Bool hoDryRun :: Bool

Instances

Instances details

FromJSON HealOpts Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser HealOpts # parseJSONList :: Value -> Parser [HealOpts] #
ToJSON HealOpts Source #
Instance details Defined in Network.Minio.AdminAPI Methods toJSON :: HealOpts -> Value # toEncoding :: HealOpts -> Encoding # toJSONList :: [HealOpts] -> Value # toEncodingList :: [HealOpts] -> Encoding #
Show HealOpts Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> HealOpts -> ShowS # show :: HealOpts -> String # showList :: [HealOpts] -> ShowS #
Eq HealOpts Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: HealOpts -> HealOpts -> Bool # (/=) :: HealOpts -> HealOpts -> Bool #

data HealResultItem Source #

Constructors

HealResultItem
Fields hriResultIdx :: Int hriType :: HealItemType hriBucket :: Bucket hriObject :: Object hriDetail :: Text hriParityBlocks :: Maybe Int hriDataBlocks :: Maybe Int hriDiskCount :: Int hriSetCount :: Int hriObjectSize :: Int hriBefore :: [DriveInfo] hriAfter :: [DriveInfo]

Instances

Instances details

FromJSON HealResultItem Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser HealResultItem # parseJSONList :: Value -> Parser [HealResultItem] #
Show HealResultItem Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> HealResultItem -> ShowS # show :: HealResultItem -> String # showList :: [HealResultItem] -> ShowS #
Eq HealResultItem Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: HealResultItem -> HealResultItem -> Bool # (/=) :: HealResultItem -> HealResultItem -> Bool #

data HealStatus Source #

Constructors

HealStatus
Fields hsSummary :: Text hsStartTime :: UTCTime hsSettings :: HealOpts hsNumDisks :: Int hsFailureDetail :: Maybe Text hsItems :: Maybe [HealResultItem]

Instances

Instances details

FromJSON HealStatus Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser HealStatus # parseJSONList :: Value -> Parser [HealStatus] #
Show HealStatus Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> HealStatus -> ShowS # show :: HealStatus -> String # showList :: [HealStatus] -> ShowS #
Eq HealStatus Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: HealStatus -> HealStatus -> Bool # (/=) :: HealStatus -> HealStatus -> Bool #

data HealStartResp Source #

Constructors

HealStartResp
Fields hsrClientToken :: Text hsrClientAddr :: Text hsrStartTime :: UTCTime

Instances

Instances details

FromJSON HealStartResp Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser HealStartResp # parseJSONList :: Value -> Parser [HealStartResp] #
Show HealStartResp Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> HealStartResp -> ShowS # show :: HealStartResp -> String # showList :: [HealStartResp] -> ShowS #
Eq HealStartResp Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: HealStartResp -> HealStartResp -> Bool # (/=) :: HealStartResp -> HealStartResp -> Bool #

startHeal :: Maybe Bucket -> Maybe Text -> HealOpts -> Minio HealStartResp Source #

Start a heal sequence that scans data under given (possible empty) bucket and prefix. The recursive bool turns on recursive traversal under the given path. dryRun does not mutate on-disk data, but performs data validation. Two heal sequences on overlapping paths may not be initiated. The progress of a heal should be followed using the HealStatus API. The server accumulates results of the heal traversal and waits for the client to receive and acknowledge them using the status API

forceStartHeal :: Maybe Bucket -> Maybe Text -> HealOpts -> Minio HealStartResp Source #

Similar to start a heal sequence, but force start a new heal sequence even if an active heal is under progress.

getHealStatus :: Maybe Bucket -> Maybe Text -> Text -> Minio HealStatus Source #

Get the progress of currently running heal task, this API should be invoked right after startHeal. token is obtained after startHeal which should be used to get the heal status.

data SetConfigResult Source #

Constructors

SetConfigResult
Fields scrStatus :: Bool scrNodeSummary :: [NodeSummary]

Instances

Instances details

FromJSON SetConfigResult Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser SetConfigResult # parseJSONList :: Value -> Parser [SetConfigResult] #
Show SetConfigResult Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> SetConfigResult -> ShowS # show :: SetConfigResult -> String # showList :: [SetConfigResult] -> ShowS #
Eq SetConfigResult Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: SetConfigResult -> SetConfigResult -> Bool # (/=) :: SetConfigResult -> SetConfigResult -> Bool #

data NodeSummary Source #

Constructors

NodeSummary
Fields nsName :: Text nsErrSet :: Bool nsErrMessage :: Text

Instances

Instances details

FromJSON NodeSummary Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser NodeSummary # parseJSONList :: Value -> Parser [NodeSummary] #
Show NodeSummary Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> NodeSummary -> ShowS # show :: NodeSummary -> String # showList :: [NodeSummary] -> ShowS #
Eq NodeSummary Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: NodeSummary -> NodeSummary -> Bool # (/=) :: NodeSummary -> NodeSummary -> Bool #

setConfig :: ByteString -> Minio SetConfigResult Source #

Set a new config to the server.

getConfig :: Minio ByteString Source #

Get the current config file from server.

data ServerVersion Source #

Constructors

ServerVersion
Fields svVersion :: Text svCommitId :: Text

Instances

Instances details

FromJSON ServerVersion Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser ServerVersion # parseJSONList :: Value -> Parser [ServerVersion] #
Show ServerVersion Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> ServerVersion -> ShowS # show :: ServerVersion -> String # showList :: [ServerVersion] -> ShowS #
Eq ServerVersion Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: ServerVersion -> ServerVersion -> Bool # (/=) :: ServerVersion -> ServerVersion -> Bool #

data ServiceStatus Source #

Constructors

ServiceStatus
Fields ssVersion :: ServerVersion ssUptime :: NominalDiffTime

Instances

Instances details

FromJSON ServiceStatus Source #
Instance details Defined in Network.Minio.AdminAPI Methods parseJSON :: Value -> Parser ServiceStatus # parseJSONList :: Value -> Parser [ServiceStatus] #
Show ServiceStatus Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> ServiceStatus -> ShowS # show :: ServiceStatus -> String # showList :: [ServiceStatus] -> ShowS #
Eq ServiceStatus Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: ServiceStatus -> ServiceStatus -> Bool # (/=) :: ServiceStatus -> ServiceStatus -> Bool #

serviceStatus :: Minio ServiceStatus Source #

Get server version and uptime.

data ServiceAction Source #

Constructors

ServiceActionRestart
ServiceActionStop

Instances

Instances details

ToJSON ServiceAction Source #
Instance details Defined in Network.Minio.AdminAPI Methods toJSON :: ServiceAction -> Value # toEncoding :: ServiceAction -> Encoding # toJSONList :: [ServiceAction] -> Value # toEncodingList :: [ServiceAction] -> Encoding #
Show ServiceAction Source #
Instance details Defined in Network.Minio.AdminAPI Methods showsPrec :: Int -> ServiceAction -> ShowS # show :: ServiceAction -> String # showList :: [ServiceAction] -> ShowS #
Eq ServiceAction Source #
Instance details Defined in Network.Minio.AdminAPI Methods (==) :: ServiceAction -> ServiceAction -> Bool # (/=) :: ServiceAction -> ServiceAction -> Bool #

serviceSendAction :: ServiceAction -> Minio () Source #

Send service restart or stop action to MinIO server.