Versions Compared

Old Version 51

changes.mady.by.user Owen Nichols

Saved on

compared with

New Version 52

changes.mady.by.user Owen Nichols

Saved on

Key

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

...

APIStatus CodeResponse Body

Endpoint:http://locator:7070/management/experimental/configurations/pdx

Method: POST

Headers: Authorization

Permission Required: CLUSTER:MANAGE

Code Block
languageyml
titleSample Request
{"readSerialized":true}


201


Code Block
languageyml
titleSuccess Response
{
  "statusCode": "OK",
  "statusMessage": "Successfully updated configuration for cluster.",
  "uri": "/management/experimental/configurations/pdx",
  "memberStatuses": [
    {
      "memberName": "server-1",
      "success": true,
      "message": "Server 'server-1' needs to be restarted for this configuration change to be realized."
    }
  ]
}


Gateway Management

...

Create Gateway

...

Receiver

APIStatus CodeResponse Body

Endpoint: http://locator:7070/management/experimental/gateways/receivers

Method:

 GET

 POST

Headers: Authorization

Permission Required: CLUSTER:

READ

MANAGE

200
Code Block
languageyml
title
Success Response
Sample Request
{

 "
statusCode
startPort":
"
OK
5000",

 "
result
group":
[{ "config": { "groups": ["group2"], "startPort": "5002", "endPort": "5500", "uri": "/management/experimental/gateways/receivers/group2" } }, { "config": { "groups": ["group1"], "startPort": "5000", "endPort": "5500", "
"group1"
}


201


Code Block
languageyml
titleSuccess Response
{
  "statusCode": "OK",
  "statusMessage": "Successfully updated configuration for group1.",
  "uri": "/management/experimental/gateways/receivers/group1"

}
, "runtimeInfo": [{
"memberName": "server-1", "running": true, "port": 5134 }] }] }

...


List Gateway Receivers
APIStatus CodeResponse Body
Endpoint: http://locator:7070/management/experimental/gateways/receivers
/{receiverGroup}
Method: GET
Headers: Authorization
Permission Required: CLUSTER:READ
200

 Code Block
languageyml
titleSuccess Response
{
	"statusCode": "OK",
	"result": [{
		"config": {
			"groups": ["group2"],
			"startPort": "5002",
			"endPort": 
"OK",
	"result":
"5500",
			"uri": "/management/experimental/gateways/receivers/group2"
		}
	}, {
		"config": {
			"groups": ["group1"],
			"startPort": "5000",
			"endPort": "5500",
			"uri": "/management/experimental/gateways/receivers/group1"
		},
		"runtimeInfo": [{
			"memberName": "server-1",
			"running": true,
			"port": 5134
		}]
	}]
}

...

Get Gateway Receiver
APIStatus CodeResponse Body
Endpoint: http://locator:7070/management/experimental/gateways/receivers/{receiverGroup}
Method:
 POST
 GET
Headers: Authorization
Permission Required: CLUSTER:
MANAGE
READ
200

 Code Block
languageyml
title
Sample Request
Success Response
{

 
	"
startPort
statusCode": "
5000
OK",
	"result": {
		"config": {
			"
group
groups": ["group1"

}
201 Code Block
languageyml
titleSuccess Response
{
  "statusCode
],
			"startPort": "
OK
5000",

  "statusMessage
			"endPort": "
Successfully updated configuration for group1.
5500",

  
			"uri": "/management/experimental/gateways/receivers/group1"
		},
		"runtimeInfo": [{
			"memberName": "server-1",
			"running": true,
			"port": 5134
		}]
	}
}


Rebalance Operation
Start Rebalance
...