Go to main content

Oracle® ZFS Storage Appliance RESTful API ガイド、Release OS8.8.0

印刷ビューの終了

更新: 2018 年 11 月
 
 

Analytics のデータセット

Analytics のデータセットでは、次のプロパティーを使用します。suspended を除くすべてのプロパティーは変更できません。

プロパティー
説明
name
このデータセットの基になる統計の名前
grouping
この統計が属するグループ
explanation
基になる統計の説明
incore
コア中のデータセットデータのバイト数
size
ディスク上のデータセットデータのバイト数
suspended
データセットが現在一時停止中かどうかを示すブール値
activity
保留中のデータセットアクティビティーフラグ

使用可能なデータセット:

  • arc.accesses[hit/miss]

  • arc.l2_accesses[hit/miss]

  • arc.l2_size

  • arc.size

  • arc.size[component]

  • cpu.utilization

  • cpu.utilization[mode]

  • dnlc.accesses[hit/miss]

  • fc.bytes

  • fc.ops

  • ftp.kilobytes

  • http.reqs

  • io.bytes

  • io.bytes[op]

  • io.disks[utilization=95][disk]

  • io.ops

  • io.ops[disk]

  • io.ops[op]

  • iscsi.bytes

  • iscsi.ops

  • metacap.bytesused

  • metacap.percentused

  • ndmp.diskkb

  • nfs2.ops

  • nfs2.ops[op]

  • nfs3.ops

  • nfs3.ops[op]

  • nfs4.ops

  • nfs4.ops[op]

  • nfs4-1.ops

  • nfs4-1.bytes

  • nic.kilobytes

  • nic.kilobytes[device]

  • nic.kilobytes[direction]

  • sftp.kilobytes

  • smb.ops

  • smb.ops[op]

データセットの一覧表示

構成済みのすべての分析データセットを一覧表示します。

リクエストの例:

GET /api/analytics/v1/datasets HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: zfs-storage.example.com:215
Accept: application/json

結果の例:

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

{
    "datasets": [{
        "dataset": "dataset-000",
        "href": "/api/analytics/v1/datasets/arc.accesses[hit/miss]",
        "name": "arc.accesses[hit/miss]"
    }, {
        "dataset": "dataset-001",
        "href": "/api/analytics/v1/datasets/arc.l2_accesses[hit/miss]",
        "name": "arc.l2_accesses[hit/miss]",
    }, {
        "dataset": "dataset-002",
        "href": "/api/analytics/v1/datasets/arc.l2_size",
        "name": "arc.l2_size",
    }, {
        "dataset": "dataset-003",
        "href": "/api/analytics/v1/datasets/arc.size",
        "name": "arc.size",
    }, {
        "dataset": "dataset-004",
        "href": "/api/analytics/v1/datasets/arc.size[component]",
        "name": "arc.size[component]",
    }, {
        ...
    }]
}

データセットの取得

指定されたデータセットからプロパティーを取得します。

リクエストの例:

GET /api/analytics/v1/datasets/nfs4.ops HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: zfs-storage.example.com:215
Accept: application/json

結果の例:

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

{
    "dataset": {
        "activity": "none",
        "dataset": "dataset-030",
        "explanation": "NFSv4 operations per second",
        "grouping": "Protocol",
        "href": "/api/analytics/v1/datasets/nfs4.ops",
        "incore": 296128,
        "name": "nfs4.ops",
        "size": 53211540,
        "suspended": false
    }
}

データセットの作成

新しいデータセットを作成します。

リクエストの例:

POST /api/analytics/v1/datasets HTTP/1.1
X-Auth-User: root
X-Auth-Key: password
Content-Type: application/json
Content-Length: 26

{"statistic": "test.sine"}

結果の例:

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 200
Location: /api/analytics/v1/datasets/test.sine

{
    "dataset":{
        "href": "/api/analytics/v1/datasets",
        "name": "test.sine",
        "grouping": "Test",
        "explanation": "sine per second",
        "incore": 34752,
        "size": 31912,
        "suspended": false,
        "activity": "none"
    }
}

データセットの変更

データセットの変更コマンドは、単一データセットのデータ収集を一時停止または再開するために使用します。

一時停止リクエストの例:

POST /api/analytics/v1/datasets/nfs4.ops

{"suspended":true}

再開リクエストの例:

POST /api/analytics/v1/datasets/nfs4.ops
        {"suspended":false}

レスポンスの例:

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

{
    "dataset" {
        ...
        "suspended": false
    }
}

データセットの破棄

データセットを破棄します。

リクエストの例:

DELETE /api/analytics/v1/datasets/test.sine HTTP/1.1

レスポンスの例:

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

データセットの保存

データセットを保存します。

リクエストの例:

PUT /api/analytics/v1/datasets/nfs4.ops/data

レスポンスの例:

HTTP/1.1 202 Accepted

データセットデータの除去

次の表に、データセットの除去で使用される問合せプロパティーを示します。

パラメータ
説明
granularity
除去の粒度。second、minute、または hour という粒度値で、データセット内のデータを除去できます。
endtime
指定された endtime の前に収集されたデータを除去します。endtime は、ISO 8601 の日時文字列です (例: 20130531T01:13:58)。

リクエストの例:

DELETE /api/analytics/v1/datasets/nfs4.ops/data?granularity=hour

レスポンスの例:

HTTP/1.1 204 No Content

データセットデータの取得

分析データセットからデータを取得します。秒単位と粗粒度の両方のデータ取得がサポートされています。

次の表に、データセットデータを取得するための時間ベースの問合せパラメータを示します。

パラメータ
説明
start
サンプルデータの収集を開始する時間。デフォルト値は現在の時間です。
seconds
サンプルデータを収集する秒数。デフォルト値は 1 です。span および interval パラメータが指定された場合、seconds パラメータは無視されます。
span
サンプルデータを収集する期間 (minute、hour、day、week、month、または year)。
granularity
指定された期間内での粒度 (minute、hour、day、week、month、または year)。その粒度からデータポイントの平均が示されます。

start パラメータを指定しなかった場合、指定されたサンプルデータの seconds の数を現在時間から引いた値に、開始時間が設定されます。開始時間は未来にすることができません。データを収集する秒数が現在の時間を過ぎてしまう場合、サーバーはデータを返す前に各サンプルを待機します。

粒度データを取得するには、パラメータ span と interval の組み合わせを使用します。span と granularity が使用された場合、seconds パラメータは無視されます。span または granularity が正しく入力されない場合、そのリクエストは無視され、代わりに seconds パラメータが使用されます。不適切な、つまりサポートされないリクエストを入力した場合、「Input span and granularity are not supported.」というエラーメッセージが表示されます。

次のリストでは、span および granularity パラメータの組み合わせ方法について説明します。

  • span が minute の場合、granularity には minute のみを指定できます。

  • span が hour の場合、granularity には minute または hour を指定できます。

  • span が day の場合、granularity には minute、hour、または day を指定できます。

  • span が week の場合、granularity には hour、day、または week を指定できます。

  • span が month の場合、granularity には day、week、または month を指定できます。

  • span が year の場合、granularity には week、month、または year を指定できます。

次の表に、返されるデータセットデータのプロパティーを示します。

プロパティー
説明
startTime
返される最初のサンプルの時間
sample
返される最初のサンプルのサンプルインデックス
data
サンプルデータの配列
min
指定された粒度内での 1 秒あたりの最小値
max
指定された粒度内での 1 秒あたりの最大値

startTime プロパティーは次のいずれかの形式になります。

  • ISO 8601 の日時文字列 (例: 20130531T01:13:58)

  • サンプルのインデックス番号

  • 文字列リテラル「now」

3 秒分のライブデータを収集するリクエストの例:

GET /api/analytics/v1/datasets/nfs4.ops%5Bfile%5D/data?start=now&seconds=3 HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: zfs-storage.example.com:215
Accept: text/x-yaml

結果の例:

HTTP/1.1 200 OK
Content-Type: text/x-yaml
X-Zfssa-Analytics-Api: 1.0
Transfer-Encoding: chunked

---
data:
  - sample: 239024557
    data:
        value:      5
    startTime:      20130912T21:42:38
    samples:        239024558

  - sample: 239024558
    data:
        value:      15
    startTime:      20130912T21:42:39
    samples:        239024559

  - sample: 239024559
    data:
        value:      25
    startTime:      20130912T21:42:40
    samples:        239024560

size:       3
---

1 週間の期間内に 7 日分のライブデータを収集するリクエストの例:

GET /api/analytics/v1/datasets/nfs4.ops%5Bfile%5D/data?start=239024557&span=week&granularity=day
    HTTP/1.1 
Authorization: Basic ab6rt4psMWE= 
Host: zfs-storage.example.com:215
Accept: text/x-yaml

結果の例:

HTTP/1.1 200 OK
Content-Type: text/x-yaml
X-Zfssa-Analytics-Api: 1.0
Transfer-Encoding: chunked

---
data:   
  - sample: 239024557     
    data:        
       value:      5     
    max:        79     
    min:        0
    startTime:      20130912T21:42:38     
    samples:        240074328
 
  - sample: 239110957     
    data:         
        value:      15
     max:        150     
     min:        1    
     startTime:      20130913T21:42:38     
     samples:        240074328

    ... 

   - sample: 239629357     
     data:         
         value:      25
     max:        120     
     min:        2    
     startTime:      20130914T21:42:38     
     samples:        240074328

size:       7
Copyright © 2014, 2018, Oracle and/or its affiliates. All rights reserved.  
前へ
次へ