...
API | Status Code | Request Body | Response Body |
---|
Permission Required: CLUSTER:MANAGE | 201 |
Code Block |
---|
language | yml |
---|
title | Sample Request |
---|
| {
"startPort":"5000",
"group":"group1"
}
|
|
Code Block |
---|
language | yml |
---|
title | Success Response |
---|
| {
"memberStatuses": [{
"memberName": "server-1",
"success": true,
"message": "success"
}],
"statusCode": "OK",
"statusMessage": "Successfully updated config for group1",
"uri": "/management/experimental/gateways/receivers/group1",
"result": []
}
|
|
Rebalance Operation
...
Start Rebalance
...
API | Status Code | Request Body | Response Body |
---|
|
GET POST Headers: Authorization Permission Required: DATA:MANAGE |
200Success Response statusCodeOK result[
|
Code Block |
---|
language | yml |
---|
title | Success Response |
---|
| {
|
|
OK finished successfully",
async operation started (GET uri to check status)",
"uri": "/management/experimental/operations/rebalance/8a70d6c4",
|
|
""operationStart": "2019-07-25T10:17:42.004Z" |
|
,
"operationEnded": "Get Rebalance Status
API | Status Code | Response Body |
---|
Permission Required: DATA:MANAGE | 200 |
Code Block |
---|
language | yml |
---|
title | Success Response |
---|
| {
"statusCode": "OK",
"statusMessage": "finished successfully",
"operationStart": "2019-07-25T10:17:42. |
|
060Z }"operationEnded": "2019-07-25T10:17:42.060Z",
"result": |
|
statusCode "IN_PROGRESS",
statusMessagein progressuri"/management/experimental/operations/rebalance/a7d6204c"0,
"bucketCreateTimeInMilliseconds": 0,
" |
|
operationStart"2019-07-26T04:57:22.534Z",
}
]
}
Start Rebalance
...
Permission Required: DATA:MANAGE
...
Code Block |
---|
language | yml |
---|
title | Sample Request |
---|
|
{
"excludeRegions": [],
"includeRegions": [],
"simulate": false
}
|
Code Block |
---|
language | yml |
---|
title | Success Response |
---|
|
{
"statusCode": "ACCEPTED",
"statusMessage": "async operation started (GET uri to check status)",
"uri": "/management/experimental/operations/rebalance/8a70d6c4",
"operationStart": "2019-07-25T10:17:42.004Z"
}
|
Get Rebalance Status
API | Status Code | Response Body |
---|
Permission Required: DATA:MANAGE | 200 | Code Block |
---|
language | yml |
---|
title | Success Response |
---|
| {
"statusCode": "OK",
"statusMessage": "finished successfully",
"operationStart": "2019-07-25T10:17:42.004Z",
"operationEnded": "2019-07-25T10:17:42.060Z",
"result": {
"rebalanceRegionResults": [0,
"bucketTransferBytes": 0,
"bucketTransferTimeInMilliseconds": 0,
"bucketTransfersCompleted": 0,
"primaryTransferTimeInMilliseconds": 0,
"primaryTransfersCompleted": 0,
"timeInMilliseconds": 17
},
{
"regionName": "testRegion2testRegion1",
"bucketCreateBytes": 0,
"bucketCreateTimeInMilliseconds": 0,
"bucketCreatesCompleted": 0,
"bucketTransferBytes": 0,
"bucketTransferTimeInMilliseconds": 0,
"bucketTransfersCompleted": 0,
"primaryTransferTimeInMilliseconds": 0,
"primaryTransfersCompleted": 0,
"timeInMilliseconds": 175
}
]
}
},
|
|
| 404 |
Code Block |
---|
language | yml |
---|
title | Success Response |
---|
| {
"regionName"statusCode": "testRegion1ENTITY_NOT_FOUND",
"bucketCreateBytes"statusMessage": 0,
"Operation id = 12345678 not found"
}
|
|
| 500 |
Code Block |
---|
language | yml |
---|
title | Success Response |
---|
| {
"bucketCreateTimeInMillisecondsstatusCode": 0"ERROR",
"statusMessage": "rebalance "bucketCreatesCompleted"returned info: 0,
Distributed system has no regions that can be "bucketTransferBytes": 0,
"bucketTransferTimeInMilliseconds": 0,
"bucketTransfersCompleted": 0,
"primaryTransferTimeInMilliseconds": 0,
rebalanced"
}
|
|
List Rebalance History
API | Status Code | Response Body |
---|
Permission Required: DATA:MANAGE | 200 |
Code Block |
---|
language | yml |
---|
title | Success Response |
---|
| {
"statusCode": "OK",
"result": [
{
" |
|
primaryTransfersCompleted0 timeInMilliseconds5
}]
}
}
404 | Code Block |
---|
language | yml |
---|
title | Success Response |
---|
|
{
statusCodeENTITY_NOT_FOUND/management/experimental/operations/rebalance/8a70d6c4",
" |
|
statusMessageOperation id = 12345678 not found"
}
500 | Code Block |
---|
language | yml |
---|
title | Success Response |
---|
|
{
2019-07-25T10:17:42.004Z",
"operationEnded": "2019-07-25T10:17:42.060Z"
},
{
"statusCode": " |
|
ERRORIN_PROGRESS",
"statusMessage": "in progress",
"uri": "/management/experimental/operations/rebalance |
|
returned info: Distributed system has no regions that can be rebalanced"
}/a7d6204c",
"operationStart": "2019-07-26T04:57:22.534Z",
}
]
}
|
|