ONTAP 9 Manuals ( CA08871-402 )

Accessing the REST API log

You can access the log containing a record of the ONTAP REST API calls made by ONTAP System Manager. When displaying the log, you can also reissue API calls and review the output.

Steps
  1. At the top of the page, click Display API log to display the REST API log.

    The most recent entries are displayed at the bottom of the page.

  2. On the left, click DASHBOARD and observe the new entries being created for the API calls issued to refresh the page.

  3. Click STORAGE and then click Qtrees.

    This causes ONTAP System Manager to issue a specific API call to retrieve a list of the Qtrees.

  4. Locate the log entry describing the API call which has the form:

    GET /api/storage/qtrees

    You will see additional HTTP query parameters included with the entry, such as max_records.

  5. Click the log entry to reissue the GET API call and display the raw JSON output.

    Example

    {
      "records": [
        {
          "svm": {
            "uuid": "19507946-e801-11e9-b984-00a0986ab770",
            "name": "SMQA",
            "_links": {
              "self": {
                "href": "/api/svm/svms/19507946-e801-11e9-b984-00a0986ab770"
              }
            }
          },
          "volume": {
            "uuid": "1e173258-f98b-11e9-8f05-00a0986abd71",
            "name": "vol_vol_test2_dest_dest",
            "_links": {
              "self": {
                "href": "/api/storage/volumes/1e173258-f98b-11e9-8f05-00a0986abd71"
              }
            }
          },
          "id": 1,
          "name": "test2",
          "security_style": "mixed",
          "unix_permissions": 777,
          "export_policy": {
            "name": "default",
            "id": 12884901889,
            "_links": {
              "self": {
                "href": "/api/protocols/nfs/export-policies/12884901889"
              }
            }
          },
          "path": "/vol_vol_test2_dest_dest/test2",
          "_links": {
            "self": {
              "href": "/api/storage/qtrees/1e173258-f98b-11e9-8f05-00a0986abd71/1"
            }
          }
        },
        ],
        "num_records": 1,
        "_links": {
          "self": {
            "href": "/api/storage/qtrees?max_records=20&fields=*&name=!%22%22"
          }
        }
      }
Top of Page