gluster/glusterd2
1
0
Fork 0
mirror of https://github.com/gluster/glusterd2.git synced 2026-02-05 12:45:38 +01:00
Code Issues Releases Activity
Files
master
glusterd2/doc/endpoints.md
Sridhar Seshasayee 830c8c9ff0 Tracing: Generate new endpoints.md with new tracing endpoints. 
closes #1368

Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2019-02-12 08:08:00 +05:30

105 lines
19 KiB
Markdown
Generated
Raw Permalink Blame History

<!---
This file is generated using commands described below. DO NOT EDIT.
$ curl -o endpoints.json -s -X GET http://127.0.0.1:24007/endpoints
$ go build pkg/tools/generate-doc.go
$ ./generate-doc
-->
# REST API Endpoints Reference
**Note:** Fields in request structs marked with "omitempty" struct tag are optional.
Name | Methods | Path | Request | Response
--- | --- | --- | --- | ---
GetVersion | GET | /version | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [VersionResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VersionResp)
VolumeCreate | POST | /volumes | [VolCreateReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolCreateReq) | [VolumeCreateResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeCreateResp)
VolumeExpand | POST | /volumes/{volname}/expand | [VolExpandReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolExpandReq) | [VolumeExpandResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeExpandResp)
VolumeOptionGet | GET | /volumes/{volname}/options/{optname:.*} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [VolumeOptionGetResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeOptionGetResp)
VolumeOptionsGet | GET | /volumes/{volname}/options | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [VolumeOptionsGetResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeOptionsGetResp)
VolumeOptions | POST | /volumes/{volname}/options | [VolOptionReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolOptionReq) | [VolumeOptionResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeOptionResp)
VolumeReset | DELETE | /volumes/{volname}/options | [VolOptionResetReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolOptionResetReq) | [VolumeOptionResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeOptionResp)
OptionGroupList | GET | /volumes/options-group | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [OptionGroupListResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#OptionGroupListResp)
OptionGroupCreate | POST | /volumes/options-group | [OptionGroupReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#OptionGroupReq) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
OptionGroupDelete | DELETE | /volumes/options-group/{groupname} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
VolumeDelete | DELETE | /volumes/{volname} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
VolumeInfo | GET | /volumes/{volname} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [VolumeGetResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeGetResp)
VolumeBricksStatus | GET | /volumes/{volname}/bricks | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [BricksStatusResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#BricksStatusResp)
VolumeStatus | GET | /volumes/{volname}/status | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [VolumeStatusResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeStatusResp)
VolumeList | GET | /volumes | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [VolumeListResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeListResp)
VolumeStart | POST | /volumes/{volname}/start | [VolumeStartReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeStartReq) | [VolumeStartResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeStartResp)
VolumeStop | POST | /volumes/{volname}/stop | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [VolumeStopResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeStopResp)
Statedump | POST | /volumes/{volname}/statedump | [VolStatedumpReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolStatedumpReq) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
ReplaceBrick | POST | /volumes/{volname}/replacebrick | [ReplaceBrickReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#ReplaceBrickReq) | [ReplaceBrickResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#ReplaceBrickResp)
EditVolume | POST | /volumes/{volname}/edit | [VolEditReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolEditReq) | [VolumeEditResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#VolumeEditResp)
ProfileVolume | GET | /volumes/{volname}/profile/{option} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [BrickProfileInfo](https://godoc.org/github.com/gluster/glusterd2/pkg/api#BrickProfileInfo)
SnapshotCreate | POST | /snapshots | [SnapCreateReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapCreateReq) | [SnapCreateResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapCreateResp)
SnapshotActivate | POST | /snapshots/{snapname}/activate | [SnapActivateReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapActivateReq) | [SnapshotActivateResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapshotActivateResp)
SnapshotDeactivate | POST | /snapshots/{snapname}/deactivate | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [SnapshotDeactivateResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapshotDeactivateResp)
SnapshotClone | POST | /snapshots/{snapname}/clone | [SnapCloneReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapCloneReq) | [SnapshotCloneResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapshotCloneResp)
SnapshotRestore | POST | /snapshots/{snapname}/restore | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
SnapshotInfo | GET | /snapshots/{snapname} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [SnapGetResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapGetResp)
SnapshotListAll | GET | /snapshots | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [SnapListResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapListResp)
SnapshotStatus | GET | /snapshots/{snapname}/status | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [SnapStatusResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SnapStatusResp)
SnapshotDelete | DELETE | /snapshots/{snapname} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
SnapshotConfigGet | GET | /snapshots/config | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
SnapshotConfigSet | POST | /snapshots/config | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
SnapshotConfigReset | DELETE | /snapshots/config | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
GetPeer | GET | /peers/{peerid} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [PeerGetResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#PeerGetResp)
GetPeers | GET | /peers | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [PeerListResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#PeerListResp)
DeletePeer | DELETE | /peers/{peerid} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
AddPeer | POST | /peers | [PeerAddReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#PeerAddReq) | [PeerAddResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#PeerAddResp)
EditPeer | POST | /peers/{peerid} | [PeerEditReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#PeerEditReq) | [PeerEditResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#PeerEditResp)
SetClusterOptions | POST | /cluster/options | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
GetClusterOptions | GET | /cluster/options | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
GeoReplicationCreate | POST | /geo-replication/{mastervolid}/{remotevolid} | [GeorepCreateReq](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepCreateReq) | [GeorepSession](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSession)
GeoReplicationStart | POST | /geo-replication/{mastervolid}/{remotevolid}/start | [GeorepCommandsReq](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepCommandsReq) | [GeorepSession](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSession)
GeoReplicationStop | POST | /geo-replication/{mastervolid}/{remotevolid}/stop | [GeorepCommandsReq](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepCommandsReq) | [GeorepSession](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSession)
GeoReplicationDelete | DELETE | /geo-replication/{mastervolid}/{remotevolid} | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#)
GeoReplicationPause | POST | /geo-replication/{mastervolid}/{remotevolid}/pause | [GeorepCommandsReq](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepCommandsReq) | [GeorepSession](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSession)
GeoReplicationResume | POST | /geo-replication/{mastervolid}/{remotevolid}/resume | [GeorepCommandsReq](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepCommandsReq) | [GeorepSession](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSession)
GeoReplicationStatus | GET | /geo-replication/{mastervolid}/{remotevolid} | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#) | [GeorepSession](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSession)
GeoReplicationConfigGet | GET | /geo-replication/{mastervolid}/{remotevolid}/config | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#) | [GeorepOption](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepOption)
GeoReplicationConfigSet | POST | /geo-replication/{mastervolid}/{remotevolid}/config | [GeorepOption](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepOption) | [GeorepOption](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepOption)
GeoReplicationConfigReset | DELETE | /geo-replication/{mastervolid}/{remotevolid}/config | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#)
GeoReplicationStatusList | GET | /geo-replication | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#) | [GeorepSessionList](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSessionList)
GeoReplicationSshKeyGenerate | POST | /ssh-key/{volname}/generate | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#) | [GeorepSSHPublicKey](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSSHPublicKey)
GeoReplicationSshKeyPush | POST | /ssh-key/{volname}/push | [GeorepSSHPublicKey](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSSHPublicKey) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#)
GeoReplicationSshKeyGet | GET | /ssh-key/{volname} | [](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#) | [GeorepSSHPublicKey](https://godoc.org/github.com/gluster/glusterd2/plugins/georeplication/api#GeorepSSHPublicKey)
BitrotEnable | POST | /volumes/{volname}/bitrot/enable | [](https://godoc.org/github.com/gluster/glusterd2/plugins/bitrot/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/bitrot/api#)
BitrotDisable | POST | /volumes/{volname}/bitrot/disable | [](https://godoc.org/github.com/gluster/glusterd2/plugins/bitrot/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/bitrot/api#)
BitrotScrubOndemand | POST | /volumes/{volname}/bitrot/scrubondemand | [](https://godoc.org/github.com/gluster/glusterd2/plugins/bitrot/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/bitrot/api#)
BitrotScrubStatus | GET | /volumes/{volname}/bitrot/scrubstatus | [](https://godoc.org/github.com/gluster/glusterd2/plugins/bitrot/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/bitrot/api#)
QuotaList | GET | /quota/{volname}/limit | [](https://godoc.org/github.com/gluster/glusterd2/plugins/quota/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/quota/api#)
QuotaLimit | POST | /quota/{volname}/limit | [](https://godoc.org/github.com/gluster/glusterd2/plugins/quota/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/quota/api#)
QuotaRemove | DELETE | /quota/{volname}/limit | [](https://godoc.org/github.com/gluster/glusterd2/plugins/quota/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/quota/api#)
EventsWebhookAdd | POST | /events/webhook | [Webhook](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#Webhook) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#)
EventsWebhookTest | POST | /events/webhook/test | [Webhook](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#Webhook) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#)
EventsWebhookDelete | DELETE | /events/webhook | [WebhookDel](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#WebhookDel) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#)
EventsWebhookList | GET | /events/webhook | [](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#) | [WebhookList](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#WebhookList)
EventsList | GET | /events | [](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#) | [Event](https://godoc.org/github.com/gluster/glusterd2/plugins/events/api#Event)
SelfHealInfo | GET | /volumes/{volname}/{opts}/heal-info | [](https://godoc.org/github.com/gluster/glusterd2/plugins/glustershd/api#) | [BrickHealInfo](https://godoc.org/github.com/gluster/glusterd2/plugins/glustershd/api#BrickHealInfo)
SelfHealInfo2 | GET | /volumes/{volname}/heal-info | [](https://godoc.org/github.com/gluster/glusterd2/plugins/glustershd/api#) | [BrickHealInfo](https://godoc.org/github.com/gluster/glusterd2/plugins/glustershd/api#BrickHealInfo)
SelfHeal | POST | /volumes/{volname}/heal | [](https://godoc.org/github.com/gluster/glusterd2/plugins/glustershd/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/glustershd/api#)
Split-Brain-Operations | POST | /volumes/{volname}/split-brain/{operation} | [SplitBrainReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SplitBrainReq) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
DeviceAdd | POST | /devices/{peerid} | [AddDeviceReq](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#AddDeviceReq) | [AddDeviceResp](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#AddDeviceResp)
DeviceInfo | GET | /devices/{peerid}/{device:.*} | [](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#) | [ListDeviceResp](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#ListDeviceResp)
DevicesInPeer | GET | /devices/{peerid} | [](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#) | [ListDeviceResp](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#ListDeviceResp)
DeviceEdit | POST | /devices/{peerid}/{device:.*} | [EditDeviceReq](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#EditDeviceReq) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#)
DevicesList | GET | /devices | [](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#) | [ListDeviceResp](https://godoc.org/github.com/gluster/glusterd2/plugins/device/api#ListDeviceResp)
RebalanceStart | POST | /volumes/{volname}/rebalance/start | [StartReq](https://godoc.org/github.com/gluster/glusterd2/plugins/rebalance/api#StartReq) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/rebalance/api#)
RebalanceStop | POST | /volumes/{volname}/rebalance/stop | [](https://godoc.org/github.com/gluster/glusterd2/plugins/rebalance/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/rebalance/api#)
RebalanceStatus | GET | /volumes/{volname}/rebalance | [](https://godoc.org/github.com/gluster/glusterd2/plugins/rebalance/api#) | [](https://godoc.org/github.com/gluster/glusterd2/plugins/rebalance/api#)
BlockCreate | POST | /blockvolumes/{provider} | [BlockVolumeCreateRequest](https://godoc.org/github.com/gluster/glusterd2/pkg/api#BlockVolumeCreateRequest) | [BlockVolumeCreateResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#BlockVolumeCreateResp)
BlockDelete | DELETE | /blockvolumes/{provider}/{name} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
BlockList | GET | /blockvolumes/{provider} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
BlockGet | GET | /blockvolumes/{provider}/{name} | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
TraceEnable | POST | /tracemgmt | [SetupTracingReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SetupTracingReq) | [JaegerConfigInfo](https://godoc.org/github.com/gluster/glusterd2/pkg/api#JaegerConfigInfo)
TraceStatus | GET | /tracemgmt | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [JaegerConfigInfo](https://godoc.org/github.com/gluster/glusterd2/pkg/api#JaegerConfigInfo)
TraceUpdate | POST | /tracemgmt/update | [SetupTracingReq](https://godoc.org/github.com/gluster/glusterd2/pkg/api#SetupTracingReq) | [JaegerConfigInfo](https://godoc.org/github.com/gluster/glusterd2/pkg/api#JaegerConfigInfo)
TraceDisable | DELETE | /tracemgmt | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
Statedump | GET | /statedump | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
List Endpoints | GET | /endpoints | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [ListEndpointsResp](https://godoc.org/github.com/gluster/glusterd2/pkg/api#ListEndpointsResp)
Glusterd2 service status | GET | /ping | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#) | [](https://godoc.org/github.com/gluster/glusterd2/pkg/api#)
View Git Blame Copy Permalink