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 clusterMember
• globalId(optional): string
• loginBanner(optional): string
• masterNodeIp(optional): string
• productName(optional): string
• version(optional): string

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

Nested Schema : clusterMember

Type: array

Show Source

• Array of: object serverClusterNodeInfo

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

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

{
    "type":"object",
    "properties":{
        "ipAddress":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "inactivityHeartBeatCount":{
            "type":"integer",
            "format":"int64"
        },
        "failureHeartBeatCount":{
            "type":"integer",
            "format":"int64"
        },
        "maxFailureHeartBeatCount":{
            "type":"integer",
            "format":"int64"
        },
        "missedHeartBeatCount":{
            "type":"integer",
            "format":"int64"
        },
        "heartBeatCount":{
            "type":"integer",
            "format":"int64"
        },
        "resetCount":{
            "type":"integer",
            "format":"int64"
        },
        "lastHeartBeatTime":{
            "type":"string"
        },
        "downTime":{
            "type":"string"
        },
        "upTime":{
            "type":"string"
        }
    },
    "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

The following example shows how to retrieve Session Delivery Manager server summary information by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

Example of cURL Data

The following shows an example of cURL data sent with the request.

curl -v -s -b sessionid.txt -X GET -H"Content-Type: application/xml" -H"Accept: application/xml" http://example.com:8080/rest/v1.1/admin/serverInfo

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Fri, 24 Feb 2017 19:39:17 GMT
Server: Apache
X-Frame-Options: SAMEORIGIN
Content-Length: 725
Vary: Accept-Encoding
Content-Type: application/xml

Example of 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>22058</heartBeatCount>
      <inactivityHeartBeatCount>0</inactivityHeartBeatCount>
      <ipAddress>10.0.0.3</ipAddress>
      <lastHeartBeatTime>2017-02-24 14:39:16</lastHeartBeatTime>
      <maxFailureHeartBeatCount>1</maxFailureHeartBeatCount>
      <missedHeartBeatCount>0</missedHeartBeatCount>
      <name>10.0.0.3</name>
      <resetCount>0</resetCount>
      <status>ACTIVE</status>
      <upTime>01:06:38</upTime>
    </clusterMember>
  </clusterMembers>
  <globalId>SDMAO</globalId>
  <masterNodeIp>10.0.0.3</masterNodeIp>
  <productName>OCSDM</productName>
  <version>NNC76B40</version>
</serverInfo>

Back to Top