Resource URL: /platform/<<version=3>>/statistics/summary/client

    Overview: The client mode displays cluster usage statistics organized
              according to cluster hosts and users.

     Methods: GET

********************************************************************************

Method GET: 

       URL: GET /platform/<<version=3>>/statistics/summary/client

Query arguments:
        sort=<string> { drive_id | type | xfers_in | bytes_in | xfer_size_in |
                      xfers_out | bytes_out | xfer_size_out | access_latency |
                      access_slow | iosched_latency | iosched_queue | busy |
                      used_bytes_percent | used_inodes } Sort data by the
                      specified comma-separated field(s). Prepend 'asc:' or
                      'desc:' to a field to change the sort direction.
remote_addrs=<string> A comma seperated list. Only report statistics for
                      operations requested by the remote clients with
                      dotted-quad IP addresses enumerated.
    timeout=<integer> Timeout remote commands after NUM seconds, where NUM is
                      the integer passed to the argument.
  user_names=<string> A comma seperated list. Only report statistics for
                      operations requested by users with resolved names
                      enumerated.
    numeric=<boolean> Whether to convert hostnames or usernames to their human
                      readable form. False by default.
remote_names=<string> A comma seperated list. Only report statistics for
                      operations requested by the remote clients with resolved
                      names enumerated.
    user_ids=<string> A comma seperated list. Only report statistics for
                      operations requested by users with numeric UIDs
                      enumerated.
     classes=<string> Specify class(es) for which statistics should be
                      reported. Default is all supported classes.
     totalby=<string> A comma separated list specifying what should be unique.
                      node|protocol|class|local_addr|local_name|remote_addr|remote_name|user_id|user_name|devid
 local_addrs=<string> A comma seperated list. Only report statistics for
                      operations handled by the local hosts with dotted-quad IP
                      addresses enumerated.
   degraded=<boolean> Continue to report if some nodes do not respond.
 local_names=<string> A comma seperated list. Only report statistics for
                      operations handled by the local hosts with resolved names
                      enumerated.
       nodes=<string> A comma seperated list. Specify node(s) for which
                      statistics should be reported. Default is 'all'. Zero (0)
                      should be passed in as the sole argument to indicate
                      local.
   protocols=<string> A comma seperated list of the protocol(s) you wish to
                      return. Default is 'all' of the folowing:
                      nfs3|smb1|nlm|ftp|http|siq|iscsi|smb2|nfs4|papi|jobd|irp|lsass_in|lsass_out|hdfs|internal|external

GET response body schema:
{
  "type": "object", 
  "properties": {
    "client": {
      "items": {
        "type": "object", 
        "properties": {
          "out_avg": {
            "required": true, 
            "type": "number", 
            "description": "Average output (sent) bytes for an operation, in bytes."
          }, 
          "protocol": {
            "required": true, 
            "type": "string", 
            "description": "The protocol of the operation."
          }, 
          "num_operations": {
            "required": true, 
            "type": "integer", 
            "description": "The number of times an operation has been performed."
          }, 
          "in": {
            "required": true, 
            "type": "number", 
            "description": "Rate of input (in bytes/second) for an operation since the last time isi statistics collected the data."
          }, 
          "out": {
            "required": true, 
            "type": "number", 
            "description": "Rate of output (in bytes/second) for an operation since the last time isi statistics collected the data."
          }, 
          "time_avg": {
            "required": true, 
            "type": "number", 
            "description": "The average elapsed time (in microseconds) taken to complete an operation."
          }, 
          "time_max": {
            "required": true, 
            "type": "number", 
            "description": "The maximum elapsed time (in microseconds) taken to complete an operation."
          }, 
          "remote_addr": {
            "required": true, 
            "type": "string", 
            "description": "The IP address (in dotted-quad form) of the host sending the operation request."
          }, 
          "local_addr": {
            "required": true, 
            "type": "string", 
            "description": "The IP address (in dotted-quad form) of the host receiving the operation request."
          }, 
          "in_avg": {
            "required": true, 
            "type": "number", 
            "description": "Average input (received) bytes for an operation, in bytes."
          }, 
          "node": {
            "required": true, 
            "type": "integer", 
            "description": "The node on which the operation was performed."
          }, 
          "in_min": {
            "required": true, 
            "type": "number", 
            "description": "Minimum input (received) bytes for an operation, in bytes."
          }, 
          "local_name": {
            "required": true, 
            "type": "string", 
            "description": "The resolved text name of the LocalAddr, if resolution can be performed."
          }, 
          "out_min": {
            "required": true, 
            "type": "number", 
            "description": "Minimum output (sent) bytes for an operation, in bytes."
          }, 
          "user": {
            "required": false, 
            "type": {
              "type": "object", 
              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
              "properties": {
                "type": {
                  "enum": [
                    "user", 
                    "group", 
                    "wellknown"
                  ], 
                  "type": "string", 
                  "description": "Specifies the type of persona, which must be combined with a name."
                }, 
                "id": {
                  "type": "string", 
                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                }, 
                "name": {
                  "type": "string", 
                  "description": "Specifies the persona name, which must be combined with a type."
                }
              }
            }, 
            "description": "User issuing the operation."
          }, 
          "time_min": {
            "required": true, 
            "type": "number", 
            "description": "The minimum elapsed time (in microseconds) taken to complete an operation."
          }, 
          "remote_name": {
            "required": true, 
            "type": "string", 
            "description": "The resolved text name of the RemoteAddr, if resolution can be performed."
          }, 
          "class": {
            "required": true, 
            "type": "string", 
            "description": "The class of the operation."
          }, 
          "in_max": {
            "required": true, 
            "type": "number", 
            "description": "Maximum input (received) bytes for an operation, in bytes."
          }, 
          "operation_rate": {
            "required": true, 
            "type": "number", 
            "description": "The rate (in ops/second) at which an operation has been performed."
          }, 
          "out_max": {
            "required": true, 
            "type": "number", 
            "description": "Maximum output (sent) bytes for an operation, in bytes."
          }, 
          "time": {
            "required": true, 
            "type": "integer", 
            "description": "Unix Epoch time in seconds of the request."
          }
        }
      }, 
      "type": "array"
    }
  }
}
