api

package

Go to main page

Versions in this module

v1

v1.3.27

Feb 14, 2025

Changes in this version

+ type ETLObjArgs struct

+ ETLName string

+ TransformArgs any

v1.3.26

Feb 7, 2025

Changes in this version

+ func ReloadBackendCreds(bp BaseParams, provider string) error

+ func SetPrimary(bp BaseParams, newPrimaryID, newPrimaryURL string, force bool) error

type PutArgs

+ Header http.Header

v1.3.25

Oct 6, 2024

v1.3.24

Sep 27, 2024

Changes in this version

+ func DisableBackend(bp BaseParams, provider string) error

+ func DisableRebalance(bp BaseParams) error

+ func EnableBackend(bp BaseParams, provider string) error

+ func EnableRebalance(bp BaseParams) error

+ func FshcMountpath(bp BaseParams, node *meta.Snode, mountpath string) error

+ func GetAnyStats(bp BaseParams, sid, what string) (out []byte, err error)

+ func GetConfiguredBackends(bp BaseParams) (out []string, err error)

+ func GetX509Info(bp BaseParams, nodeID ...string) (info cos.StrKVs, err error)

+ func LoadX509Cert(bp BaseParams, nodeID ...string) error

+ func RescanMountpath(bp BaseParams, node *meta.Snode, mountpath string, dontResilver bool) error

type BinfoArgs

+ Prefix string

+ type HeadArgs struct

+ FltPresence int

+ LatestVer bool

+ Silent bool

+ ValidateCksum bool

v1.3.23

May 27, 2024

Changes in this version

+ func GetStatsAndStatusV322(bp BaseParams, node *meta.Snode) (ds *stats.NodeStatusV322, err error)

type ListArgs

+ Header http.Header

v1.3.22

Feb 25, 2024

Changes in this version

+ func BlobDownload(bp BaseParams, bck cmn.Bck, objName string, msg *apc.BlobMsg) (xid string, err error)

+ func DeleteMultiObj(bp BaseParams, bck cmn.Bck, objNames []string, template string) (string, error)

+ func EvictMultiObj(bp BaseParams, bck cmn.Bck, objNames []string, template string) (string, error)

+ func Prefetch(bp BaseParams, bck cmn.Bck, msg apc.PrefetchMsg) (string, error)

+ func PrefetchObject(bp BaseParams, bck cmn.Bck, objName string) (string, error)

+ func RotateClusterLogs(bp BaseParams) error

+ func RotateLogs(bp BaseParams, nodeID string) error

v1.3.21

Nov 5, 2023

Changes in this version

+ func AbortDsort(bp BaseParams, managerUUID string) error

+ func ListDsort(bp BaseParams, regex string, onlyActive bool) (jobInfos []*dsort.JobInfo, err error)

+ func MetricsDsort(bp BaseParams, managerUUID string) (metrics map[string]*dsort.JobInfo, err error)

+ func RemoveDsort(bp BaseParams, managerUUID string) error

+ func StartDsort(bp BaseParams, rs *dsort.RequestSpec) (id string, err error)

+ type BinfoArgs struct

+ DontAddRemote bool

+ FltPresence int

+ Summarize bool

+ UUID string

+ WithRemote bool

+ type BsummArgs struct

+ CallAfter time.Duration

+ Callback BsummCB

+ DontWait bool

+ type BsummCB func(*cmn.AllBsummResults, bool)

type ListArgs

+ CallAfter time.Duration

+ Callback LsoCB

+ Limit uint

+ type LsoCB func(*LsoCounter)

+ type LsoCounter struct

+ func (ctx *LsoCounter) Count() int

+ func (ctx *LsoCounter) Elapsed() time.Duration

+ func (ctx *LsoCounter) IsFinished() bool

v1.3.20

Sep 12, 2023

v1.3.19

Aug 29, 2023

Changes in this version

+ func GetNodeMeta(bp BaseParams, sid, what string) (out any, err error)

type GetLogInput

+ All bool

v1.3.18

Jul 9, 2023

Changes in this version

+ func ArchiveMultiObj(bp BaseParams, bckFrom cmn.Bck, msg cmn.ArchiveBckMsg) (string, error)

+ func PutApndArch(args PutApndArchArgs) (err error)

+ func RemoveNodeUnsafe(bp BaseParams, sid string) error

+ type ListArgs struct

+ Num uint

+ Progress *ProgressContext

+ type PutApndArchArgs struct

+ ArchPath string

+ Flags int64

+ Mime string

v1.3.17

Apr 10, 2023

v1.3.16

Mar 31, 2023

Changes in this version

+ func ETLMetrics(params BaseParams, etlName string) (healths etl.CPUMemByTarget, err error)

+ func GetAllRunningXactions(bp BaseParams, kindOrName string) (out []string, err error)

+ func GetAllXactionStatus(bp BaseParams, args xact.ArgsMsg, force bool) (matching nl.StatusVec, err error)

+ func GetDiskStats(bp BaseParams, tid string) (res ios.AllDiskStats, err error)

+ func GetMetricNames(bp BaseParams, node *cluster.Snode) (kvs cos.StrKVs, err error)

+ func GetOneXactionStatus(bp BaseParams, args xact.ArgsMsg) (status *nl.Status, err error)

+ func GetStatsAndStatus(bp BaseParams, node *cluster.Snode) (daeStatus *stats.NodeStatus, err error)

+ func ResetClusterStats(bp BaseParams, errorsOnly bool) (err error)

+ func ResetDaemonStats(bp BaseParams, node *cluster.Snode, errorsOnly bool) (err error)

+ type GetArgs struct

+ Header http.Header

+ Query url.Values

+ Writer io.Writer

type GetLogInput

+ Offset int64

+ type ObjAttrs struct

+ func (oah *ObjAttrs) Attrs() (out cmn.ObjAttrs)

+ func (oah *ObjAttrs) RespHeader() http.Header

+ func (oah *ObjAttrs) Size() int64

+ type PutArgs struct

+ BaseParams BaseParams

+ Bck cmn.Bck

+ Cksum *cos.Cksum

+ ObjName string

+ Reader cos.ReadOpenCloser

+ Size uint64

+ SkipVC bool

type ReqParams

+ func (reqParams *ReqParams) DoReqAny(out any) (int, error)

v1.3.15

Nov 13, 2022

v1.3.13

Nov 9, 2022

v1.3.12

Nov 7, 2022

Changes in this version

+ const StatusOffline

+ const StatusOnline

+ const StatusTimedOut

+ func AbortDSort(bp BaseParams, managerUUID string) error

+ func AbortDownload(bp BaseParams, id string) error

+ func AbortXaction(bp BaseParams, args XactReqArgs) error

+ func AccessAttrs(v apc.AccessAttrs) *apc.AccessAttrs

+ func AppendObject(args AppendArgs) (string, error)

+ func AppendToArch(args AppendToArchArgs) (err error)

+ func AttachMountpath(bp BaseParams, node *cluster.Snode, mountpath string, force bool) error

+ func AttachRemoteAIS(bp BaseParams, alias, u string) error

+ func Bool(v bool) *bool

+ func CopyBucket(bp BaseParams, fromBck, toBck cmn.Bck, msg *apc.CopyBckMsg) (xactID string, err error)

+ func CopyMultiObj(bp BaseParams, fromBck cmn.Bck, msg cmn.TCObjsMsg) (xactID string, err error)

+ func CreateArchMultiObj(bp BaseParams, fromBck cmn.Bck, msg cmn.ArchiveMsg) (string, error)

+ func CreateBucket(bp BaseParams, bck cmn.Bck, props *cmn.BucketPropsToUpdate) error

+ func DecommissionCluster(bp BaseParams, rmUserData bool) error

+ func DecommissionNode(bp BaseParams, actValue *apc.ActValRmNode) (xid string, err error)

+ func DeleteList(bp BaseParams, bck cmn.Bck, filesList []string) (string, error)

+ func DeleteObject(bp BaseParams, bck cmn.Bck, object string) error

+ func DeleteRange(bp BaseParams, bck cmn.Bck, rng string) (string, error)

+ func DestroyBucket(bp BaseParams, bck cmn.Bck) error

+ func DetachMountpath(bp BaseParams, node *cluster.Snode, mountpath string, dontResilver bool) error

+ func DetachRemoteAIS(bp BaseParams, alias string) error

+ func DisableMountpath(bp BaseParams, node *cluster.Snode, mountpath string, dontResilver bool) error

+ func DoWithRetry(client *http.Client, cb NewRequestCB, reqArgs *cmn.HreqArgs) (resp *http.Response, err error)

+ func DownloadBackend(bp BaseParams, description string, bck cmn.Bck, prefix, suffix string, ...) (string, error)

+ func DownloadGetList(bp BaseParams, regex string) (dlList downloader.DlJobInfos, err error)

+ func DownloadMulti(bp BaseParams, description string, bck cmn.Bck, msg any, ...) (string, error)

+ func DownloadRange(bp BaseParams, description string, bck cmn.Bck, template string, ...) (string, error)

+ func DownloadSingle(bp BaseParams, description string, bck cmn.Bck, objName, link string, ...) (string, error)

+ func DownloadStatus(bp BaseParams, id string, onlyActiveTasks ...bool) (resp downloader.DlStatusResp, err error)

+ func DownloadWithParam(bp BaseParams, dlt downloader.DlType, body any) (id string, err error)

+ func Duration(v time.Duration) *time.Duration

+ func ECEncodeBucket(bp BaseParams, bck cmn.Bck, data, parity int) (xactID string, err error)

+ func ETLBucket(bp BaseParams, fromBck, toBck cmn.Bck, bckMsg *apc.TCBMsg) (xactID string, err error)

+ func ETLDelete(bp BaseParams, id string) (err error)

+ func ETLGetInitMsg(params BaseParams, id string) (initMsg etl.InitMsg, err error)

+ func ETLHealth(params BaseParams, id string) (healths etl.PodsHealthMsg, err error)

+ func ETLInit(bp BaseParams, msg etl.InitMsg) (id string, err error)

+ func ETLList(bp BaseParams) (list []etl.Info, err error)

+ func ETLLogs(bp BaseParams, id string, targetID ...string) (logs etl.PodsLogsMsg, err error)

+ func ETLMultiObj(bp BaseParams, fromBck cmn.Bck, msg cmn.TCObjsMsg) (xactID string, err error)

+ func ETLObject(bp BaseParams, id string, bck cmn.Bck, objName string, w io.Writer) (err error)

+ func ETLStart(bp BaseParams, id string) (err error)

+ func ETLStop(bp BaseParams, id string) (err error)

+ func EnableMountpath(bp BaseParams, node *cluster.Snode, mountpath string) error

+ func EvictList(bp BaseParams, bck cmn.Bck, fileslist []string) (string, error)

+ func EvictObject(bp BaseParams, bck cmn.Bck, object string) error

+ func EvictRange(bp BaseParams, bck cmn.Bck, rng string) (string, error)

+ func EvictRemoteBucket(bp BaseParams, bck cmn.Bck, keepMD bool) error

+ func FlushObject(args FlushArgs) error

+ func FreeRp(reqParams *ReqParams)

+ func GetBMD(bp BaseParams) (*cluster.BMD, error)

+ func GetBucketInfo(bp BaseParams, bck cmn.Bck, fltPresence int) (p *cmn.BucketProps, info *cmn.BsummResult, err error)

+ func GetBucketSummary(bp BaseParams, qbck cmn.QueryBcks, msg *cmn.BsummCtrlMsg) (cmn.AllBsummResults, error)

+ func GetClusterConfig(bp BaseParams) (*cmn.ClusterConfig, error)

+ func GetClusterMap(bp BaseParams) (smap *cluster.Smap, err error)

+ func GetClusterStats(bp BaseParams) (res stats.ClusterStats, err error)

+ func GetClusterSysInfo(bp BaseParams) (info apc.ClusterSysInfo, err error)

+ func GetDaemonConfig(bp BaseParams, node *cluster.Snode) (config *cmn.Config, err error)

+ func GetDaemonLog(bp BaseParams, node *cluster.Snode, args GetLogInput) error

+ func GetDaemonStats(bp BaseParams, node *cluster.Snode) (ds *stats.DaemonStats, err error)

+ func GetDaemonStatus(bp BaseParams, node *cluster.Snode) (daeInfo *stats.DaemonStatus, err error)

+ func GetMountpaths(bp BaseParams, node *cluster.Snode) (mpl *apc.MountpathList, err error)

+ func GetNodeClusterMap(bp BaseParams, sid string) (smap *cluster.Smap, err error)

+ func GetObject(bp BaseParams, bck cmn.Bck, object string, options ...GetObjectInput) (n int64, err error)

+ func GetObjectReader(bp BaseParams, bck cmn.Bck, object string, options ...GetObjectInput) (r io.ReadCloser, err error)

+ func GetObjectS3(bp BaseParams, bck cmn.Bck, objectName string, options ...GetObjectInput) (int64, error)

+ func GetObjectWithResp(bp BaseParams, bck cmn.Bck, object string, options ...GetObjectInput) (*http.Response, int64, error)

+ func GetObjectWithValidation(bp BaseParams, bck cmn.Bck, object string, options ...GetObjectInput) (n int64, err error)

+ func GetProxyReadiness(bp BaseParams) error

+ func GetRemoteAIS(bp BaseParams) (remais cluster.Remotes, err error)

+ func GetTargetDiskStats(bp BaseParams, tid string) (res ios.AllDiskStats, err error)

+ func GetWhatRawQuery(getWhat, getProps string) string

+ func GetXactionStatus(bp BaseParams, args XactReqArgs) (status *nl.NotifStatus, err error)

+ func HTTPStatus(err error) int

+ func HeadBucket(bp BaseParams, bck cmn.Bck, dontAddRemote bool) (p *cmn.BucketProps, err error)

+ func HeadObject(bp BaseParams, bck cmn.Bck, object string, fltPresence int) (*cmn.ObjectProps, error)

+ func Health(bp BaseParams, readyToRebalance ...bool) error

+ func HealthUptime(bp BaseParams, readyToRebalance ...bool) (string, string, error)

+ func Int(v int) *int

+ func Int64(v int64) *int64

+ func JoinCluster(bp BaseParams, nodeInfo *cluster.Snode) (rebID, sid string, err error)

+ func ListBuckets(bp BaseParams, qbck cmn.QueryBcks, fltPresence int) (cmn.Bcks, error)

+ func ListDSort(bp BaseParams, regex string) (jobsInfos []*dsort.JobInfo, err error)

+ func ListObjects(bp BaseParams, bck cmn.Bck, lsmsg *apc.LsoMsg, numObj uint) (*cmn.LsoResult, error)

+ func ListObjectsInvalidateCache(bp BaseParams, bck cmn.Bck) error

+ func ListObjectsPage(bp BaseParams, bck cmn.Bck, lsmsg *apc.LsoMsg) (*cmn.LsoResult, error)

+ func ListObjectsWithOpts(bp BaseParams, bck cmn.Bck, lsmsg *apc.LsoMsg, numObj uint, ...) (lst *cmn.LsoResult, err error)

+ func MakeNCopies(bp BaseParams, bck cmn.Bck, copies int) (xactID string, err error)

+ func MetricsDSort(bp BaseParams, managerUUID string) (metrics map[string]*dsort.Metrics, err error)

+ func PrefetchList(bp BaseParams, bck cmn.Bck, fileslist []string) (string, error)

+ func PrefetchRange(bp BaseParams, bck cmn.Bck, rng string) (string, error)

+ func Promote(args *PromoteArgs) (xactID string, err error)

+ func PutObject(args PutObjectArgs) (err error)

+ func QueryBuckets(bp BaseParams, qbck cmn.QueryBcks, fltPresence int) (bool, error)

+ func RemoveDSort(bp BaseParams, managerUUID string) error

+ func RemoveDownload(bp BaseParams, id string) error

+ func RemoveNodeFromSmap(bp BaseParams, sid string) error

+ func RenameBucket(bp BaseParams, fromBck, toBck cmn.Bck) (xactID string, err error)

+ func RenameObject(bp BaseParams, bck cmn.Bck, oldName, newName string) error

+ func ResetBucketProps(bp BaseParams, bck cmn.Bck, query ...url.Values) (string, error)

+ func ResetClusterConfig(bp BaseParams) error

+ func ResetDaemonConfig(bp BaseParams, nodeID string) error

+ func SetAuxHeaders(r *http.Request, bp *BaseParams)

+ func SetBucketProps(bp BaseParams, bck cmn.Bck, props *cmn.BucketPropsToUpdate, ...) (string, error)

+ func SetClusterConfig(bp BaseParams, nvs cos.StrKVs, transient bool) error

+ func SetClusterConfigUsingMsg(bp BaseParams, configToUpdate *cmn.ConfigToUpdate, transient bool) error

+ func SetDaemonConfig(bp BaseParams, nodeID string, nvs cos.StrKVs, transient ...bool) error

+ func SetObjectCustomProps(bp BaseParams, bck cmn.Bck, object string, custom cos.StrKVs, setNew bool) error

+ func SetPrimaryProxy(bp BaseParams, newPrimaryID string, force bool) error

+ func ShutdownCluster(bp BaseParams) error

+ func ShutdownNode(bp BaseParams, actValue *apc.ActValRmNode) (id string, err error)

+ func StartDSort(bp BaseParams, rs dsort.RequestSpec) (string, error)

+ func StartMaintenance(bp BaseParams, actValue *apc.ActValRmNode) (xid string, err error)

+ func StartXaction(bp BaseParams, args XactReqArgs) (id string, err error)

+ func StopMaintenance(bp BaseParams, actValue *apc.ActValRmNode) (xid string, err error)

+ func String(v string) *string

+ func WaitForXactionIC(bp BaseParams, args XactReqArgs) (status *nl.NotifStatus, err error)

+ func WaitForXactionIdle(bp BaseParams, args XactReqArgs) error

+ func WaitForXactionNode(bp BaseParams, args XactReqArgs, fn func(NodesXactMultiSnap) bool) error

+ func WritePolicy(v apc.WritePolicy) *apc.WritePolicy

+ type AppendArgs struct

+ BaseParams BaseParams

+ Bck cmn.Bck

+ Handle string

+ Object string

+ Reader cos.ReadOpenCloser

+ Size int64

+ type AppendToArchArgs struct

+ ArchPath string

+ type BaseParams struct

+ Client *http.Client

+ Method string

+ Token string

+ UA string

+ URL string

+ type FlushArgs struct

+ BaseParams BaseParams

+ Bck cmn.Bck

+ Cksum *cos.Cksum

+ Handle string

+ Object string

+ type GetLogInput struct

+ Severity string

+ Writer io.Writer

+ type GetObjectInput struct

+ Header http.Header

+ Query url.Values

+ Writer io.Writer

+ type NewRequestCB func(args *cmn.HreqArgs) (*http.Request, error)

+ type NodesXactMultiSnap map[string][]*xact.SnapExt

+ func QueryXactionSnaps(bp BaseParams, args XactReqArgs) (xs NodesXactMultiSnap, err error)

+ func (xs NodesXactMultiSnap) ByteCounts() (locBytes, outBytes, inBytes int64)

+ func (xs NodesXactMultiSnap) Idle() bool

+ func (xs NodesXactMultiSnap) ObjCounts() (locObjs, outObjs, inObjs int64)

+ func (xs NodesXactMultiSnap) Running() (tid string, xsnap *xact.SnapExt)

+ type NodesXactSnap map[string]*xact.SnapExt

+ func GetXactionSnapsByID(bp BaseParams, xactID string) (nxs NodesXactSnap, err error)

+ func (nxs NodesXactSnap) ByteCounts() (locBytes, outBytes, inBytes int64)

+ func (nxs NodesXactSnap) Finished() bool

+ func (nxs NodesXactSnap) IsAborted() bool

+ func (nxs NodesXactSnap) ObjCounts() (locObjs, outObjs, inObjs int64)

+ func (nxs NodesXactSnap) TotalRunningTime() time.Duration

+ type ProgressCallback = func(pi *ProgressContext)

+ type ProgressContext struct

+ func NewProgressContext(cb ProgressCallback, after time.Duration) *ProgressContext

+ func (ctx *ProgressContext) Elapsed() time.Duration

+ func (ctx *ProgressContext) Info() ProgressInfo

+ func (ctx *ProgressContext) IsFinished() bool

+ type ProgressInfo struct

+ Count int

+ Percent float64

+ Total int

+ type PromoteArgs struct

+ BaseParams BaseParams

+ Bck cmn.Bck

+ type PutObjectArgs struct

+ BaseParams BaseParams

+ Bck cmn.Bck

+ Cksum *cos.Cksum

+ Object string

+ Reader cos.ReadOpenCloser

+ Size uint64

+ SkipVC bool

+ type ReqParams struct

+ BaseParams BaseParams

+ Body []byte

+ Header http.Header

+ Password string

+ Path string

+ Query url.Values

+ User string

+ Validate bool

+ func AllocRp() *ReqParams

+ func (reqParams *ReqParams) DoReqResp(v any) error

+ func (reqParams *ReqParams) DoRequest() error

+ func (reqParams *ReqParams) DoRequestHdr() (http.Header, error)

+ type XactReqArgs struct

+ Bck cmn.Bck

+ Buckets []cmn.Bck

+ DaemonID string

+ Force bool

+ ID string

+ Kind string

+ OnlyRunning bool

+ Timeout time.Duration

+ type XactStatsHelper interface

+ Aborted func() bool

+ Finished func() bool

+ ObjCount func() int64

+ Running func() bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL