查询NVMe设备
Headers
Authorization: OAuth the-session-uuidCurl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/storage-devices/nvme/controllerscurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/storage-devices/nvmecurl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/storage-devices/nvme/controllers/de0f2549ed0130948f14b00916fbf9a0可查询字段
运行CLI命令行工具,输入QueryNvmeTarget并按Tab键查看所有可查询字段以及可跨表查询的资源名。
API返回
返回示例
{
"inventories": [
{
"uuid": "40ab069909633d4293c62f44efb26db8",
"state": "Enabled",
"nvmeLuns": [
{
"nvmeTargetUuid": "40ab069909633d4293c62f44efb26db8",
"nvmeLunHostRefs": [
{
"id": 1,
"nvmeLunUuid": "5690b46050623763a0335e753c347fa1",
"hostUuid": "d6f8a7ff0069304080b345c077c3aeb9",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
],
"name": "nvme-lun-36b083fe000daf018000022905ba35d8f",
"uuid": "5690b46050623763a0335e753c347fa1",
"wwid": "uuid.48daeab7-7f15-405e-8481-7152cb9b0aca",
"wwn": "uuid.48daeab7-7f15-405e-8481-7152cb9b0aca",
"serial": "3d87eca1686c1782",
"type": "disk",
"path": "nvme-uuid.48daeab7-7f15-405e-8481-7152cb9b0aca ",
"size": 5497558138880
}
],
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
]
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 4.6.21 | |
| error | ErrorCode | 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error | 4.6.21 |
| inventories | List | 详情参考inventories | 4.6.21 |
error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 | 4.6.21 |
| description | String | 错误的概要描述 | 4.6.21 |
| details | String | 错误的详细信息 | 4.6.21 |
| elaboration | String | 保留字段,默认为null | 4.6.21 |
| opaque | LinkedHashMap | 保留字段,默认为null | 4.6.21 |
| cause | ErrorCode | 根错误,引发当前错误的源错误,若无原错误,该字段为null | 4.6.21 |
inventories
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标示该资源 | 4.6.21 |
| name | String | 资源名称 | 4.6.21 |
| nqn | String | NVMe限定名称 | 4.6.21 |
| state | String | 状态 | 4.6.21 |
| createDate | Timestamp | 创建时间 | 4.6.21 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.6.21 |
| nvmeLuns | List | 详情参考nvmeLuns | 4.6.21 |
nvmeLuns
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| nvmeTargetUuid | String | 所属NVMe设备UUID | 4.6.21 |
| name | String | 资源名称 | 4.6.21 |
| uuid | String | 资源的UUID,唯一标示该资源 | 4.6.21 |
| wwid | String | 全局唯一标识 | 4.6.21 |
| vendor | String | 供应商 | 4.6.21 |
| model | String | 型号 | 4.6.21 |
| wwn | String | 4.6.21 | |
| serial | String | 序列号 | 4.6.21 |
| type | String | 类型 | 4.6.21 |
| hctl | String | 4.6.21 | |
| path | String | 路径 | 4.6.21 |
| state | String | 状态 | 4.6.21 |
| size | Long | 大小 | 4.6.21 |
| multipathDeviceUuid | String | 多路径设备UUID | 4.6.21 |
| source | String | 磁盘来源,NVMe | 4.6.21 |
| createDate | Timestamp | 创建时间 | 4.6.21 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.6.21 |
| nvmeLunHostRefs | List | 详情参考nvmeLunHostRefs | 4.6.21 |
nvmeLunHostRefs
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| nvmeLunUuid | List | NVme磁盘UUID | 4.6.21 |
| hostUuid | String | 主机UUID | 4.6.21 |
| path | String | 磁盘路径 | 4.6.21 |
| hctl | String | 磁盘HCTL | 4.6.21 |
| createDate | Timestamp | 创建时间 | 4.6.21 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.6.21 |
SDK示例
Java SDK
QueryNvmeTargetAction action = new QueryNvmeTargetAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryNvmeTargetAction.Result res = action.call();Python SDK
QueryNvmeTargetAction action = QueryNvmeTargetAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryNvmeTargetAction.Result res = action.call()