Page History

...

API

Sample Request Body

Status Code

Response Body

Endpoint: http://locator:7070/management/experimental/regions

Method: POST

Headers: Authorization

Permission Required: DATA:MANAGE

Body:

Types supported by this Rest API is defined in RegionType:

Code Block

language	java
title	Request Body

public enum RegionType {
  PARTITION,
  PARTITION_REDUNDANT,
  PARTITION_PERSISTENT,
  PARTITION_REDUNDANT_PERSISTENT,
  PARTITION_OVERFLOW,
  PARTITION_REDUNDANT_OVERFLOW,
  PARTITION_PERSISTENT_OVERFLOW,
  PARTITION_REDUNDANT_PERSISTENT_OVERFLOW,
  PARTITION_HEAP_LRU,
  PARTITION_REDUNDANT_HEAP_LRU,

  PARTITION_PROXY,
  PARTITION_PROXY_REDUNDANT,

  REPLICATE,
  REPLICATE_PERSISTENT,
  REPLICATE_OVERFLOW,
  REPLICATE_PERSISTENT_OVERFLOW,
  REPLICATE_HEAP_LRU,

  REPLICATE_PROXY
}

Code Block

language	yml
title	Sample Request

{
	"name": "regionA",
	"type": "REPLICATE"
}

200

Code Block

language	yml
title	Success Response

{
	"memberStatuses": [{
		"memberName": "server-2",
		"success": true,
		"message": "Region successfully created."
	}, {
		"memberName": "server-3",
		"success": true,
		"message": "Region successfully created."
	}],
	"statusCode": "OK",
	"statusMessage": "Successfully updated config for group2",
	"uri": "/management/experimental/regions/disJoint",
	"result": []
}

409

Code Block

language	yml
title	Name conflict

{
  "memberStatuses" : { },
  "statusCode" : "ENTITY_EXISTS",
  "statusMessage" : "cache element Foo already exists.",
  "successful" : false
}

400

Code Block

language	yml
title	Error Response - missing required parameter

{
  "memberStatuses" : { },
  "statusCode" : "ILLEGAL_ARGUMENT",
  "statusMessage" : "Name of the region has to be specified.",
  "successful" : false
}

Code Block

language	yml
title	Error Response - invalid parameter

{
  "memberStatuses" : { },
  "statusCode" : "ILLEGAL_ARGUMENT",
  "statusMessage" : "Region names may not begin with a double-underscore: __Foo__",
  "successful" : false
}

401

Code Block

language	yml
title	Error Response - unauthenticated

{
  "memberStatuses" : { },
  "statusCode" : "UNAUTHENTICATED",
  "statusMessage" : "Authentication error. Please check your credentials",
  "successful" : false
}

403

Code Block

language	yml
title	Error Response - not authorized

{
  "memberStatuses" : { },
  "statusCode" : "UNAUTHORIZED",
  "statusMessage" : "user not authorized for DATA:MANAGE",
  "successful" : false
}

500

Code Block

language	yml
title	Error Response

{
  "memberStatuses" : { },
  "statusCode" : "ERROR",
  "statusMessage" : "cluster persistence service is not running",
  "successful" : false
}

...

Rebalance Operation

List Rebalance History

API

Status Code

Response Body

Endpoint: http://locator:7070/management/experimental/o perations/rebalance

Method: GET

Headers: Authorization

Permission Required: DATA:MANAGE

200

Code Block

language	yml
title	Success 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"
    },
    {
      "statusCode": "IN_PROGRESS",
      "statusMessage": "in progress",
      "uri": "/management/experimental/operations/rebalance/a7d6204c",
      "operationStart": "2019-07-26T04:57:22.534Z",
    }
  ]
}

Start Rebalance

API

Status Code

Request Body

Response Body

Endpoint: http://locator:7070/management/experimental/o perations/rebalance

Method: POST

Headers: Authorization

Permission Required: DATA:MANAGE

202

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

API

Status Code

Response Body

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

Method: GET

Headers: Authorization

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": [
      {
        "regionName": "testRegion2",
        "bucketCreateBytes": 0,
        "bucketCreateTimeInMilliseconds": 0,
        "bucketCreatesCompleted": 0,
        "bucketTransferBytes": 0,
        "bucketTransferTimeInMilliseconds": 0,
        "bucketTransfersCompleted": 0,
        "primaryTransferTimeInMilliseconds": 0,
        "primaryTransfersCompleted": 0,
        "timeInMilliseconds": 17
      },
      {
        "regionName": "testRegion1",
        "bucketCreateBytes": 0,
        "bucketCreateTimeInMilliseconds": 0,
        "bucketCreatesCompleted": 0,
        "bucketTransferBytes": 0,
        "bucketTransferTimeInMilliseconds": 0,
        "bucketTransfersCompleted": 0,
        "primaryTransferTimeInMilliseconds": 0,
        "primaryTransfersCompleted": 0,
        "timeInMilliseconds": 5
      }
    ]
  }
}

404

Code Block

language	yml
title	Success Response

{
  "statusCode": "ENTITY_NOT_FOUND",
  "statusMessage": "Operation id = 12345678 not found"
}

500

Code Block

language	yml
title	Success Response

{
  "statusCode": "ERROR",
  "statusMessage": "rebalance returned info: Distributed system has no regions that can be rebalanced"
}

Space shortcuts

Page tree

Versions Compared

Old Version 19

New Version 20

Key

Rebalance Operation

List Rebalance History

Start Rebalance

Get Rebalance