/scalemgmt/v3/apihealth: GET

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

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 services on nodes.

Request URL

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

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
page_size Specifies the number of items to list per API request. Optional.
page_token Specifies the page token that is received from previous apihealth: GET request. You can provide this page token to retrieve the next page. Optional.
X-StorageScaleDomain Specifies the domain to authorize for the request. The default value is StorageScaleDomain. Optional.

Request data

No request data.

Response data

  • 200: A successful response.
    {
  "apihealth": [
    {
      "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 status of the IBM Storage Scale native REST API services on nodes:

Request data: 
curl -n -k -X GET https://localhost:46443/scalemgmt/v3/apihealth
Response data: 
{
"apihealth":  [
{
"node_number":  "1",
"node_name":  "test-21.openstacklocal",
"ip_addr":  "10.0.100.17",
"service":  "HTTP gRPC Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "1",
"node_name":  "test-21.openstacklocal",
"ip_addr":  "10.0.100.17",
"service":  "REST Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "1",
"node_name":  "test-21.openstacklocal",
"ip_addr":  "10.0.100.17",
"service":  "UDS gRPC Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "1",
"node_name":  "test-21.openstacklocal",
"ip_addr":  "10.0.100.17",
"service":  "i/o gRPC Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "2",
"node_name":  "test-22.openstacklocal",
"ip_addr":  "10.0.100.110",
"service":  "HTTP gRPC Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "2",
"node_name":  "test-22.openstacklocal",
"ip_addr":  "10.0.100.110",
"service":  "REST Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "2",
"node_name":  "test-22.openstacklocal",
"ip_addr":  "10.0.100.110",
"service":  "UDS gRPC Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"node_number":  "2",
"node_name":  "test-22.openstacklocal",
"ip_addr":  "10.0.100.110",
"service":  "i/o gRPC Server",
"service_status":  "RUNNING",
"message":  "healthy"
},
{
"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"
}
]
}