JavaScript is required to for searching.
跳过导航链接
退出打印视图
Oracle® ZFS Storage Appliance RESTful API 指南,发行版 2013.1.3.0
Oracle 技术网
文档库
PDF
打印视图
反馈
search filter icon
search icon

文档信息

Oracle ZFS Storage Appliance RESTful API 入门

使用 RESTful API

RESTful API 警报服务

Analytics 服务

可用的 Analytics 服务

Analytics 设置

获取设置

修改设置

Analytics 工作表

列出工作表

获取 Analytics 工作表

创建工作表

销毁工作表

列出工作表数据集

添加工作表数据集

修改工作表数据集

Analytics 数据集

列出数据集

获取数据集

创建数据集

修改数据集

销毁数据集

保存数据集

删改数据集数据

获取数据集数据

硬件服务

日志命令

网络命令

RESTful API 问题服务

RESTful API 角色服务

RESTful API SAN 服务

服务命令

RESTful API 存储服务

系统命令

RESTful API 用户服务

工作流命令

RESTful 客户机

Analytics 数据集

表 4-1  数据集属性
名称
描述
name
底层统计信息的名称
grouping
此统计信息的所属组
explanation
底层统计信息的说明
incore
内核中的数据集数据的字节数
size
磁盘上的数据集数据的字节数
suspended
指示数据集当前是否处于挂起状态的布尔值
activity
待定数据集活动标志

所有属性都不可变,suspended 除外。

可用数据集:

列出数据集

列出所有配置的 Analytic 数据集。

请求示例:

GET /api/analytics/v1/datasets 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

{
    "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: 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

{
    "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: letmein
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
删改粒度(秒、分钟、小时)
endtime
删改给定 endtime 之前收集的数据

endtime 是 ISO 8601 时间/日期字符串(例如 20130531T01:13:58)

请求示例:

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

响应示例:

HTTP/1.1 204 No Content

获取数据集数据

从 Analytic 数据集获取数据。

名称
描述
start
开始收集示例数据的时间
seconds
收集样例数据的秒数(默认值 = 1)

startTime 可以是以下类型之一:

如果未提供 start,start 将设置为当前时间减去样例数据所需的秒数。start 时间不能是将来时间。如果收集数据所需的秒数超过了当前时间,服务器将等待各个样例,然后再返回数据。

名称
描述
startTime
返回的第一个样例的时间
sample
返回的第一个样例的样例索引
data
样例数据组

请求示例(用于收集 3 秒实时数据):

GET /api/analytics/v1/datasets/nfs4.ops%5Bfile%5D/data?start=now&seconds=3
    HTTP/1.1
Authorization: Basic ab6rt4psMWE=
Host: example.zfssa.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
---