Skip to main content
ZStack
Resource Center/Hardware/Primary Storage Operations/Ceph Primary Storage Operations

QueryCephPrimaryStoragePool

QueryCephPrimaryStoragePool

GET/zstack/v1/primary-storage/ceph/pools
GET/zstack/v1/primary-storage/ceph/pools/{uuid}

Operation ID

QueryCephPrimaryStoragePool

Since

0.6

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

  • q
    String

    Query conditions.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

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

    • code
      StringRequired

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

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

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

  • inventories
    ListRequired

    See inventories.

    • uuid
      StringRequired

      The resource UUID.

    • primaryStorageUuid
      StringRequired

      The UUID of the Ceph primary storage.

    • poolName
      StringRequired

      The pool name.

    • aliasName
      StringRequired

      The alias name.

    • description
      StringRequired

      The detailed description of the resource.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

    • type
      StringRequired

      The resource type.

    • usedCapacity
      LongRequired

      The used capacity.

    • replicatedSize
      IntegerRequired

      The replicated size.

    • availableCapacity
      LongRequired

      The available capacity.