/scalemgmt/v3/apihealth/{node_name}: GET

Lists the health status of the IBM Storage Scale native REST API services on the specified node.

Availability

Available on all IBM Storage Scale editions.

Description

The GET apihealth request lists the health status of the IBM Storage Scale native REST API service on the specified node.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/apihealth/{node_name}

where

{node_name}: Specifies the node name.

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of parameters
Parameter name	Description and applicable keywords	Required/optional
node_name	The name of the node.	Required.
X-StorageScaleDomain	The domain to be authorized against for the request. The default value is `StorageScaleDomain`.	Optional.

Request data

No request data.

Response data

200: A successful response.

{
  "service": [
    {
      "ip_addr": "string",
      "message": "string",
      "node_name": "string",
      "node_number": "string",
      "service": "string",
      "service_status": "RUNNING",
      "statistics": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example lists the health information of the IBM Storage Scale native REST API services for the test-23 node:

Request data:

curl -n -k -X GET https://localhost:46443/scalemgmt/v3/apihealth/test-23

Response data:

{
"service":  [
{
"node_number":  "3",
"node_name":  "test-23.openstacklocal",
"ip_addr":  "10.0.100.113",
"service":  "HTTP gRPC Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "3",
"node_name":  "test-23.openstacklocal",
"ip_addr":  "10.0.100.113",
"service":  "REST Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "3",
"node_name":  "test-23.openstacklocal",
"ip_addr":  "10.0.100.113",
"service":  "UDS gRPC Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "3",
"node_name":  "test-23.openstacklocal",
"ip_addr":  "10.0.100.113",
"service":  "i/o gRPC Server",
"service_status":  "RUNNING",
"message":  "healthy"
}
]
}