VolumesCollection
更新时间: 2026/06/09
在Gitcode上查看源码

ResourceDefinition

uris

  • /redfish/v1/Systems/system_id/Storages/storage_id/Volumes

properties

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-逻辑盘集合资源模型的OData描述信息
@odata.idstringtrue-逻辑盘集合资源的访问路径
@odata.typestringtrue-逻辑盘集合资源的类型
Namestringtrue-逻辑盘集合资源的名称
Members@odata.countnumbertrue-当前逻辑盘资源数量
@odata.idstringtrue-单个逻辑盘资源节点的访问路径

supported_methods

  • GET
  • POST

HTTP methods

GET

命令功能

查询逻辑盘集合资源信息

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes

请求头:


X-Auth-Token: 123456789***********************

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
system_id系统资源的ID参见源文件参数说明
auth_value请求消息的鉴权参数可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

使用实例

请求样例:

http
GET https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes

X-Auth-Token: 123456789***********************

请求消息体:无

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Storages/Members/RAIDStorage0/Volumes/$entity",
  "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes",
  "@odata.type": "#VolumeCollection.VolumeCollection",
  "Name": "Volume Collection",
  "Members@odata.count": 3,
  "Members": [
    {
      "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0"
    },
    {
      "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive1"
    },
    {
      "@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive2"
    }
  ]
}

响应码:200

POST (CREATE)

命令功能

创建逻辑盘

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes

请求头:


X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json
{
  "CapacityBytes": capacity,
  "OptimumIOSizeBytes": optsize,
  "ReadCachePolicy": readcachepolicy,
  "StripSizeBytes": stripsizebytes,
  "Oem": {
    "Public": {
      "CreateCacheCadeFlag": cachecadeflag,
      "Drives": [
        drives
      ],
      "VolumeRaidLevel": raidlevel,
      "VolumeName": name,
      "DefaultReadPolicy": df_read_policy,
      "DefaultWritePolicy": df_write_policy,
      "DefaultCachePolicy": df_cache_policy,
      "SpanNumber": spnanum,
      "AccessPolicy": access_policy,
      "DriveCachePolicy": disk_cache_policy,
      "InitializationMode": initmode,
      "BlockIndex": blockindex,
      "AssociatedVolumes": [
        {
          "@odata.id": volumepath
        }
      ],
      "AccelerationMethod": acceleration_method,
      "CacheLineSizeKB": cache_line_size
    }
  }
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
system_id系统资源的ID● 针对机架服务器,取值 为1
● 针对高密服务器,取值 为BladeN(N表示节点 槽位号),例如 “Blade1”
● 针对刀片服务器,取值 可以为BladeN(N表示 计算节点槽位号)或 SwiN(N表示交换模块 槽位号),例如 “Swi1”
● 针对X6800 V5,X6000 V5,G5500,XA320 V2服务器,取值还可以 为Enc,表示计算节点 所在的机框资源
● 针对设备U位信息,取 值可以为UN(N表示设 备U位号),例如"U1"
● 针对机柜资源,取值为 Rack
storage_id存储资源的ID表示服务器系统本身的存 储资源,按照控制器划 分:RAIDStorage+控制器 ID
capacity逻辑盘容量,非必选参 数。整数,单位为字节。必须 为1048576(1MB)的整 数倍 说明 创建CacheCade逻辑盘时不 需设置此参数
optsize逻辑盘条带大小,非必选 参数。单位为字节,可设置为:
● 16384
● 32768
● 65536
● 131072
● 262144
● 524288
● 1048576 说明 创建CacheCade逻辑盘时不 需设置此参数
cachecadeflag是否创建为CacheCade逻 辑盘。● 当创建CacheCade逻辑 盘时,必须设置为 “true”
● 当创建非CacheCade逻 辑盘时,为选配参数, 可设置为“false”
readcachepolicy逻辑盘默认的读策略● "Off":关闭预读取功 能
● ReadAhead:使能预读 取功能。控制器可以预 读取顺序数据或预测需 要即将使用到的数据并 存储在Cache中
stripsizebytes逻辑盘条带大小单位为字节,可设置为:
● 65536
● 131072
● 262144
● 524288
● 1048576
drives成员盘列表,为必选参 数。格式为: [disk1,disk2,..., diskN] 说明
● 成员盘的接口类型、存储 介质必须相同。
● 在已存在的驱动器组上添 加逻辑盘时,此处只能填 写可使用的驱动器组任意 一个物理盘的ID。
● 请根据3.3.24 修改指定 控制器资源信息中的查询 到的“DriveID”字段进 行设置。
raidlevel逻辑盘的RAID级别,为必 选参数。● RAID0
● RAID1
● RAID5
● RAID6
● RAID10
● RAID50
● RAID60
● RAID1(ADM)
● RAID10(ADM)
● RAID1Triple
● RAID10Triple 说明
● 创建CacheCade逻辑盘 时,只能配置为RAID0、 RAID1;如果RAID控制 器类型为3152-8i,还可 以配置为RAID5、 RAID10
● 在已存在的驱动器组上添 加逻辑盘时,不需设置此 参数;如果RAID控制器 类型为3152-8i,仍需设 置此参数。
name逻辑盘的名称,非必选参 数。最大长度为15个字节的字 符串 范围:0x20~0x7E对应的 ASCII码 说明 如果RAID控制器类型为 3152-8i,最大长度为64个字 节。
df_read_policy逻辑盘默认的读策略,非 必选参数。● NoReadAhead:关闭 预读取功能
● ReadAhead:使能预读 取功能。控制器可以预 读取顺序数据或预测需 要即将使用到的数据并 存储在Cache中 说明 创建CacheCade逻辑盘时不 需设置此参数。如果RAID控 制器类型为3152-8i,不涉及 此参数。
df_write_policy逻辑盘默认的写策略,非 必选参数。● WriteThrough:当磁盘 子系统接受到所有传输 数据后,控制器将给主 机返回数据传输完成信 号
● WriteBackWithBBU: 在控制器无BBU或BBU 损坏的情况下,控制器 将自动切换到 “WriteThrough”模式
● WriteBack:当控制器 Cache收到所有的传输 数据后,将给主机返回 数据传输完成信号 说明 创建CacheCade逻辑盘时不 可设置为“WriteBack”
df_cache_policy逻辑盘默认的Cache策 略,非必选参数。● CachedIO:所有读和 写均经过RAID控制器 Cache处理。仅在配置 CacheCade 1.1时需要 设置为此参数值,其他 场景不推荐。
● DirectIO:在读、写场 景中的定义不同: – 在读场景中,直接从 物理盘读取数据。 (“DefaultReadPo licy”设置为 “ReadAhead”时 除外,此时读数据经 过RAID控制器的 Cache处理) – 在写场景中,写数据 经过RAID控制器的 Cache处理 (“DefaultWritePo licy”设置为 “WriteThrough” 时除外,此时写数据 不经过RAID控制器 的Cache处理,直接 写入物理盘) 说明 创建CacheCade逻辑盘时不 需设置此参数。如果RAID控 制器类型为3152-8i,不涉及 此参数
spnanum逻辑盘子组个数,非必选 参数。● 创建RAID0/RAID1/ RAID5/RAID6/ RAID1(ADM)/ RAID1Triple时,此参数 为1
● 创建RAID10/RAID50/ RAID60/ RAID10(ADM)/ RAID10Triple时,此参 数可设置为2~8 说明
● 创建CacheCade逻辑盘 时,不需配置此参数
● 在已存在的驱动器组上添 加逻辑盘时,不需设置此 参数。如果RAID控制器 类型为3152-8i,可以设 置此参数。
access_policy逻辑盘的访问策略,非必 选参数。● ReadWrite:可读可写
● ReadOnly:只读访问
● Blocked:禁止访问 说明 创建CacheCade逻辑盘时, 不需配置此参数。如果RAID 控制器类型为3152-8i,不涉 及此参数。
disk_cache_policy成员盘的缓存策略,非必 选参数。● Unchanged:保持默认 的缓存策略。
● Enabled:读写过程中 数据经过物理盘写 Cache,使写性能提 升,但当系统意外掉电 时,如果没有保护机 制,数据会丢失。
● Disabled:读写过程中 数据不经过物理盘写 Cache,当系统意外掉 电时,数据不会丢失。 说明 创建CacheCade逻辑盘时, 不需配置此参数。如果RAID 控制器类型为3152-8i,不涉 及此参数。
initmode逻辑盘初始化模式,非必 选参数。● UnInit:不进行初始 化。
● QuickInit:只把逻辑盘 的首尾10MByte空间进 行全写0操作,随后此 逻辑盘的状态就变为 “Optimal”。
● FullInit:需要把整个逻 辑盘都初始化为0,才 会结束初始化过程,在 此之前逻辑盘状态为 “initialization”。
● RPI:快速奇偶校验初 始化。
● OPO:只有当逻辑盘由 SSD组成时才能启用。 在数据写入SSD之前重 新分配所有使用的块来 优化SSD。
● Front:前台初始化
● Background:后台初 始化 说明 创建CacheCade逻辑盘时不 需设置此参数。
blockindex非必选参数取值来源:指定存储资源 信息中 FreeBlocksSpaceMib的数 组下标
volumepath关联普通逻辑盘的访问路 径可通过查询指定存储资源 获得 例如:"/redfish/v1/ Systems/1/Storages/ RAIDStorage0/Volumes/ LogicalDrive3
acceleration_method加速方法ControllerCache:同时使 用读缓存和写缓存 IOBypass:只有当逻辑盘 由SSD组成时,该选项有 效 None:禁用加速
cache_line_size缓存行大小该值越大,maxCache能够 创建的容量上限越大,可 设置的值有64/256

使用指南

使用实例

请求样例:

http
POST https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes

X-Auth-Token: 123456789***********************

请求消息体:

json
{
  "CapacityBytes": capacity,
  "OptimumIOSizeBytes": optsize,
  "ReadCachePolicy": readcachepolicy,
  "StripSizeBytes": stripsizebytes,
  "Oem": {
    "Public": {
      "CreateCacheCadeFlag": cachecadeflag,
      "Drives": [
        drives
      ],
      "VolumeRaidLevel": raidlevel,
      "VolumeName": name,
      "DefaultReadPolicy": df_read_policy,
      "DefaultWritePolicy": df_write_policy,
      "DefaultCachePolicy": df_cache_policy,
      "SpanNumber": spnanum,
      "AccessPolicy": access_policy,
      "DriveCachePolicy": disk_cache_policy,
      "InitializationMode": initmode,
      "BlockIndex": blockindex,
      "AssociatedVolumes": [
        {
          "@odata.id": volumepath
        }
      ],
      "AccelerationMethod": acceleration_method,
      "CacheLineSizeKB": cache_line_size
    }
  }
}

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
  "@odata.type": "#Task.v1_0_2.Task",
  "@odata.id": "/redfish/v1/TaskService/Tasks/1",
  "Id": "1",
  "Name": "volume creation task",
  "Description": "",
  "TaskState": "Running",
  "TaskStatus": "OK",
  "StartTime": "2017-01-06T12:57+00:00",
  "Messages": [],
  "PercentComplete": null,
  "Oem": {
    "Public": {
      "TaskPercentage": null
    }
  }
}

响应码:202