Skip to main content
API Explorer|API Explorer
Resource Center/Hardware/Primary Storage Operations
GETPrimary Storage OperationsSince 0.6SynchronousAuth Required

GetPrimaryStorageCapacity

GetPrimaryStorageCapacity

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • zoneUuidsList

    Optional. The zone UUID list.

  • clusterUuidsList

    Optional. The cluster UUID list.

  • primaryStorageUuidsList

    Optional. The primary storage UUID list.

  • allboolean

    Optional. When the primary storage UUID list is null, the field is true, which means that all primary storages in the system will be queried.

  • systemTagsList

    Optional. The system tags.

Responses

200 OK

On success, this API returns the following response structure.

  • totalCapacitylongRequired

    总容量。

  • availableCapacitylongRequired

    可用容量。

  • totalPhysicalCapacitylongRequired

    总物理容量。

  • availablePhysicalCapacitylongRequired

    可用物理容量。

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

Endpoint

GET/zstack/v1/primary-storage/capacities

/zstack/v1/primary-storage/capacities

Operation ID

GetPrimaryStorageCapacity

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/primary-storage/capacities?zoneUuids=<zoneUuids>&clusterUuids=<clusterUuids>&primaryStorageUuids=<primaryStorageUuids>&all=True&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "totalCapacity": 1.073741824E9, "availableCapacity": 9.73078528E8, "totalPhysicalCapacity": 1.073741824E9, "availablePhysicalCapacity": 9.73078528E8 }

Change History

This API has no change history records yet.

View all change history