Perfmon/sensors: GET

Gets the performance sensor configuration.

Availability

Available on all IBM Storage Scale editions.

Description

The GET perfmon/sensors request gets details of the performance monitoring sensors that are configured in the cluster. For more information about the fields in the data structures that are returned, see the topic mmperfmon command.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/perfmon/sensors
where
perfmon/sensors
Specifies the performance monitoring sensors as the resource of this GET call. Required.

Request headers

Content-Type: application/json
Accept: application/json

Request parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of request parameters
Parameter name Description and applicable keywords Required/optional
fields Comma separated list of fields to be included in response. ':all:' selects all available fields. Optional.
filter Filter objects by expression. For example, 'status=HEALTHY,entityType=FILESET' Optional.

Request data

No request data.

Response data

{  
  "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   "performanceData": {}
}
For more information about the fields in the following data structures, see the links at the end of this topic.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"performanceData":
The performance data that is returned from the performance monitoring tool based on the query that you entered.

Examples

The following example shows how to use the API command to get the details of the performance monitoring sensor configuration in the cluster.

Request URL: 
curl -k -u admin:admin001 -X GET --header 'accept:application/json' 
'https://198.51.100.1:443/scalemgmt/v2/perfmon/sensors'
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
{
  "sensorConfig" : [ {
    "component" : "TCT",
    "defaultPeriod" : 10,
    "defaultRestriction" : "",
    "description" : "",
    "enabledPerDefault" : true,
    "generic" : true,
    "minimumPeriod" : 1,
    "period" : 20,
    "restrict" : [ ],
    "restrictionType" : "USERNODECLASS",
    "sensorName" : "TCTDebugLweDestroyStats"
  } ],
  "status" : {
    "code" : 200,
    "message" : "The request finished successfully."
  }
}