Topology

Available APIs

/api/topology/

Return tenant topology data. See the attributes for the node and edge data.

GET

Return the tenant topology data.

Attributes

Node

id (read-only) id for the node data (nickname)
hostName (read-only) Host name
ipAddresses (read-only) List of IP addresses.

Edge

fromId (read-only) From node id (Nickname).
fromAvgResponseTime (read-only) From average response time in microseconds (fromTransactionTime/fromNumberTransactions).
fromMeanTime (read-only) From mean time.
fromNumberTransactions (read-only) From number of transactions.
fromStandardDeviationTime (read-only) From standard deviation time.
fromTransactionTime (read-only) From total transaction time in microseconds.
socketNum (read-only) Socket count.
socketRead (read-only) Inbound network traffic.
socketWrite (read-only) Outbound network traffic.
toId (read-only) To node id (Nickname).
toAvgResponseTime (read-only) To average response time in microseconds (toTransactionTime/toNumberTransactions).
toMeanTime (read-only) To mean time.
toNumberTransactions (read-only) To number of transactions.
toStandardDeviationTime (read-only) To standard deviation time.
toTransactionTime (read-only) To total transaction time in microseconds.

Time

time (read-only) The time this data is for.

Arguments

  • timespan (optional) – Time span in seconds to calculate metrics (default=180, minimum=60).
  • start (optional) – Integer start time when to start the time span (default=now).
  • tag (optional) – Server tag id (topology of servers for this tag).
  • set (optional) – Server set id (topology of servers for this server set).
curl --user {EMAIL}:{API_KEY} https://wwws.appfirst.com/api/topology/?timespan=60&tag=4
{
    "pagination": {
        "count": 3, 
        "previous": null, 
        "next": null
    }, 
    "data": {
        "node": [
            {
                "hostName": "brian-win-svr", 
                "id": "brian-windows-server", 
                "ipAddresses": "[\"10.7.7.189\",\"fe80::65b5:a92b:7840:6d34\"]"
            }, 
            {
                "hostName": "brian-centos-db", 
                "id": "brian-centos-db", 
                "ipAddresses": "[\"10.7.7.199\"]"
            }, 
            {
                "hostName": "External", 
                "id": "External", 
                "ipAddresses": "[\"IPv6_Addr\",\"10.7.7.15\"]"
            }
        ], 
        "time": "1429561380", 
        "edge": [
            {
                "fromNumberTransactions": "0", 
                "toTransactionTime": "0", 
                "fromMeanTime": "0", 
                "toNumberTransactions": "0", 
                "socketNum": "1", 
                "socketRead": "0", 
                "toAvgResponseTime": "0", 
                "fromTransactionTime": "0", 
                "toMeanTime": "0", 
                "toId": "brian-windows-server", 
                "fromId": "brian-windows-server", 
                "socketWrite": "558", 
                "fromAvgResponseTime": "0", 
                "toStandardDeviationTime": "0", 
                "fromStandardDeviationTime": "0"
            }, 
            {
                "fromNumberTransactions": "0", 
                "toTransactionTime": "0", 
                "fromMeanTime": "0", 
                "toNumberTransactions": "0", 
                "socketNum": "12", 
                "socketRead": "0", 
                "toAvgResponseTime": "0", 
                "fromTransactionTime": "0", 
                "toMeanTime": "0", 
                "toId": "External", 
                "fromId": "brian-windows-server", 
                "socketWrite": "201678", 
                "fromAvgResponseTime": "0", 
                "toStandardDeviationTime": "0", 
                "fromStandardDeviationTime": "0"
            }, 
            {
                "fromNumberTransactions": "0", 
                "toTransactionTime": "0", 
                "fromMeanTime": "0", 
                "toNumberTransactions": "0", 
                "socketNum": "14", 
                "socketRead": "0", 
                "toAvgResponseTime": "0", 
                "fromTransactionTime": "0", 
                "toMeanTime": "0", 
                "toId": "brian-centos-db", 
                "fromId": "brian-centos-db", 
                "socketWrite": "0", 
                "fromAvgResponseTime": "0", 
                "toStandardDeviationTime": "0", 
                "fromStandardDeviationTime": "0"
            }, 
            {
                "fromNumberTransactions": "0", 
                "toTransactionTime": "0", 
                "fromMeanTime": "0", 
                "toNumberTransactions": "0", 
                "socketNum": "18", 
                "socketRead": "45016", 
                "toAvgResponseTime": "0", 
                "fromTransactionTime": "0", 
                "toMeanTime": "0", 
                "toId": "External", 
                "fromId": "brian-centos-db", 
                "socketWrite": "48904", 
                "fromAvgResponseTime": "0", 
                "toStandardDeviationTime": "0", 
                "fromStandardDeviationTime": "0"
            }
        ]
    }
}