| ... | @@ -3,56 +3,70 @@ |
... | @@ -3,56 +3,70 @@ |
|
|
Bob has an REST Api specified in
|
|
Bob has an REST Api specified in
|
|
|
[config-examples/openapi.yaml](https://github.com/qoollo/bob/blob/master/config-examples/openapi.yaml).
|
|
[config-examples/openapi.yaml](https://github.com/qoollo/bob/blob/master/config-examples/openapi.yaml).
|
|
|
|
|
|
|
|
## Methods
|
|
|
|
|
|
|
|
|
|
* [GET /status](#status)
|
|
<a name="toc"></a>
|
|
|
* [GET /nodes](#nodes)
|
|
|
|
|
* [GET /metadata/distrfunc](#distrfunc)
|
|
- [REST API](#rest-api)
|
|
|
* [GET /vdisks](#vdisks)
|
|
- [Methods](#methods)
|
|
|
* [GET /vdisks/{VDiskId}](#vdisks_by_id)
|
|
- [GET /status](#get-status)
|
|
|
* [GET /vdisks/{VDiskId}/records/count](#vdisks_records_count)
|
|
- [GET /nodes](#get-nodes)
|
|
|
* [GET /vdisks/{VDiskId}/partitions](#toc)
|
|
- [GET /metadata/distrfunc](#get-metadatadistrfunc)
|
|
|
* [GET /vdisks/{VDiskId}/partitions/{partitionId}](#toc)
|
|
- [GET /vdisks](#get-vdisks)
|
|
|
* [DELETE /vdisks/{VDiskId}/partitions/by_timestamp/{timestamp}](#toc)
|
|
- [GET /vdisks/{VDiskId}](#get-vdisksvdiskid)
|
|
|
* [PUT /vdisks/{VDiskId}/partitions/by_timestamp/{timestamp}/{action}](#toc)
|
|
- [GET /vdisks/{VDiskId}/records/count](#get-vdisksvdiskidrecordscount)
|
|
|
* [GET /disks/list](#toc)
|
|
- [GET /vdisks/{VDiskId}/partitions](#get-vdisksvdiskidpartitions)
|
|
|
* [POST /disks/{disk_name}/start](#toc)
|
|
- [GET /vdisks/{VDiskId}/partitions/{partitionId}](#get-vdisksvdiskidpartitionspartitionid)
|
|
|
* [POST /vdisks/{vdisk_id}/remount](#toc)
|
|
- [DELETE /vdisks/{VDiskId}/partitions/by_timestamp/{timestamp}](#delete-vdisksvdiskidpartitionsby_timestamptimestamp)
|
|
|
* [DELETE /blobs/outdated](#toc)
|
|
- [PUT /vdisks/{VDiskId}/partitions/by_timestamp/{timestamp}/{action}](#put-vdisksvdiskidpartitionsby_timestamptimestampaction)
|
|
|
* [GET /alien](#toc)
|
|
- [GET /disks/list](#get-diskslist)
|
|
|
* [GET /alien/dir](#toc)
|
|
- [POST /disks/{disk_name}/stop](#post-disksdisk_namestop)
|
|
|
* [GET /vdisks/{vdisk_id}/replicas/local/dirs](#toc)
|
|
- [POST /disks/{disk_name}/start](#post-disksdisk_namestart)
|
|
|
|
- [POST /vdisks/{vdisk_id}/remount](#post-vdisksvdisk_idremount)
|
|
|
|
- [DELETE /blobs/outdated](#delete-blobsoutdated)
|
|
|
|
- [GET /alien](#get-alien)
|
|
|
|
- [GET /alien/dir](#get-aliendir)
|
|
|
|
- [GET /vdisks/{vdisk_id}/replicas/local/dirs](#get-vdisksvdisk_idreplicaslocaldirs)
|
|
|
|
|
|
|
|
## Methods
|
|
|
|
|
|
|
|
|
<a name="status"></a>
|
|
|
### GET /status
|
|
### GET /status
|
|
|
Returns information about this node.
|
|
Returns information about this node.
|
|
|
|
|
|
|
|
|
<a name="nodes"></a>
|
|
|
### GET /nodes
|
|
### GET /nodes
|
|
|
Returns a list of known nodes and vdisks on them.
|
|
Returns a list of known nodes and vdisks on them.
|
|
|
|
|
|
|
|
|
<a name="distrfunc"></a>
|
|
|
### GET /metadata/distrfunc
|
|
### GET /metadata/distrfunc
|
|
|
Return information about key distribution function
|
|
Return information about key distribution function
|
|
|
|
|
|
|
|
|
<a name="vdisks"></a>
|
|
|
### GET /vdisks
|
|
### GET /vdisks
|
|
|
Returns a list of vdisks
|
|
Returns a list of vdisks
|
|
|
|
|
|
|
|
|
<a name="vdisks_id"></a>
|
|
|
### GET /vdisks/{VDiskId}
|
|
### GET /vdisks/{VDiskId}
|
|
|
Returns a vdisk info by ID
|
|
Returns a vdisk info by ID
|
|
|
|
|
|
|
|
Arguments:
|
|
Arguments:
|
|
|
* VDiskId - unsigned 32bit integer
|
|
* VDiskId - unsigned 32bit integer
|
|
|
|
|
|
|
|
|
<a name="vdisks_id_records_count"></a>
|
|
|
### GET /vdisks/{VDiskId}/records/count
|
|
### GET /vdisks/{VDiskId}/records/count
|
|
|
Returns count of records of this on node
|
|
Returns count of records of this on node
|
|
|
|
|
|
|
|
Arguments:
|
|
Arguments:
|
|
|
* VDiskId - unsigned 32bit integer
|
|
* VDiskId - unsigned 32bit integer
|
|
|
|
|
|
|
|
|
<a name="vdisks_id_partitions"></a>
|
|
|
### GET /vdisks/{VDiskId}/partitions
|
|
### GET /vdisks/{VDiskId}/partitions
|
|
|
Returns a list of partitions
|
|
Returns a list of partitions
|
|
|
|
|
|
|
|
Arguments:
|
|
Arguments:
|
|
|
* VDiskId - unsigned 32bit integer
|
|
* VDiskId - unsigned 32bit integer
|
|
|
|
|
|
|
|
|
<a name="vdisks_id_partitions_id"></a>
|
|
|
### GET /vdisks/{VDiskId}/partitions/{partitionId}
|
|
### GET /vdisks/{VDiskId}/partitions/{partitionId}
|
|
|
Returns a partition info by ID
|
|
Returns a partition info by ID
|
|
|
|
|
|
| ... | @@ -60,6 +74,7 @@ Arguments: |
... | @@ -60,6 +74,7 @@ Arguments: |
|
|
* VDiskId - unsigned 32bit integer
|
|
* VDiskId - unsigned 32bit integer
|
|
|
* partitionId - string
|
|
* partitionId - string
|
|
|
|
|
|
|
|
|
<a name="vdisks_id_partitions_by_timestamp"></a>
|
|
|
### DELETE /vdisks/{VDiskId}/partitions/by_timestamp/{timestamp}
|
|
### DELETE /vdisks/{VDiskId}/partitions/by_timestamp/{timestamp}
|
|
|
Delete partitions by timestamp
|
|
Delete partitions by timestamp
|
|
|
|
|
|
| ... | @@ -67,6 +82,7 @@ Arguments: |
... | @@ -67,6 +82,7 @@ Arguments: |
|
|
* VDiskId - unsigned 32bit integer
|
|
* VDiskId - unsigned 32bit integer
|
|
|
* timestamp - unsigned 64bit integer
|
|
* timestamp - unsigned 64bit integer
|
|
|
|
|
|
|
|
|
<a name="vdisks_id_partitions_by_timestamp_action"></a>
|
|
|
### PUT /vdisks/{VDiskId}/partitions/by_timestamp/{timestamp}/{action}
|
|
### PUT /vdisks/{VDiskId}/partitions/by_timestamp/{timestamp}/{action}
|
|
|
Attach/Detach a partition by timestamp
|
|
Attach/Detach a partition by timestamp
|
|
|
|
|
|
| ... | @@ -75,36 +91,44 @@ Arguments: |
... | @@ -75,36 +91,44 @@ Arguments: |
|
|
* timestamp - unsigned 64bit integer
|
|
* timestamp - unsigned 64bit integer
|
|
|
* action - 'attach' or 'detach' string
|
|
* action - 'attach' or 'detach' string
|
|
|
|
|
|
|
|
|
<a name="disks_list"></a>
|
|
|
### GET /disks/list
|
|
### GET /disks/list
|
|
|
Returns the list of disks with their states
|
|
Returns the list of disks with their states
|
|
|
|
|
|
|
|
|
<a name="disks_name_stop"></a>
|
|
|
### POST /disks/{disk_name}/stop
|
|
### POST /disks/{disk_name}/stop
|
|
|
Stops all disks controller for disk
|
|
Stops all disks controller for disk
|
|
|
|
|
|
|
|
Arguments:
|
|
Arguments:
|
|
|
* disk_name - string
|
|
* disk_name - string
|
|
|
|
|
|
|
|
|
<a name="disks_name_start"></a>
|
|
|
### POST /disks/{disk_name}/start
|
|
### POST /disks/{disk_name}/start
|
|
|
Trying to start all disk controllers for disk
|
|
Trying to start all disk controllers for disk
|
|
|
|
|
|
|
|
Arguments:
|
|
Arguments:
|
|
|
* disk_name - string
|
|
* disk_name - string
|
|
|
|
|
|
|
|
|
<a name="vdisks_id_remount"></a>
|
|
|
### POST /vdisks/{vdisk_id}/remount
|
|
### POST /vdisks/{vdisk_id}/remount
|
|
|
Remount partitions on vdisk
|
|
Remount partitions on vdisk
|
|
|
|
|
|
|
|
Arguments:
|
|
Arguments:
|
|
|
* vdisk_id - unsigned 32bit integer
|
|
* vdisk_id - unsigned 32bit integer
|
|
|
|
|
|
|
|
|
<a name="blobs_outdated"></a>
|
|
|
### DELETE /blobs/outdated
|
|
### DELETE /blobs/outdated
|
|
|
Close active blobs of holders not used recently
|
|
Close active blobs of holders not used recently
|
|
|
|
|
|
|
|
|
<a name="alien"></a>
|
|
|
### GET /alien
|
|
### GET /alien
|
|
|
Returns an alien dir info
|
|
Returns an alien dir info
|
|
|
|
|
|
|
|
|
<a name="alien_dir"></a>
|
|
|
### GET /alien/dir
|
|
### GET /alien/dir
|
|
|
Return directory of alien
|
|
Return directory of alien
|
|
|
|
|
|
|
|
|
<a name="vdisks_id_replicas_local_dirs"></a>
|
|
|
### GET /vdisks/{vdisk_id}/replicas/local/dirs
|
|
### GET /vdisks/{vdisk_id}/replicas/local/dirs
|
|
|
Returns directories of local replicas of vdisk
|
|
Returns directories of local replicas of vdisk
|
|
|
|
|
|
| ... | | ... | |