diff --git a/pkg/madmin/API.md b/pkg/madmin/API.md
index 3b432e275..c8ca79117 100644
--- a/pkg/madmin/API.md
+++ b/pkg/madmin/API.md
@@ -36,10 +36,10 @@ func main() {
```
-| Service operations | LockInfo operations | Healing operations | Config operations | Misc |
-|:------------------------------------|:----------------------------|:--------------------------------------|:--------------------------|:------------------------------------|
-| [`ServiceStatus`](#ServiceStatus) | [`ListLocks`](#ListLocks) | [`Heal`](#Heal) | [`GetConfig`](#GetConfig) | [`SetCredentials`](#SetCredentials) |
-| [`ServiceSendAction`](#ServiceSendAction) | [`ClearLocks`](#ClearLocks) | | [`SetConfig`](#SetConfig) | |
+| Service operations | Info operations | LockInfo operations | Healing operations | Config operations | Misc |
+|:------------------------------------|:----------------------------|:----------------------------|:--------------------------------------|:--------------------------|:------------------------------------|
+| [`ServiceStatus`](#ServiceStatus) | [`ServerInfo`](#ServerInfo) | [`ListLocks`](#ListLocks) | [`Heal`](#Heal) | [`GetConfig`](#GetConfig) | [`SetCredentials`](#SetCredentials) |
+| [`ServiceSendAction`](#ServiceSendAction) | | [`ClearLocks`](#ClearLocks) | | [`SetConfig`](#SetConfig) | |
## 1. Constructor
@@ -50,7 +50,6 @@ Initializes a new admin client object.
__Parameters__
-
|Param |Type |Description |
|:---|:---| :---|
|`endpoint` | _string_ |Minio endpoint. |
@@ -91,22 +90,10 @@ Fetch service status, replies disk space used, backend type and total disks offl
|---|---|---|
|`st.ServerVersion.Version` | _string_ | Server version. |
|`st.ServerVersion.CommitID` | _string_ | Server commit id. |
-|`st.StorageInfo.Total` | _int64_ | Total disk space. |
-|`st.StorageInfo.Free` | _int64_ | Free disk space. |
-|`st.StorageInfo.Backend`| _struct{}_ | Represents backend type embedded structure. |
-
-| Param | Type | Description |
-|---|---|---|
-|`backend.Type` | _BackendType_ | Type of backend used by the server currently only FS or Erasure. |
-|`backend.OnlineDisks`| _int_ | Total number of disks online (only applies to Erasure backend), is empty for FS. |
-|`backend.OfflineDisks` | _int_ | Total number of disks offline (only applies to Erasure backend), is empty for FS. |
-|`backend.StandardSCParity` | _int_ | Parity disks set for standard storage class, is empty for FS. |
-|`backend.RRSCParity` | _int_ | Parity disks set for reduced redundancy storage class, is empty for FS. |
-
+|`st.Uptime` | _time.Duration_ | Server uptime duration in seconds. |
__Example__
-
```go
st, err := madmClnt.ServiceStatus()
@@ -125,24 +112,80 @@ Sends a service action command to service - possible actions are restarting and
```go
-
- // to restart
+ // to restart
st, err := madmClnt.ServiceSendAction(ServiceActionValueRestart)
- // or to stop
- // st, err := madmClnt.ServiceSendAction(ServiceActionValueStop)
+ // or to stop
+ // st, err := madmClnt.ServiceSendAction(ServiceActionValueStop)
if err != nil {
log.Fatalln(err)
}
log.Printf("Success")
-
```
## 4. Info operations
### ServerInfo() ([]ServerInfo, error)
-Fetch all information for all cluster nodes, such as uptime, region, network statistics, etc..
+Fetches information for all cluster nodes, such as server properties, storage information, network statistics, etc.
+| Param | Type | Description |
+|---|---|---|
+|`si.Addr` | _string_ | Address of the server the following information is retrieved from. |
+|`si.ConnStats` | _ServerConnStats_ | Connection statistics from the given server. |
+|`si.HTTPStats` | _ServerHTTPStats_ | HTTP connection statistics from the given server. |
+|`si.Properties` | _ServerProperties_ | Server properties such as region, notification targets. |
+|`si.Data.StorageInfo.Total` | _int64_ | Total disk space. |
+|`si.Data.StorageInfo.Free` | _int64_ | Free disk space. |
+|`si.Data.StorageInfo.Backend`| _struct{}_ | Represents backend type embedded structure. |
+
+| Param | Type | Description |
+|---|---|---|
+|`ServerProperties.Uptime`| _time.Duration_ | Total duration in seconds since server is running. |
+|`ServerProperties.Version`| _string_ | Current server version. |
+|`ServerProperties.CommitID` | _string_ | Current server commitID. |
+|`ServerProperties.Region` | _string_ | Configured server region. |
+|`ServerProperties.SQSARN` | _[]string_ | List of notification target ARNs. |
+
+| Param | Type | Description |
+|---|---|---|
+|`ServerConnStats.TotalInputBytes` | _uint64_ | Total bytes received by the server. |
+|`ServerConnStats.TotalOutputBytes` | _uint64_ | Total bytes sent by the server. |
+
+| Param | Type | Description |
+|---|---|---|
+|`ServerHTTPStats.TotalHEADStats`| _ServerHTTPMethodStats_ | Total statistics regarding HEAD operations |
+|`ServerHTTPStats.SuccessHEADStats`| _ServerHTTPMethodStats_ | Total statistics regarding successful HEAD operations |
+|`ServerHTTPStats.TotalGETStats`| _ServerHTTPMethodStats_ | Total statistics regarding GET operations |
+|`ServerHTTPStats.SuccessGETStats`| _ServerHTTPMethodStats_ | Total statistics regarding successful GET operations |
+|`ServerHTTPStats.TotalPUTStats`| _ServerHTTPMethodStats_ | Total statistics regarding PUT operations |
+|`ServerHTTPStats.SuccessPUTStats`| _ServerHTTPMethodStats_ | Total statistics regarding successful PUT operations |
+|`ServerHTTPStats.TotalPOSTStats`| _ServerHTTPMethodStats_ | Total statistics regarding POST operations |
+|`ServerHTTPStats.SuccessPOSTStats`| _ServerHTTPMethodStats_ | Total statistics regarding successful POST operations |
+|`ServerHTTPStats.TotalDELETEStats`| _ServerHTTPMethodStats_ | Total statistics regarding DELETE operations |
+|`ServerHTTPStats.SuccessDELETEStats`| _ServerHTTPMethodStats_ | Total statistics regarding successful DELETE operations |
+
+
+| Param | Type | Description |
+|---|---|---|
+|`ServerHTTPMethodStats.Count` | _uint64_ | Total number of operations. |
+|`ServerHTTPMethodStats.AvgDuration` | _string_ | Average duration of Count number of operations. |
+
+| Param | Type | Description |
+|---|---|---|
+|`Backend.Type` | _BackendType_ | Type of backend used by the server currently only FS or Erasure. |
+|`Backend.OnlineDisks`| _int_ | Total number of disks online (only applies to Erasure backend), is empty for FS. |
+|`Backend.OfflineDisks` | _int_ | Total number of disks offline (only applies to Erasure backend), is empty for FS. |
+|`Backend.StandardSCData` | _int_ | Data disks set for standard storage class, is empty for FS. |
+|`Backend.StandardSCParity` | _int_ | Parity disks set for standard storage class, is empty for FS. |
+|`Backend.RRSCData` | _int_ | Data disks set for reduced redundancy storage class, is empty for FS. |
+|`Backend.RRSCParity` | _int_ | Parity disks set for reduced redundancy storage class, is empty for FS. |
+|`Backend.Sets` | _[][]DriveInfo_ | Represents topology of drives in erasure coded sets. |
+
+| Param | Type | Description |
+|---|---|---|
+|`DriveInfo.UUID`| _string_ | Unique ID for each disk provisioned by server format. |
+|`DriveInfo.Endpoint` | _string_ | Endpoint location of the remote/local disk. |
+|`DriveInfo.State` | _string_ | Current state of the disk at endpoint. |
__Example__
@@ -342,7 +385,6 @@ __Example__
## 8. Misc operations
-
### SetCredentials() error
Set new credentials of a Minio setup.