Versions Compared

Old Version 22

changes.mady.by.user Owen Nichols

Saved on

compared with

New Version 23

changes.mady.by.user Owen Nichols

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

APIStatus CodeRequest BodyResponse Body

Endpoint: http://locator:7070/management/experimental/operations/rebalance

Method: POST

Headers: Authorization

Permission Required: DATA:MANAGE

202


Code Block
languageyml
titleSample Request
{
"excludeRegions": [],
"includeRegions": [],
"simulate": false
}




Code Block
languageyml
titleSuccess 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"
}

...


List Rebalance

...

History

APIStatus CodeResponse Body

Endpoint: http://locator:7070/management/experimental/operations/rebalance

/{id}

Method: GET

Headers: Authorization

Permission Required: DATA:MANAGE

200


Code Block
languageyml
titleSuccess Response
{
  "statusCode": "OK",
  "result": [
    {
      "statusCode": "OK",
      "statusMessage": "finished successfully",
      "uri": "/management/experimental/operations/rebalance/8a70d6c4",
      "operationStart": "2019-07-25T10:17:42.004Z",
      "operationEnded": "2019-07-25T10:17:42.060Z"
,
"result":
{ "rebalanceRegionResults": [
 },
    
{
      
"
regionName
statusCode": "
testRegion2
IN_PROGRESS",

      
"
bucketCreateBytes
statusMessage":
0
"in progress",
      
"
bucketCreateTimeInMilliseconds
uri":
0
"/management/experimental/operations/rebalance/a7d6204c",
      
"
bucketCreatesCompleted
operationStart":
0, "bucketTransferBytes": 0
"2019-07-26T04:57:22.534Z",
    }
  ]
}


Get Rebalance Status

APIStatus CodeResponse Body

Endpoint: http://locator:7070/management/experimental/operations/rebalance/{id}

Method: GET

Headers: Authorization

Permission Required: DATA:MANAGE

200


Code Block
languageyml
titleSuccess Response
{
  "statusCode": "OK",
  "statusMessage": "finished successfully",
  "operationStart": "2019-07-25T10:17:42.004Z",
  "operationEnded": "2019-07-25T10:17:42.060Z",
  "result": {
    "rebalanceRegionResults": [    "bucketTransferTimeInMilliseconds": 0,
        "bucketTransfersCompleted": 0,
        "primaryTransferTimeInMilliseconds": 0,
        "primaryTransfersCompleted": 0,
        "timeInMilliseconds": 17
      },
      {
        "regionName": "testRegion1testRegion2",
        "bucketCreateBytes": 0,
        "bucketCreateTimeInMilliseconds": 0,
        "bucketCreatesCompleted": 0,
        "bucketTransferBytes": 0,
        "bucketTransferTimeInMilliseconds": 0,
        "bucketTransfersCompleted": 0,
        "primaryTransferTimeInMilliseconds": 0,
        "primaryTransfersCompleted": 0,
        "timeInMilliseconds": 517
      },
      ]{
  }
}
404
Code Block
languageyml
titleSuccess Response
{
      "statusCoderegionName": "ENTITY_NOT_FOUNDtestRegion1",
  "statusMessage      "bucketCreateBytes": "Operation id = 12345678 not found"
}
500
Code Block
languageyml
titleSuccess Response
{
  "statusCode": "ERROR"0,
        "bucketCreateTimeInMilliseconds": 0,
  "statusMessage": "rebalance returned info    "bucketCreatesCompleted": Distributed0,
 system has no regions that can be rebalanced"
}

List Rebalance History

APIStatus CodeResponse Body

Endpoint: http://locator:7070/management/experimental/operations/rebalance

Method: GET

Headers: Authorization

Permission Required: DATA:MANAGE

200 Code Block
languageyml
titleSuccess Response
{ "statusCode": "OK", "result": [ {
"bucketTransferBytes": 0,
        "bucketTransferTimeInMilliseconds": 0,
        "bucketTransfersCompleted": 0,
        "primaryTransferTimeInMilliseconds": 0,
        "
statusCode
primaryTransfersCompleted":
"OK"
0,
        "
statusMessage
timeInMilliseconds":
"finished successfully", "uri": "/management/experimental/operations/rebalance/8a70d6c4", "operationStart": "2019-07-25T10:17:42.004Z", "operationEnded": "2019-07-25T10:17:42.060Z" }, { 
5
      }
    ]
  }
}



404


Code Block
languageyml
titleSuccess Response
{
  "statusCode": "ENTITY_NOT_FOUND",
  "statusMessage": "Operation id = 12345678 not found"
}



500


Code Block
languageyml
titleSuccess Response
{
  "statusCode": "
IN_PROGRESS
ERROR",
  
"statusMessage": "
in progress", "uri": "/management/experimental/operations/rebalance/a7d6204c", "operationStart": "2019-07-26T04:57:22.534Z", } ] } 
rebalance returned info: Distributed system has no regions that can be rebalanced"
}