1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
|
// Copyright (c) 2015-2025 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
package madmin
import (
"context"
"errors"
"fmt"
"net/http"
"net/url"
"github.com/tinylib/msgp/msgp"
)
//go:generate msgp -unexported -file=$GOFILE
// ObjectSummaryOptions provides options for ObjectSummary call.
type ObjectSummaryOptions struct {
Bucket, Object string
}
// ObjectSummary calls minio to search for all files and parts
// related to the given object, across all disks.
func (adm *AdminClient) ObjectSummary(ctx context.Context, objOpts ObjectSummaryOptions) (objectSummary *ObjectSummary, err error) {
form := make(url.Values)
if objOpts.Bucket == "" {
return nil, errors.New("no bucket speficied")
}
if objOpts.Object == "" {
return nil, errors.New("no object speficied")
}
form.Add("bucket", objOpts.Bucket)
form.Add("object", objOpts.Object)
resp, err := adm.executeMethod(ctx,
http.MethodGet,
requestData{
relPath: fmt.Sprintf(adminAPIPrefix + "/object-summary"),
queryValues: form,
})
defer closeResponse(resp)
if err != nil {
return nil, err
}
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
objectSummary = new(ObjectSummary)
err = msgp.Decode(resp.Body, objectSummary)
if err != nil {
return nil, err
}
return
}
// ObjectMetaSummary is returned from minio when calling ObjectSummary
// This struct gives specific information about xl.meta files
// belonging to the object being inspected by the ObjectSummary API.
type ObjectMetaSummary struct {
Filename string
Host string
Drive string
Size int64
Errors []string
IsDeleteMarker bool
ModTime int64
Signature [4]byte
}
// ObjectPartSummary is returned from minio when calling ObjectSummary.
// This struct gives specific information about each part of the object
// being inspected by the ObjectSummary API.
type ObjectPartSummary struct {
Part int
Pool int
Host string
Set int
Drive string
Filename string
Size int64
}
// ObjectSummary is returned from minio when calling ObjectSummary.
type ObjectSummary struct {
Name string
Errors []string
// DataDir represents the directory on disk created using
// the version ID's or a random uuid if the object is not
// versioned.
DataDir string
IsInline bool
PartNumbers []int
ErasureDist []uint8
Metas []*ObjectMetaSummary
Parts []*ObjectPartSummary
}
|