Cluster MetroCluster diagnostics endpoint overview
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
Overview
You can use this API to initiate a MetroCluster diagnostics operation and fetch the results of a completed diagnostics operation on a MetroCluster over IP configuration. The GET operation retrieves the results of a completed diagnostics operation for the MetroCluster over IP configuration. These can include the overall high level and details for the checks done for different components. By default, the response does not include the details. If the fields query is used in the request, the response will include the details. The POST request can be used to start a MetroCluster diagnostics operation or set up a schedule for the diagnostics to be run periodically.
Details
Details provide a way to view all the checks done on a component and the result of each check. The details of the checks are not included
in the response by default. In order to fetch the details, use the fields
query parameter.
-
node.details
-
aggregate.details
-
cluster.details
-
volume.details
-
connection.details
Starting a MetroCluster diagnostics operation
A new MetroCluster diagnostics operation can be started by issuing a POST to /cluster/metrocluster/diagnostics. There are no extra parameters required to initiate a diagnostics operation.
Polling the POST job for status of diagnostics operation
After a successful POST /cluster/diagnostics operation is issued, an HTTP status code of 202 (Accepted) is returned along with a job UUID and a link in the body of the response. The POST job continues asynchronously and can be monitored by using the job UUID and the /cluster/jobs API. The "message" field in the response of the GET /cluster/jobs/{uuid} request shows the current step in the job, and the "state" field shows the overall state of the job.
Examples
Running the diagnostics operation
This example shows the POST request for starting a diagnostic operation for a MetroCluster over IP configuration and the responses returned:
#API /api/cluster/metrocluster/diagnostics
POST Request
curl -X POST https://<mgmt-ip>/api/cluster/metrocluster/diagnostics
POST Response
HTTP/1.1 202 Accepted Date: Tue, 22 Sep 2020 17:20:53 GMT Server: libzapid-httpd X-Content-Type-Options: nosniff Cache-Control: no-cache,no-store,must-revalidate Location: /api/cluster/metrocluster/diagnostics Content-Length: 189 Content-Type: application/hal+json { "job": { "uuid": "f7d3804c-fcf7-11ea-acaf-005056bb47c1", "_links": { "self": { "href": "/api/cluster/jobs/f7d3804c-fcf7-11ea-acaf-005056bb47c1" } } } }
Monitoring the job progress
Use the link provided in the response to the POST request to fetch information for the diagnostics operation job.
Request
curl -X GET https://<mgmt-ip>/api/cluster/jobs/f7d3804c-fcf7-11ea-acaf-005056bb47c1
Job status response
HTTP/1.1 202 Accepted Date: Tue, 22 Sep 2020 17:21:12 GMT Server: libzapid-httpd X-Content-Type-Options: nosniff Cache-Control: no-cache,no-store,must-revalidate Content-Length: 345 Content-Type: application/hal+json { "uuid": "f7d3804c-fcf7-11ea-acaf-005056bb47c1", "description": "POST /api/cluster/metrocluster/diagnostics", "state": "running", "message": "Checking nodes...", "code": 2432853, "start_time": "2020-09-22T13:20:53-04:00", "_links": { "self": { "href": "/api/cluster/jobs/f7d3804c-fcf7-11ea-acaf-005056bb47c1" } } }
Final status of the diagnostics job
HTTP/1.1 202 Accepted Date: Tue, 22 Sep 2020 17:29:04 GMT Server: libzapid-httpd X