Jump to: navigation, search

Node API

This is a base ping API implementation, which load balancers will use to check the health of a given GMS node to determine if it can use this particular GMS node when it load balances API requests across the set of GMS nodes.

Query Status

This API queries the status of a given GMS node. The application (load balancer) querying the nodes must have their explicit host addresses and port.

Operation

Important
You need an Authentication header for this query.
GET /genesys/1/admin/node/status
Parameter Type Mandatory Description
URI Parameters
None



Response

HTTP code 200
HTTP message OK
Body The response is a string representing the status of GMS ONLINE/OFFLINE (OFFLINE means that GMS will stop in the next few seconds.

Example

$ curl -v -u default:password 
http://localhost:8080/genesys/1/admin/node/status
< HTTP/1.1 200 OK
< Expires: Thu, 11 Aug 2016 10:59:27 GMT
< Set-Cookie: JSESSIONID=1nglubvlfu69bzw6lvksz6jo2;
Path=/genesys;HttpOnly
< Cache-Control: max-age=300
< Content-Type: text/plain;charset=ISO-8859-1
< Content-Length: 6
<
ONLINE


Change Node Status

This API allows you to change the status of a GMS Node to offline or online. If a load balancer queries the node, it will get the new GMS status and will load balance the request accordingly.

If you set the GMS Node status to OFFLINE, the node's status will be Suspended in Solution Control Server.

Query

Important
You need an Authentication header for this query.
POST /genesys/1/admin/node/changestatus/{status}
Parameter Type Mandatory Description
URI Parameters
Status
String yes ONLINE/OFFLINE

Response

HTTP code 200
HTTP message OK

Example

POST /genesys/1/admin/node/changestatus/OFFLINE HTTP/1.1
Host: 127.0.0.1:8080
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded
 
200 OK

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on April 11, 2018, at 09:30.