Status
Current state: "WIP/Under Discussion"
...
* Recover: API related to Recover
All API access is over HTTPS. All data is sent and received as JSON.
The
The common REST API Pattern will be:
/api/v1/<component>/<action>
32. Root endpoint:
| /api/v1 |
|---|
| GET |
| Get all the available endpoints |
...
...
...
...
43. Config:
/api/v1/config/values |
|---|
| GET |
Get value of all configured values overridden on local config |
Response |
...
...
...
...
...
/api/v1/config/:configName/:configValue |
|---|
| POST |
| Update |
...
...
...
...
...
...
...
| Configuration name(key) | | configValue |
|
...
| String | Yes | Configuration value(value) |
Response |
...
...
...
...
54. Bookkeeper:
/api/v1/bookkeeper/format_metadata/:force |
|---|
| POST |
Format bookkeeper metadata |
Parameters |
...
...
...
...
...
...
| whether to force format and delete the old data |
Response |
...
...
...
/api/v1/bookkeeper/list_bookies/:type/:hostnames |
|---|
| GET |
...
| Get all the available bookies. |
Parameters |
...
| Type | Required | Description |
|---|
| type |
|
...
...
, list read-write/read-only |
|
...
...
...
| No | whether print hostname of bookie |
Response |
...
| Description |
|---|
| 200 | successful operation | | 403 | Don't have permission |
|
/api/v1/bookkeeper/update_cookie/:idType |
|---|
| POST |
Update bookie id in cookie. |
Parameters | Name | Type | Required | Description |
|---|
| idType | String | Yes | value: hostname/ip , Id by hostname or IP address |
Response | Code | Description |
|---|
| 204 | successful operation | | 403 |
|
...
| Don't have permission | | 404 | Not update, for errors |
|
/api/v1/bookkeeper/update_cookie/:idType
...
