Safe Haskell	None
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 #

Constructors

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

Instances

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

data ErasureInfo #

Constructors

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

Instances

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

data Backend #

Constructors

BackendFS
BackendErasure ErasureInfo

Instances

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

data ConnStats #

Constructors

ConnStats
Fields csTransferred :: Int64 csReceived :: Int64

Instances

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

data HttpStats #

Constructors

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

Instances

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

data ServerProps #

Constructors

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

Instances

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

data CountNAvgTime #

Constructors

CountNAvgTime
Fields caCount :: Int64 caAvgDuration :: Text

Instances

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

data StorageClass #

Constructors

StorageClass
Fields scParity :: Int scData :: Int

Instances

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

data StorageInfo #

Constructors

StorageInfo
Fields siUsed :: Int64 siBackend :: Backend

Instances

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

data SIData #

Constructors

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

Instances

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

data ServerInfo #

Constructors

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

Instances

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

getServerInfo :: Minio [ServerInfo] #

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

data HealOpts #

Constructors

HealOpts
Fields hoRecursive :: Bool hoDryRun :: Bool

Instances

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

data HealResultItem #

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

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

data HealStatus #

Constructors

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

Instances

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

data HealStartResp #

Constructors

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

Instances

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

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

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 #

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 #

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 #

Constructors

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

Instances

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

data NodeSummary #

Constructors

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

Instances

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

setConfig :: ByteString -> Minio SetConfigResult #

Set a new config to the server.

getConfig :: Minio ByteString #

Get the current config file from server.

data ServerVersion #

Constructors

ServerVersion
Fields svVersion :: Text svCommitId :: Text

Instances

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

data ServiceStatus #

Constructors

ServiceStatus
Fields ssVersion :: ServerVersion ssUptime :: NominalDiffTime

Instances

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

serviceStatus :: Minio ServiceStatus #

Get server version and uptime.

data ServiceAction #

Constructors

ServiceActionRestart
ServiceActionStop

Instances

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

serviceSendAction :: ServiceAction -> Minio () #

Send service restart or stop action to Minio server.