PUT /api/management/servicename
Description
Updates the in-memory service name of the API Server or Node Manager. This is the name used to identify the process within the domain topology.
This method is called internally from the Node Manager's Topology API when a user updates an API Server or Node Manager name. This method should not normally be invoked any other way. This method will only update the in-memory service name of the API Server or Node Manager. For the update to be persisted into the topology, it must be done via the Topology API method PUT /api/topology/services/{groupID}.
The Management API resides in the API Servers, therefore this method 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 for an API Server instance, and https://localhost:8090/api/router/service/nodemanager-1/api/management/servicename for a Node Manager. It is possible to invoke the method directly on the Admin Node Manager i.e. https://localhost:8090/api/management/servicename.
Resource URL
https://localhost:8090/api/management/servicename?name={servicename}
https://localhost:8090/api/router/service/{serviceID}/api/management/servicename?name={servicename}
Parameters
name | mandatory | The new service name. |
Response Codes
Response Code | Description |
---|---|
200 | Success. The response body contains the updated service name. |
Example Request and Response
PUT https://localhost:8090/api/router/service/instance-1/api/management/servicename?name=APIServer1
HTTP 1.1 200 OK
{
"result": "APIServer1"
}