Querying Partition Resource Information

Function

This interface is used to query resource information about a specified partition.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/Partitions/<partition_id>

Request header:

X-Auth-Token: auth_value

Request message body: None

URL Parameters

**Table 1** URL parameters
Parameter	Mandatory/Optional	Description	Value
<partition_id>	Mandatory	ID of a partition resource.	The value can be obtained by querying the partition collection information. The value is a string of 1 to 128 characters, including uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), and underscores (_). The value cannot contain two consecutive periods (..).

Usage Guidelines

The API is developed by default. The function is adapted based on the external storage configuration.

Example

Request:

GET https://10.10.10.10/redfish/v1/Systems/Partitions/mdisk0p8

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#Systems/Partitions/Members/$entity",
    "@odata.id": "/redfish/v1/Systems/Partitions/mdisk0p8",
    "@odata.type": "#MindXEdgePartition.v1_0_0.MindXEdgePartition",
    "Id": "mdisk0p8",
    "Name": "mdisk0p8",
    "CapacityBytes": "7516192768",
    "FreeBytes": "6905237504",
    "Links": [
        {
            "Device": "/redfish/v1/Systems/SimpleStorages/SATA",
            "DeviceName": "/dev/mdisk0",
            "Location": "PCIE3-0"
        }
    ],
    "MountPath": "/var/lib/docker",
    "Primary": false,
    "FileSystem": "ext4",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    }
}

Response code: 200

Output Description

**Table 2** Operation output description
Field	Type	Description
@odata.context	String	OData description of a partition resource model
@odata.id	String	Access path of a partition resource
@odata.type	String	Type of a partition resource
Id	String	ID of a partition resource
Name	String	Name of a partition
CapacityBytes	String	Total capacity of a partition
FreeBytes	String	Remaining free space of a partition
Links	Object	Link information of a partition
Links.Device	String	Device information of a partition
Links.DeviceName	String	Device name of a partition
Links.Location	String	Device location
Primary	Boolean	Whether the partition is a primary partition (system partition)
FileSystem	String	File system format
MountPath	String	Partition mount path
Status	Object	Logical drive status. The options are as follows: Health: indicates the health status of the logical drive. State: indicates whether a logical drive is enabled.

Parent topic: Storage Management