Obtaining a list of volumes

Virtual Storage Platform One SDS Block Virtual Private Storage Administrator Guide

Version
1.17.x
Audience
anonymous
Part Number
MK-24VSP1SDS003-04

The following information can be obtained.

  • dataReductionEffects: Effect of the data reduction function in the volume summary information

  • id: IDs (uuid) of volumes

  • name: Names of volumes

  • nickname: Nicknames of volumes

  • volumeNumber: Numbers of volumes

  • poolId: IDs (uuid) of storage pools

  • poolName: Names of storage pools

  • totalCapacity: Total logical capacity [MiB]

  • usedCapacity: Consumed logical capacity [MiB]

  • numberOfConnectingServers: Number of connected compute nodes

  • numberOfSnapshots: Number of snapshots

  • protectionDomainId: IDs (uuid) of protection domains containing volumes

  • fullAllocated: Whether all the area where user data is written is allocated in advance

  • volumeType: List of volume types (attributes)

  • universalReplicatorAttribute: Attribute of asynchronous remote copy

  • isRemoteCopySupported: Whether the volume is available for asynchronous remote copy

  • statusSummary: Summary of statuses of volumes

  • status: Status of each volume

  • storageControllerId: IDs (uuid) of storage controllers managing volumes

  • snapshotAttribute: Attributes of snapshots

  • snapshotStatus: Statuses of snapshots

  • savingSetting: Setting of the data reduction function

  • savingMode: Processing mode of the data reduction function

  • dataReductionStatus: Status of the data reduction function

  • dataReductionProgressRate: Progress rate of the data reduction function [%]

  • vpsId: ID of the VPS to which volumes belong

  • vpsName: Name of the VPS to which volumes belong

  • qosParam: QoS-related parameter

    • upperLimitForIops: Upper limit for volume performance [IOPS]

    • upperLimitForTransferRate: Upper limit for volume performance [MiB/sec]

    • upperAlertAllowableTime: Alert threshold value for the upper limit of volume performance [sec]

    • upperAlertTime: The last time the upper limit of volume performance was continuously exceeded and the conditions for the alert threshold of the performance upper limit were met (UTC)

  • naaId: NAA ID of the VPS to which volumes belong

  • primaryFaultDomainId: ID of the primary fault domain that originally manages volumes

  • secondaryFaultDomainId: ID of the secondary fault domain that manages volumes when failover from the primary fault domain occurs. (Output only when multiple fault domain configuration is used. For other configuration, null is assumed.)

  • tertiaryFaultDomainId: ID of the fault domain that manages volumes when further failover from the secondary fault domain occurs. (Output only when multiple fault domain configuration is used and the user data protection method is HPEC 4D+2P. In other cases, null is assumed).

  • currentFaultDomainId: ID of the current fault domain that manages volumes

  • isPrimaryFaultDomain: Whether volumes are managed in the same fault domain as the primary fault domain. (Output only when multiple fault domain configuration is used. For other configuration, null is assumed.)

  • nguId:

    (Bare metal)

    • Always null for FC or iSCSI connection
    • NGU ID of volumes for NVMe/TCP connection

    (Cloud) Always null

  • Required role: VpsSecurity, VpsStorage, or VpsMonitor

Obtain a list of volumes.

REST API: GET /v1/objects/volumes

CLI: volume_list