Volume instance

GET

/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/{VolumeId}

Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.

Privilege: Login

Request

Authorization

API Key

Add parameter in header

X-Auth-Token

Example:

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

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

Responses

🟢200成功

application/json

The response contains a representation of the Volume resource

Bodyapplication/json

🔴500服务器错误

Request Example

Shell

JavaScript

Java

Swift

curl --location '/redfish/v1/Systems//Storage//Volumes/' \
--header 'X-Auth-Token: <api-key>' \
--header 'Authorization: Basic <encoded-value>'

Response Example

200 - 成功示例

{
    "@Redfish.Settings": {
        "@odata.context": "/redfish/v1/$metadata#Settings.Settings",
        "@odata.type": "#Settings.v1_4_0.Settings",
        "SettingsObject": {
            "@odata.id": "/redfish/v1/Systems/System.Embedded.1/Storage/BOSS.Slot.6-1/Volumes/Disk.Direct.1-1:BOSS.Slot.6-1/Settings"
        },
        "SupportedApplyTimes": [
            "Immediate",
            "OnReset"
        ]
    },
    "@odata.context": "/redfish/v1/$metadata#Volume.Volume",
    "@odata.id": "/redfish/v1/Systems/System.Embedded.1/Storage/BOSS.Slot.6-1/Volumes/Disk.Direct.1-1:BOSS.Slot.6-1",
    "@odata.type": "#Volume.v1_10_2.Volume",
    "Actions": {
        "#Volume.CheckConsistency": {
            "@Redfish.OperationApplyTime@Redfish.AllowableValues": [
                "Immediate",
                "OnReset"
            ],
            "@Redfish.OperationApplyTimeSupport": {
                "@odata.type": "#Settings.v1_4_0.OperationApplyTimeSupport",
                "SupportedValues": [
                    "Immediate",
                    "OnReset"
                ]
            },
            "target": "/redfish/v1/Systems/System.Embedded.1/Storage/BOSS.Slot.6-1/Volumes/Disk.Direct.1-1:BOSS.Slot.6-1/Actions/Volume.CheckConsistency"
        },
        "#Volume.Initialize": {
            "@Redfish.OperationApplyTime@Redfish.AllowableValues": [
                "Immediate",
                "OnReset"
            ],
            "@Redfish.OperationApplyTimeSupport": {
                "@odata.type": "#Settings.v1_4_0.OperationApplyTimeSupport",
                "SupportedValues": [
                    "Immediate",
                    "OnReset"
                ]
            },
            "InitializeType@Redfish.AllowableValues": [
                "Fast",
                "Slow"
            ],
            "target": "/redfish/v1/Systems/System.Embedded.1/Storage/BOSS.Slot.6-1/Volumes/Disk.Direct.1-1:BOSS.Slot.6-1/Actions/Volume.Initialize"
        }
    },
    "BlockSizeBytes": 512,
    "CapacityBytes": 480103981056,
    "Description": "Disk 1 on BOSS in Slot 6",
    "DisplayName": null,
    "Encrypted": null,
    "EncryptionTypes": [],
    "Id": "Disk.Direct.1-1:BOSS.Slot.6-1",
    "Identifiers": [],
    "Links": {
        "Drives": [
            {
                "@odata.id": "/redfish/v1/Systems/System.Embedded.1/Storage/BOSS.Slot.6-1/Drives/Disk.Direct.1-1:BOSS.Slot.6-1"
            }
        ],
        "Drives@odata.count": 1
    },
    "MediaSpanCount": null,
    "Name": "NVMe 1",
    "Operations": [],
    "OptimumIOSizeBytes": null,
    "RAIDType": null,
    "ReadCachePolicy": null,
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "State": "Enabled"
    },
    "VolumeType": "RawDevice",
    "WriteCachePolicy": null
}

Modified at 2026-03-04 06:02:26

Volume instance

CheckConsistency Action