Management API
The Management API resides in the Node Manager and all API Server instances. It may be used to get the following server-related information:-
- the service name e.g. "APIServer1", "Node Manager on host.com"
- the group name e.g. "Group1", "Node Manager Group"
- the service type, e.g. "VordelGateway", "VordelNodeManager"
- the product version e.g. "7.2"
- the domain id which is assigned when the Admin Node Manager is created.
- Start and Stop API Gateway Instances
This API is also used internally by the Topology API be used to update the following in-memory server-related information:-
- the service name
- the group name
The Topology API in the Node Manager, uses the Management API in an API Server instance when the user updates an API Server's name or group name.
The Management API resides in the API Servers, therefore it must be invoked via the Routing API in the Admin Node Manager, e.g. https://localhost:8090/api/router/service/instance-1/api/management/servicename.
Resources
| Resource | Description |
|---|---|
| GET /api/management/servicename | Get the service name. |
| GET /api/management/groupname | Get the group name. |
| GET /api/management/servicetype | Get the service type. |
| GET /api/management/serviceversion | Get the service version. |
| GET /api/management/domainid | Get the domain id. |
| PUT /api/management/servicename | Update the in-memory service name. |
| PUT /api/management/groupname | Update the in-memory group name. |
| POST /api/management/start/groupId/serviceId | Start a API Gateway Instance |
| POST /api/management/stop/groupId/serviceId | Stop a API Gateway Instance |
| POST /api/management/status/groupId/serviceId | Get the Status of a API Gateway Instance |