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 服务

硬件服务

群集

获取群集属性

获取群集资源

修改群集资源

群集命令

群集链路

设置群集

机箱

列出机箱

获取机箱组件

获取硬件组件

修改组件属性

日志命令

网络命令

RESTful API 问题服务

RESTful API 角色服务

RESTful API SAN 服务

服务命令

RESTful API 存储服务

系统命令

RESTful API 用户服务

工作流命令

RESTful 客户机

机箱

硬件命令用于获取设备硬件机箱和组件的列表。

请求
路径 /hardware/v1.0
描述
GET
/chassis
列出硬件机箱
GET
/chassis/<chassis>
获取指定的硬件机箱属性
PUT
/chassis/<chassis>
修改指定的硬件机箱属性
GET
/chassis/<chassis>/<fru_type>
列出硬件机箱组件
GET
/chassis/<chassis>/<fru_type> /<fru>
获取指定的机箱组件属性
PUT
/chassis/<chassis>/<fru_type> /<fru>
修改硬件机箱组件属性

列出机箱

get 机箱命令不会使用任何参数,会返回系统机箱对象的列表。命令成功执行后,将返回 HTTP 状态 200 (OK)。

类型
属性
描述
字符串
name
机箱名称
字符串
model
机箱型号
字符串
manufacturer
机箱制造商
字符串
serial
机箱序列号
字符串
revision
机箱修订级别
字符串
part
机箱更换部件号
布尔型
faulted
故障指示灯
字符串
fru
机箱的 FMRI 表示形式
字符串
uuid
机箱 uuid 标识符

请求示例:

GET /api/hardware/v1/chassis HTTP/1.1
Host: zfs-storage.example.com:215
Accept: application/json

响应示例:

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

{
    "hardware": [{
        "faulted": false,
        "href": "/api/hardware/v1/chassis/chassis-000",
        "manufacturer": "Oracle",
        "model": "Oracle ZFS Storage ZS3-1",
        "name": "cairo",
        "rpm": "--",
        "serial": "1211FM200C",
        "type": "system"
    }, {
        "faulted": false,
        "href": "/api/hardware/v1/chassis/chassis-001",
        "locate": false,
        "manufacturer": "Oracle",
        "model": "Oracle Storage DE2-24C",
        "name": "1235FM4002",
        "part": "7046842",
        "path": 2,
        "revision": "0010",
        "rpm": 7200,
        "serial": "1235FM4002",
        "type": "storage"
    }, {
        "faulted": false,
        "href": "/api/hardware/v1/chassis/chassis-002",
        "locate": false,
        "manufacturer": "Oracle",
        "model": "Oracle Storage DE2-24P",
        "name": "50050cc10c206b96",
        "part": "7046836",
        "path": 2,
        "revision": "0010",
        "rpm": 10000,
        "serial": "50050cc10c206b96",
        "type": "storage"
    }]
}

获取机箱组件

此命令返回指定机箱中的所有硬件组件。命令成功执行后,将返回 HTTP 状态 200 (OK)。

请求示例:

GET /api/nas/v1/chassis/chassis-001 HTTP/1.1
Host: zfs-storage.example.com
Accept: application/json

响应示例:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "chassis": {
        "type": "storage"
        "faulted": false,
        "href": "/api/hardware/v1/chassis/chassis-001",
        "locate": false,
        "manufacturer": "Oracle",
        "model": "Oracle Storage DE2-24C",
        "name": "1235FM4002",
        "part": "7046842",
        "path": 2,
        "revision": "0010",
        "rpm": 7200,
        "serial": "1235FM4002",
        "disk": [{
            "device": "c0t5000CCA01A76A2B8d0",
            "faulted": false,
            "href": "/api/hardware/v1/chassis/chassis-001/disk/disk-000",
            "interface": "SAS",
            "label": "HDD 0",
            "locate": false,
            "manufacturer": "HITACHI",
            "model": "H7230AS60SUN3.0T",
            "pathcount": 4,
            "present": true,
            "revision": "A310",
            "rpm": 7200,
            "serial": "001210R37LVD        YHJ37LVD",
            "size": 3000592982016,
            "type": "data",
            "use": "peer"
        }, {
            "href": "/api/hardware/v1/chassis/chassis-001/disk/disk-001",
            ...
        }, {
            "href": "/api/hardware/v1/chassis/chassis-001/disk/disk-002",
            ...
        },  ...  {
            "href": "/api/hardware/v1/chassis/chassis-001/disk/disk-023",
             ...
        }],
    "fan": [
        {
            "href": "/api/hardware/v1/chassis/chassis-001/fan/fan-000",
            ...
        },  ...  {
            "href": "/api/hardware/v1/chassis/chassis-001/fan/fan-007",
        }],
    "psu": [
        {
            "href": "/api/hardware/v1/chassis/chassis-001/psu/psu-000",
            ...
        }, {
            "href": "/api/hardware/v1/chassis/chassis-001/psu/psu-001",
        }, {
            "href": "/api/hardware/v1/chassis/chassis-001/psu/psu-002",
        }, {
            "href": "/api/hardware/v1/chassis/chassis-001/psu/psu-003",
        }],
    "slot": [{
            "href": "/api/hardware/v1/chassis/chassis-001/slot/slot-000",
        }, {
            "href": "/api/hardware/v1/chassis/chassis-001/slot/slot-001",
        }],
    }
}

获取硬件组件

此命令返回单个硬件组件中的属性。命令成功执行后,将返回 HTTP 状态 200 (OK)。响应对象包含下表中包含的组件属性。

类型
名称
描述
字符串
device
FRU 设备 ID
布尔型
faulted
此标志指示 FRU 是否发生故障
字符串
fru
FRU 的 FMRI 表示形式
字符串
interface
FRU 接口类型
字符串
label
FRU 位置标签
布尔型
locate
标志上的定位指示灯
字符串
manufacturer
FRU 制造商
字符串
model
FRU 型号
字符串
part
FRU 部件号
布尔型
present
FRU 线上状态指示灯
数字
rpm
磁盘片的 RMP(仅适用于磁盘)
字符串
serial
FRU 序列号
数字
size
FRU 大小(容量)
字符串
type
组件类型
字符串
use
组件使用情况枚举

请求示例:

GET /api/hardware/v1/chassis/chassis-001/disk/disk-011 HTTP/1.1
Host: zfs-storage.example.com
Accept: application/json

响应示例:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "disk": {
        "device": "c0t5000CCA01A764FB0d0",
        "faulted": false,
        "href": "/api/hardware/v1/chassis/chassis-001/disk/disk-011",
        "interface": "SAS",
        "label": "HDD 11",
        "locate": false,
        "manufacturer": "HITACHI",
        "model": "H7230AS60SUN3.0T",
        "pathcount": 4,
        "present": true,
        "revision": "A310",
        "rpm": 7200,
        "serial": "001210R322ED        YHJ322ED",
        "size": 3000592982016,
        "type": "data",
        "use": "peer"
    }
}

修改组件属性

可使用 PUT 请求在选定硬件组件上设置属性。成功的请求会返回 HTTP 状态 201 (Accepted) 以及使用 JSON 格式的组件属性。

请求示例:

PUT /api/hardware/v1/chassis/chassis-001/disk/disk-011 HTTP/1.1
Host: zfssa.example.com:215
X-Auth-User: root
X-Auth-Key: letmein
Accept: application/json
Content-Type: application/json
Content-Length: 16

{"locate": true}

JSON 响应示例:

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

{
    "disk": {
        "href": "/api/hardware/v1/chassis/chassis-001/disk/disk-011",
        ...,
        "locate": true
    }
}