Table of Contents
Region Management
Create
...
Region
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:
|
| 200 |
| |||||||||||||||||||||
409 |
| |||||||||||||||||||||||
400 |
| |||||||||||||||||||||||
401 |
| |||||||||||||||||||||||
403 |
| |||||||||||||||||||||||
500 |
|
...
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
200 |
| ||||||||
401 |
| ||||||||
403 |
|
...
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
200 |
| ||||||||
401 |
| ||||||||
403 |
| ||||||||
404 |
|
Delete
...
Region
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
Endpoint: http://locator:7070/management/experimental/regions/Foo Method: DELETE Headers: Authorization | 204 |
| |||||||
304 |
| ||||||||
401 |
| ||||||||
403 |
| ||||||||
500 |
|
Note that the DELETE endpoint is idempotent – i.e. it should be a NOOP if the region does not exist.
Member Management
List
...
Members
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
Permission Required: CLUSTER:READ | 200 |
| |||||||
Endpoint: http://locator:7070/management/experimental/members?id=server-1 Method: GET Headers: Authorization Permission Required: CLUSTER:READ | 200 |
| |||||||
Endpoint: http://locator:7070/management/experimental/members?id=Non-Existent Method: GET Headers: Authorization Permission Required: CLUSTER:READ | 200 |
|
Get
...
Member
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
Endpoint: http://locator:7070/management/experimental/members/server-1 Method: GET Headers: Authorization Permission Required: CLUSTER:READ | 200 |
| |||||||
Endpoint: http://locator:7070/management/experimental/members/Non-Existent Method: GET Headers: Authorization Permission Required: CLUSTER:READ | 404 |
|
Index Management
List
...
Indexes
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
Endpoint: http://locator:7070/management/experimental/regions/{regionName}/indexes Method: GET Headers: Authorization Permission Required: CLUSTER:READ | 200 |
|
Get
...
Index
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
Endpoint: http://locator:7070/management/experimental/regions/{regionName}/indexes/{indexName} Method: GET Headers: Authorization Permission Required: CLUSTER:READ | 200 |
|
...
API | Request Body | Status Code | Response Body | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Endpoint:http://locator:7070/management/experimental/configurations/pdx/ Method: POST Headers: Authorization Permission Required: CLUSTER:MANAGE |
| 200 |
|
Gateway Management
List
...
Gateway Receivers
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
Endpoint: http://locator:7070/management/experimental/gateways/receivers/ Method: GET Headers: Authorization Permission Required: CLUSTER:READ | 200 |
|
Create
...
Gateway Receiver
API | Status Code | Request Body | Response Body | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Endpoint: http://locator:7070/management/experimental/gateways/receivers/ Method: POST Headers: Authorization Permission Required: CLUSTER:MANAGE | 201 |
|
|
Rebalance Operation
List Rebalance History
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
Endpoint: http://locator:7070/management/experimental/operations/rebalance Method: GET Headers: Authorization Permission Required: DATA:MANAGE | 200 |
|
Start Rebalance
API | Status Code | Request Body | Response Body | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Endpoint: http://locator:7070/management/experimental/operations/rebalance Method: POST Headers: Authorization Permission Required: DATA:MANAGE | 202 |
|
|
Get Rebalance
API | Status Code | Response Body | |||||||
---|---|---|---|---|---|---|---|---|---|
Endpoint: http://locator:7070/management/experimental/operations/rebalance/{id} Method: GET Headers: Authorization Permission Required: DATA:MANAGE | 200 |
| |||||||
404 |
| ||||||||
500 |
|