| ... | @@ -23,47 +23,41 @@ Bob has an REST Api specified in |
... | @@ -23,47 +23,41 @@ Bob has an REST Api specified in |
|
|
- [GET /alien](#get-alien)
|
|
- [GET /alien](#get-alien)
|
|
|
- [GET /alien/dir](#get-aliendir)
|
|
- [GET /alien/dir](#get-aliendir)
|
|
|
- [GET /vdisks/{vdisk_id}/replicas/local/dirs](#get-vdisksvdisk_idreplicaslocaldirs)
|
|
- [GET /vdisks/{vdisk_id}/replicas/local/dirs](#get-vdisksvdisk_idreplicaslocaldirs)
|
|
|
|
- [GET /data/{key}](#get-datakey)
|
|
|
|
- [POST /data/{key}](#post-datakey)
|
|
|
|
|
|
|
|
## Methods
|
|
## 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
|
|
|
|
|
|
| ... | @@ -71,7 +65,6 @@ Arguments: |
... | @@ -71,7 +65,6 @@ 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
|
|
|
|
|
|
| ... | @@ -79,7 +72,6 @@ Arguments: |
... | @@ -79,7 +72,6 @@ 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
|
|
|
|
|
|
| ... | @@ -88,46 +80,57 @@ Arguments: |
... | @@ -88,46 +80,57 @@ 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
|
|
|
|
|
|
|
|
Arguments:
|
|
Arguments:
|
|
|
* vdisk_id - unsigned 32bit integer |
|
* vdisk_id - unsigned 32bit integer
|
|
\ No newline at end of file |
|
|
|
|
|
### GET /data/{key}
|
|
|
|
Returns data by key
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
* key - can be GUID, hexadecimal or decimal number
|
|
|
|
|
|
|
|
Examples of keys:
|
|
|
|
* GUID - `{5cc66ef2-e35f-44ea-80df-edf9ce481075}` or `5cc66ef2-e35f-44ea-80df-edf9ce481075`
|
|
|
|
* Hexadecimal - `0xFF12`, `0xf`
|
|
|
|
* Decimal - `12`
|
|
|
|
|
|
|
|
### POST /data/{key}
|
|
|
|
Add data to bob by key
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
* key - can be GUID, hexadecimal or decimal number. Same format as for GET method
|
|
|
|
|
|
|
|
Body is binary data to be stored in bob |
|
|
|
\ No newline at end of file |