MyFavMirrors/minio
1
0
Fork 0
mirror of https://github.com/minio/minio.git synced 2025-05-22 18:11:50 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix admin heal API description (#6073)

Browse Source
This commit is contained in:
Harshavardhana 2018-06-26 10:53:14 -07:00 committed by kannappanr
parent ad79c626c6
commit d9d13c898c
1 changed files with 18 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
pkg/madmin/API.md
View File

@ -243,25 +243,26 @@ __Example__
Start a heal sequence that scans data under given (possible empty) Start a heal sequence that scans data under given (possible empty)
`bucket` and `prefix`. The `recursive` bool turns on recursive `bucket` and `prefix`. The `recursive` bool turns on recursive
traversal under the given path. `dryRun` does not mutate on-disk data, traversal under the given path. `dryRun` does not mutate on-disk data,
but performs data validation. `incomplete` enables healing of but performs data validation.
multipart uploads that are in progress. `removeBadFiles` removes
unrecoverable files. `statisticsOnly` turns off detailed
heal-operations reporting in the status call.
Two heal sequences on overlapping paths may not be initiated. Two heal sequences on overlapping paths may not be initiated.
The progress of a heal should be followed using the `HealStatus` The progress of a heal should be followed using the same API `Heal`
by providing the `clientToken` previously obtained from a `Heal`
API. The server accumulates results of the heal traversal and waits API. The server accumulates results of the heal traversal and waits
for the client to receive and acknowledge them using the status for the client to receive and acknowledge them using the status
API. When the statistics-only option is set, the server only maintains request by providing `clientToken`.
aggregates statistics - in this case, no acknowledgement of results is
required.
__Example__ __Example__
``` go ``` go
healPath, err := madmClnt.HealStart("", "", true, false, true, false, false) opts := madmin.HealOpts{
Recursive: true,
DryRun: false,
}
forceStart := false
healPath, err := madmClnt.Heal("", "", opts, "", forceStart)
if err != nil { if err != nil {
log.Fatalln(err) log.Fatalln(err)
} }
@ -269,6 +270,14 @@ __Example__
``` ```
#### HealStartSuccess structure
| Param | Type | Description |
|----|--------|--------|
| s.ClientToken | _string_ | A unique token for a successfully started heal operation, this token is used to request realtime progress of the heal operation. |
| s.ClientAddress | _string_ | Address of the client which initiated the heal operation, the client address has the form "host:port".|
| s.StartTime | _time.Time_ | Time when heal was initially started.|
#### HealTaskStatus structure #### HealTaskStatus structure
| Param | Type | Description | | Param | Type | Description |
@ -277,7 +286,6 @@ __Example__
| s.FailureDetail | _string_ | Error message in case of heal sequence failure | | s.FailureDetail | _string_ | Error message in case of heal sequence failure |
| s.HealSettings | _HealOpts_ | Contains the booleans set in the `HealStart` call | | s.HealSettings | _HealOpts_ | Contains the booleans set in the `HealStart` call |
| s.Items | _[]HealResultItem_ | Heal records for actions performed by server | | s.Items | _[]HealResultItem_ | Heal records for actions performed by server |
| s.Statistics | _HealStatistics_ | Aggregate of heal records from beginning |
#### HealResultItem structure #### HealResultItem structure
@ -291,38 +299,6 @@ __Example__
| DiskInfo.AvailableOn | _[]int_ | List of disks on which the healed entity is present and healthy | | DiskInfo.AvailableOn | _[]int_ | List of disks on which the healed entity is present and healthy |
| DiskInfo.HealedOn | _[]int_ | List of disks on which the healed entity was restored | | DiskInfo.HealedOn | _[]int_ | List of disks on which the healed entity was restored |
#### HealStatistics structure
Most parameters represent the aggregation of heal operations since the
start of the heal sequence.
| Param | Type | Description |
|-------|-----|----------|
| NumDisks | _int_ | Number of disks configured in the backend |
| NumBucketsScanned | _int64_ | Number of buckets scanned |
| BucketsMissingByDisk | _map[int]int64_ | Map of disk to number of buckets missing |
| BucketsAvailableByDisk | _map[int]int64_ | Map of disk to number of buckets available |
| BucketsHealedByDisk | _map[int]int64_ | Map of disk to number of buckets healed on |
| NumObjectsScanned | _int64_ | Number of objects scanned |
| NumUploadsScanned | _int64_ | Number of uploads scanned |
| ObjectsByAvailablePC | _map[int64]_ | Map of available part counts (after heal) to number of objects |
| ObjectsByHealedPC | _map[int64]_ | Map of healed part counts to number of objects |
| ObjectsMissingByDisk | _map[int64]_ | Map of disk number to number of objects with parts missing on that disk |
| ObjectsAvailableByDisk | _map[int64]_ | Map of disk number to number of objects available on that disk |
| ObjectsHealedByDisk | _map[int64]_ | Map of disk number to number of objects healed on that disk |
__Example__
``` go
res, err := madmClnt.HealStatus("", "")
if err != nil {
log.Fatalln(err)
}
log.Printf("Heal sequence status data %#v", res)
```
## 7. Config operations ## 7. Config operations
<a name="GetConfig"></a> <a name="GetConfig"></a>