Analytics のワークシート

言語:

ワークシートは統計がグラフ化される BUI 画面です。複数の統計を同時にプロットでき、ワークシートにタイトルを付けてあとで表示するために保存できます。ワークシートを保存する操作によって、オープン中のすべての統計のアーカイブアクションが自動的に実行されます。つまり、統計が開いていれば、統計の読み取りおよびアーカイブが際限なく続けられます。ワークシートコマンドは、BUI から使用可能なワークシートを管理するために使用できます。

名前	説明
ctime	このワークシートが作成された日時
mtime	このワークシートが最後に変更された日時
name	このワークシートの名前
owner	このワークシートの所有者
uuid	このワークシートの汎用一意識別子

ワークシートの一覧表示

現在構成済みのすべての分析ワークシートを一覧表示します。

リクエストの例:

GET /api/analytics/v1/worksheets HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: example.zfssa.com:215
Accept: application/json

レスポンスの例:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 237
X-Zfssa-Analytics-Api: 1.0

{
    "worksheets": [{
        "href": "/api/analytics/v1/worksheets/ab59bcbc...",
        "uuid": "ab59bcbc-080a-cf1a-98c9-9f485bc3a43d"
    }, {
        "href": "/api/analytics/v1/worksheets/bb3ee729...",
        "uuid": "bb3ee729-080a-cf1a-98c9-9f485bc3a43d"
    }]
}

分析ワークシートの取得

単一の分析ワークシートを取得します。

リクエストの例:

GET /api/analytics/v1/worksheets/ab59bcbc-080a-cf1a-98c9-9f485bc3a43d
    HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: example.zfssa.com:215
Accept: application/json

レスポンスの例:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 237
X-Zfssa-Analytics-Api: 1.0

{
    "worksheet": {
        "ctime": "Thu Jun 13 2013 02:17:14 GMT+0000 (UTC)",
        "href": "/api/analytics/v1/worksheets
                 /ab59bcbc-080a-cf1a-98c9-9f485bc3a43d",
        "mtime": "Sun Jun 23 2013 16:22:01 GMT+0000 (UTC)",
        "name": "myworksheet",
        "owner": "root",
        "uuid": "ab59bcbc-080a-cf1a-98c9-9f485bc3a43d"
    }
}

ワークシートの作成

新しい分析ワークシートを作成します。

リクエストの例:

POST /api/analytics/v1/worksheets HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

{"name": "myworksheet"}

結果の例:

HTTP/1.1 201 Created
Content-Length: 280
Location: /api/analytics/v1/worksheets/bb3ee729-4480-4609-89b2-fae2dc016bec

{
    "worksheet": {
        "uuid": "bb3ee729-4480-4609-89b2-fae2dc016bec",
        "name": "myworksheet",
        "owner": "root",
        "ctime": "Fri Aug 23 2013 20:35:00 GMT+0000 (UTC)",
        "mtime": "Fri Aug 23 2013 20:35:00 GMT+0000 (UTC)",
        "href": "/api/analytics/v1/worksheets
                 /bb3ee729-4480-4609-89b2-fae2dc016bec"
    }
}

ワークシート名の変更

保存したワークシートの名前を変更します。

リクエストの例:

PUT /api/analytics/v1/worksheets/a442e761-4048-4738-b95f-be0824d7ed09
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

{"name": "test"}

レスポンスの例:

HTTP/1.1 202 Accepted
Date: Tue, 20 Dec 2016 00:33:06 GMT
Server: TwistedWeb/10.1.0
Content-Length: 279
X-Zfssa-Version: ak/generic@2013.06.05.7.0,1-1.12
X-Zfssa-Analytics-Api: 1.1
X-Zfssa-Api-Version: 1.0
Content-Type: application/json; charset=utf-8

    {"worksheet":
        {"href": "/api/analytics/v1/worksheets/a442e761-4048-4738-b95f-be0824d7ed09",
        "uuid": "a442e761-4048-4738-b95f-be0824d7ed09",
        "name": "test",
        "owner": "root",
        "ctime": "Wed Dec 14 2016 03:58:28 GMT+0000 (UTC)",
        "mtime": "Tue Dec 20 2016 00:25:57 GMT+0000 (UTC)"
    }
}

ワークシートの破棄

分析ワークシートを破棄します。この例では、ワークシート名がワークシート識別子として使用されていますが、href で指定される uuid も使用できます。このコマンドの動作は、ワークシートを破棄する CLI コマンドの動作と一致します。

リクエストの例:

DELETE /api/analytics/v1/worksheets/name=myworksheet HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

レスポンスの例:

HTTP/1.1 204 No Content
X-Zfssa-Analytics-Api: 1.0

ワークシートデータセットの一覧表示

指定されたワークシート内のすべてのデータセットを一覧表示します。データセット構成は、次のプロパティーを使用します。

名前	説明
name	このデータセットの基になる統計の名前
drilldowns	現在強調表示されているドリルダウン (ある場合)
seconds	このデータセットに表示されている秒数

リクエストの例:

GET /api/analytics/v1/worksheets/name=myworksheet/datasets HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: example.zfssa.com:215
Accept: application/json

ワークシートデータセットの追加

ワークシートデータセットを作成します。

リクエストの例:

POST /api/analytics/v1/worksheets/name=myworksheet/datasets HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

{"name": "nfs4.ops", "seconds": 300}

結果の例:

HTTP/1.1 201 Created
Content-Type: application/json
X-Zfssa-Analytics-Api: 1.0
Location: /api/analytics/v1/worksheets/name=me/datasets/nfs4.ops
Content-Length: 162

{
    "dataset": {
        "href": "/api/analytics/v1/worksheets/name=me/datasets/dataset-008",
        "name": "nfs4.ops",
        "width": 0,
        "drilldowns": [],
        "seconds": 300,
        "time": ""
    }
}

ワークシートデータセットの変更

既存のワークシートデータセットを変更します。

リクエストの例:

PUT /api/analytics/v1/worksheets/name=myworksheet/datasets/dataset-008
    HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Content-Type: application/json
Content-Length: 26

{"seconds": 60}

結果の例:

HTTP/1.1 202 Accepted
Content-Type: application/json
Content-Length: 161
X-Zfssa-Analytics-Api: 1.0

{
    "dataset": {
        "href": "/api/analytics/v1/worksheets/name=me/datasets/dataset-008",
        "name": "nfs4.ops",
        "width": 0,
        "drilldowns": [],
        "seconds": 60,
        "time": ""
    }
}