Go to main content

Oracle® ZFS Storage Appliance RESTful API 指南,发行版 OS8.8.0

退出打印视图

更新时间: 2018 年 11 月
 
 

机箱

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

表 29  硬件命令
请求
附加到路径 /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
string
机箱名称
model
string
机箱型号
manufacturer
string
机箱制造商
serial
string
机箱序列号
revision
string
机箱修订级别
part
string
机箱更换部件号
type
string
机箱存储类型
faulted
boolean
故障指示灯
fru
string
机箱的 FMRI 表示形式
uuid
string
机箱 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
string
FRU 设备 ID
faulted
boolean
此标志指示 FRU 是否发生故障
fru
string
FRU 的 FMRI 表示形式
interface
string
FRU 接口类型
label
string
FRU 位置标签
locate
boolean
标志上的定位指示灯
manufacturer
string
FRU 制造商
model
string
FRU 型号
part
string
FRU 部件号
present
boolean
FRU 线上状态指示灯
rpm
number
磁盘片的 RMP(仅适用于磁盘)
serial
string
FRU 序列号
size
number
FRU 大小(容量)
type
string
组件类型
use
string
组件使用情况枚举

请求示例:

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: zfs-storage.example.com:215
X-Auth-User: root
X-Auth-Key: password
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
    }
}