nodeStatistics

The nodeStatistics data type retrieves information about the statistics of nodes in your HCP system.

nodeStatistics data type properties

The next table describes the properties included in the nodeStatistics data type.

Property nameData typeDescription
backEndBytesReadFloatAverage number of bytes read from the node per second over the back-end network.
backEndBytesWrittenFloatAverage number of bytes written to the node per second over the back-end network.
backendIpAddressStringBackend IP address.
blocksReadFloatAverage number of blocks read from the logical volume per second.
blocksWrittenFloatAverage number of blocks written to the logical volume per second.
collectionTimestampIntegerExact time that the statistics were collected in milliseconds.
cpuMaxFloatMaximum amount of CPU capacity allotted for HCP processes.
cpuSystemFloatPercentage of CPU capacity used by the operating system kernel.
cpuUserFloatPercentage of CPU capacity used by HCP processes.
diskUtilizationFloatUse of the communication channel between the operating system and the logical volume as a percent of the channel bandwidth.
freeBytesLongAvailable free space on a HCP volume.
freeInodesLongAvailable free inodes on a HCP volume.
frontEndBytesReadFloatAverage number of bytes read from the node per second over the front-end network.
frontEndBytesWrittenFloatAaverage number of bytes written to the node per second over the front-end network.
frontendIpAddressesListList of front-end IP addresses. This property lists one or two IP addresses (IPv4 and/or IPv6).
idFloatName of the logical volume.
ioWaitFloatPercentage of CPU capacity spent waiting to access logical volumes that are in use by other processes.
managementBytesReadFloatAverage number of bytes read from the node per second over the management port network. This is returned only if you have configured the management port network on the node.
managementBytesWrittenFloat Average number of bytes written to the node per second over the management port network. This is returned only if you have configured the management port network on the node.
managementIpAddressesListList of management network IP addresses. This is returned only if you have configured the management port network on the node.
maxBackEndBandwidthIntegerMaximum amount of CPU capacity allotted for HCP processes.
maxFrontEndBandwidthIntegerThe maximum amount of CPU capacity allotted for HCP processes.
maxHttpConnectionsIntegerMaximum number of HTTP connections.
maxHttpsConnectionsIntegerMaximum number of HTTPS connections.
maxManagementPortBandwidthIntegerMaximum amount of CPU capacity allotted for HCP processes. This is returned only if you have configured the management port network on the node.
nodeNumberIntegerNumber of the node.
openHttpConnectionsIntegerNumber of open HTTP connections.
openHttpsConnectionsIntegerNumber of open HTTPS connections.
requestTimeIntegerExact time that the request was issued in milliseconds.
swapOutFloat Average number of pages swapped out of memory per second.
totalBytesLongTotal size of an HCP volume.
totalInodesLongMaximum inodes limit of a HCP volume.
transferSpeedFloatTransfer speed for the logical volumes specified as the number of input/output requests per second.

Example

Here’s an XML example of the nodeStatistics data type:

<nodeStatistics>
     <requestTime>1528292517330</requestTime>
     <nodes>
          <node>
               <nodeNumber>17</nodeNumber>
               <frontendIpAddresses>
                    <ipAddress>172.20.35.17</ipAddress>
                    <ipAddress>2001:623:0:0:222:11ff:fec7:6584</ipAddress>
               </frontendIpAddresses>
               <backendIpAddress>172.35.14.17</backendIpAddress>
               <managementIpAddresses>
                    <ipAddress>172.20.45.17</ipAddress>
                    <ipAddress>2001:623:0:0:222:11ff:fec7:6585</ipAddress>
               </managementIpAddresses>
               <openHttpConnections>0</openHttpConnections>
               <openHttpsConnections>0</openHttpsConnections>
               <maxHttpConnections>255</maxHttpConnections>
               <maxHttpsConnections>254</maxHttpsConnections>
               <cpuUser>0.16</cpuUser>
               <cpuSystem>0.08</cpuSystem>
               <cpuMax>24</cpuMax>
               <ioWait>0.02</ioWait>
               <swapOut>0.0</swapOut>
               <maxFrontEndBandwidth>1024000</maxFrontEndBandwidth>
               <frontEndBytesRead>0.3</frontEndBytesRead>
               <frontEndBytesWritten>0.2</frontEndBytesWritten>
               <maxBackEndBandwidth>1024000</maxBackEndBandwidth>
               <backEndBytesRead>7.22</backEndBytesRead>
               <backEndBytesWritten>3.87</backEndBytesWritten>
               <maxManagementPortBandwidth>1024000</maxManagementPortBandwidth>
               <managementBytesRead>.75</managementBytesRead>
               <managementBytesWritten>.7</managementBytesWritten>
               <collectionTimestamp>1528292472000</collectionTimestamp>
               <volumes>
                    <volume>
                         <id>example090</id>
                         <blocksRead>0.0</blocksRead>
                         <blocksWritten>5.17</blocksWritten>
                         <diskUtilization>0.2</diskUtilization>
                         <transferSpeed>0.35</transferSpeed>
                         <totalBytes>10223583</totalBytes>
                         <freeBytes>37940648</freeBytes>
                         <totalInodes>10223616</totalInodes>
                         <freeInodes>38073632</freeInodes>
                    </volume>
                    <volume>
                         <id>example091</id>
                         <blocksRead>0.0</blocksRead>
                         <blocksWritten>200.33</blocksWritten>
                         <diskUtilization>0.13</diskUtilization>
                         <transferSpeed>2.45</transferSpeed>
                         <totalBytes>10217599</totalBytes>
                         <freeBytes>37887380</freeBytes>
                         <totalInodes>10443212</totalInodes>
                         <freeInodes>40083820</freeInodes>
                    </volume>
               </volumes>
          </node>
          <node>
              . . . .
          </node>
     </nodes>
</nodeStatistics>