permalink | sidebar | keywords | summary |
---|---|---|---|
api/reference_element_api_listclusterfaults.html |
sidebar |
cluster,list,listing,fault,faults,listclusterfaults,error,errors |
You can use the ListClusterFaults method to list information about any faults detected on the cluster. With this method, you can list both current faults as well as faults that have been resolved. The system caches faults every 30 seconds. |
You can use the ListClusterFaults
method to list information about any faults detected on the cluster. With this method, you can list both current faults as well as faults that have been resolved. The system caches faults every 30 seconds.
This method has the following input parameters:
Name | Description | Type | Default value | Required |
---|---|---|---|---|
bestPractices |
Include faults triggered by sub-optimal system configuration. Possible values:
|
boolean |
None |
No |
faultTypes |
Determines the types of faults returned. Possible values:
|
string |
all |
No |
This method has the following return value:
Name |
Description |
Type |
faults |
An object describing the requested cluster faults. |
Requests for this method are similar to the following example:
{ "method": "ListClusterFaults", "params": { "faultTypes": "current", "bestPractices": true }, "id": 1 }
This method returns a response similar to the following example:
{ "id": 1, "result": { "faults": [ { "blocksUpgrade": false, "clusterFaultID": 3, "code": "driveAvailable", "data": null, "date": "2024-04-03T22:22:56.660275Z", "details": "Node ID 1 has 6 available drive(s).", "driveID": 0, "driveIDs": [], "externalSource": "", "networkInterface": "", "nodeHardwareFaultID": 0, "nodeID": 1, "resolved": true, "resolvedDate": "2024-04-03T22:24:54.598693Z", "serviceID": 0, "severity": "warning", "type": "drive" }, { "clusterFaultID": 9, "code": "disconnectedClusterPair", "data": null, "date": "2016-04-26T20:40:08.736597Z", "details": "One of the clusters in a pair may have become misconfigured or disconnected. Remove the local pairing and retry pairing the clusters. Disconnected Cluster Pairs: []. Misconfigured Cluster Pairs: [3]", "driveID": 0, "driveIDs": [], "nodeHardwareFaultID": 0, "nodeID": 0, "resolved": false, "resolvedDate": "", "serviceID": 0, "severity": "warning", "type": "cluster" } ] } }