Jump to

• Request
• Response
• Examples

Get Information on SDM Servers

get

/rest/{versionId}/admin/serverInfo

Use this (GET) method to retrieve server specific status and health information for all servers within a SDM cluster.

Request

Path Parameters

• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : serverInfo

Type: object

Show Source

• clusterMembers(optional): array clusterMembers
• globalId(optional): string
• loginBanner(optional): string
• masterNodeIp(optional): string
• productName(optional): string
• version(optional): string

{
    "properties":{
        "clusterMembers":{
            "items":{
                "$ref":"#/definitions/RestServerClusterNodeInfo",
                "xml":{
                    "name":"clusterMember"
                }
            },
            "type":"array",
            "xml":{
                "wrapped":true
            }
        },
        "globalId":{
            "type":"string"
        },
        "loginBanner":{
            "type":"string"
        },
        "masterNodeIp":{
            "type":"string"
        },
        "productName":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"serverInfo"
    }
}

Nested Schema : clusterMembers

Type: array

Show Source

• Array of: object serverClusterNodeInfo

{
    "items":{
        "$ref":"#/definitions/RestServerClusterNodeInfo",
        "xml":{
            "name":"clusterMember"
        }
    },
    "type":"array",
    "xml":{
        "wrapped":true
    }
}

Nested Schema : serverClusterNodeInfo

Type: object

Show Source

• downTime(optional): string
• failureHeartBeatCount(optional): integer(int64)
• heartBeatCount(optional): integer(int64)
• inactivityHeartBeatCount(optional): integer(int64)
• ipAddress(optional): string
• lastHeartBeatTime(optional): string
• maxFailureHeartBeatCount(optional): integer(int64)
• missedHeartBeatCount(optional): integer(int64)
• name(optional): string
• resetCount(optional): integer(int64)
• status(optional): string
• upTime(optional): string

{
    "properties":{
        "downTime":{
            "type":"string"
        },
        "failureHeartBeatCount":{
            "format":"int64",
            "type":"integer"
        },
        "heartBeatCount":{
            "format":"int64",
            "type":"integer"
        },
        "inactivityHeartBeatCount":{
            "format":"int64",
            "type":"integer"
        },
        "ipAddress":{
            "type":"string"
        },
        "lastHeartBeatTime":{
            "type":"string"
        },
        "maxFailureHeartBeatCount":{
            "format":"int64",
            "type":"integer"
        },
        "missedHeartBeatCount":{
            "format":"int64",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "resetCount":{
            "format":"int64",
            "type":"integer"
        },
        "status":{
            "type":"string"
        },
        "upTime":{
            "type":"string"
        }
    },
    "type":"object",
    "xml":{
        "name":"serverClusterNodeInfo"
    }
}

400 Response

Invalid ID supplied

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get information on SDM servers by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -b sessionid.txt \
    --header "Accept: application/xml" \
    "https://example.com:8443/rest/v1.3/admin/serverInfo"

Example of Accessing the API with Python

The following example shows how to get information on SDM servers by submitting a GET request on the REST resource using Python. This example assumes the cookie variable contains a valid authentication cookie. For an example of authenticating with Python, see Authenticate.

import requests
url = "https://example.com:8443/rest/v1.3/admin/serverInfo"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Wed, 08 May 2019 12:49:57 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
vary: Origin,Accept-Encoding
Content-Length: 724
Content-Type: application/xml

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<serverInfo>
  <clusterMembers>
    <clusterMember>
      <downTime>NA</downTime>
      <failureHeartBeatCount>0</failureHeartBeatCount>
      <heartBeatCount>274809</heartBeatCount>
      <inactivityHeartBeatCount>0</inactivityHeartBeatCount>
      <ipAddress>10.0.0.4</ipAddress>
      <lastHeartBeatTime>2019-05-08 08:49:50</lastHeartBeatTime>
      <maxFailureHeartBeatCount>1</maxFailureHeartBeatCount>
      <missedHeartBeatCount>0</missedHeartBeatCount>
      <name>10.0.0.55</name>
      <resetCount>0</resetCount>
      <status>ACTIVE</status>
      <upTime>15:21:41</upTime>
    </clusterMember>
  </clusterMembers>
  <globalId>SDM</globalId>
  <masterNodeIp>10.0.0.55</masterNodeIp>
  <productName>OCSDM</productName>
  <version>NNC82</version>
</serverInfo>

Back to Top