serviceStatistics
The serviceStatistics
data type retrieves information about the statistics of services used by your HCP system.
serviceStatistics data type properties
The following table describes the properties included in the serviceStatistics
data type.
Property name | Data type | Description |
endTime | Integer | Time that the service finished running. A value of -1 indicates that the service has not finished running. |
formattedStartTime | String |
Date and time that the service started running since the last run. This value is formatted for easy reading. This value is returned only if the service has run at least once. |
formattedEndTime | String |
Date and time that the service finished running since the last run. This value is formatted for easy reading. This value is returned only if the service has run at least once. |
name | String | Name of the service. |
objectsExamined | Integer | Number of objects that the service examined. |
objectsExaminedPerSecond | Double | Number of objects per second that the service examined. |
objectsServiced | Integer | Number of objects that were serviced by the service. |
objectsServicedPerSecond | Double | Number of objects per second that were serviced by the service. |
objectsUnableToService | Integer | Number of objects that the service could not service. |
objectsUnableToServicePerSecond | Double | Number of objects per second that the service could not service. |
performanceLevel | Integer | Performance level of the service. This is returned only if the state of the service is RUNNING or STOPPING. |
startTime | Integer | Time that the service started running. A value of -1 indicates that the service has not started running yet. |
state | String | Current state of the service. |
Example
Here is an XML example of the serviceStatistics
data type:
<serviceStatistics> <requestTime>1524773822369</requestTime> <services> <service> <name>StorageTieringService</name> <state>READY</state> <startTime>1563961637</startTime> <formattedStartTime>7/24/2019 5:47:17 EDT</formattedStartTime> <endTime>1563961639</endTime> <formattedEndTime>7/24/2019 5:47:19 EDT</formattedEndTime> <objectsExamined>11800</objectsExamined> <objectsExaminedPerSecond>6300.5</objectsExaminedPerSecond> <objectsServiced>0</objectsServiced> <objectsServicedPerSecond>0.0</objectsServicedPerSecond> <objectsUnableToService>0</objectsUnableToService> <objectsUnableToServicePerSecond>0.0</objectsUnableToServicePerSecond> </service> <service> <name>GarbageCollection</name> <state>READY</state> <startTime>1523624400</startTime> <formattedStartTime>7/19/2019 0:04:55 EST</formattedStartTime> <endTime>1539576002</endTime> <formattedEndTime>7/19/2019 0:06:00 EST</formattedEndTime> <objectsExamined>29530</objectsExamined> <objectsExaminedPerSecond>1032.05</objectsExaminedPerSecond> <objectsServiced>2305</objectsServiced> <objectsServicedPerSecond>.08</objectsServicedPerSecond> <objectsUnableToService>0</objectsUnableToService> <objectsUnableToServicePerSecond>0</objectsUnableToServicePerSecond> </service> <service> <name>RetirementPolicy</name> <state>DISABLED</state> <startTime>-1</startTime> <formattedStartTime>-1</formattedStartTime> <endTime>-1</endTime> <formattedEndTime>-1</formattedEndTime> <objectsExamined>0</objectsExamined> <objectsExaminedPerSecond>0.0</objectsExaminedPerSecond> <objectsServiced>0</objectsServiced> <objectsServicedPerSecond>0.0</objectsServicedPerSecond> <objectsUnableToService>0</objectsUnableToService> <objectsUnableToServicePerSecond>0.0</objectsUnableToServicePerSecond> </service> </serviceStatistics>