Use Get Agent Status REST Service to obtain detailed status
information for the agent service that is installed in a IBM Security Guardium Key Lifecycle Manager master server of the multi-master
cluster.
- Operation
GET
- URL
- https://<host>:<port>/SKLM/rest/v1/ckms/multimaster/agentstatus
By default, Guardium Key Lifecycle Manager server
listens to the secure port 9443 (HTTPS) for communication.
During IBM Security Guardium Key Lifecycle Manager installation, you can modify this
default port.
Request Parameters
Parameter |
Description |
host |
Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server. |
port |
Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests. |
Request Headers
Header name |
Value |
Content-Type |
application/json |
Accept |
application/json |
Authorization |
SKLMAuth userAuthId=<authIdValue> |
Accept-Language |
Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, en or
de. |
Response Headers
Header name |
Value and description |
Status Code |
- 200 OK
- The request was successful. The response body contains the requested representation.
- 400 Bad Request
- The authentication information was not provided in the correct format.
- 401 Unauthorized
- The authentication credentials were missing or incorrect.
- 404 Not Found Error
- The processing of the request fails.
- 500 Internal Server Error
- The processing of the request fails because of an unexpected condition on the server.
|
Content-Type |
application/json |
Content-Language |
Locale for the response message. |
Success response body
JSON object with the following specification.
JSON property name |
Description |
Agent Version |
Returns the version number of agent that is installed in the master
server. |
Agent Status |
Returns the status that indicates whether the installed agent is
running. |
Agent Last Available Time |
Returns the last date and time that the agent was available for monitoring
health status of IBM Security Guardium Key Lifecycle Manager instances in the
cluster. |
Services |
Returns the name of the monitoring services that the agent is running. |
IP/Hostname |
Returns the host name or IP address of the system where the agent is
installed. |
Agent Port |
Returns the port number that is configured for the agent to communicate with
other agents in the cluster. |
Error Response Body
JSON object with the following specification.
JSON property name |
Description |
code |
Returns the application error code. |
message |
Returns a message that describes the error. |
Examples
- Service request to obtain status information for the agent that is installed in a master
server
GET https://localhost:<port>/SKLM/rest/v1/ckms/multimaster/agentstatus
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
- Success response
Status Code : 200 OK
Content-Language: en
{
"Agent Version": "1.0",
"Agent Status": "AGENT_STARTED",
"Agent Last Available Time": "Mon Jul 03 20:06:06 IST 2017",
"Services": "PortMonitoring",
"IP/Hostname": "civ3cez201.in.ibm.com",
"Agent Port": "60015"
}
- Error response
Status Code: 400 Bad Request
Content-Language: en
{"code": "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid user
authentication ID or invalid request format."}