---
title: "GET /v1beta/{tenantId}/pools/{poolId}"
method: GET
path: "/v1beta/{tenantId}/pools/{poolId}"
tags: ["Pool"]
---

# GET /v1beta/{tenantId}/pools/{poolId}

`GET /v1beta/{tenantId}/pools/{poolId}`

Gets storage pool detail by pool ID.

## Response `200`

OK

- StoragePoolSpec — A pool is discoveried and updated by a dock service. Each pool can be regarded as a physical storage pool or a virtual storage pool. It is a logical and atomic pool and can be abstracted from any storage platform.
  - `id` string
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `name` string, required
  - `storageType` 'block' | 'file' | 'object'
  - `description` string
  - `multiAttach` boolean
  - `status` 'available' | 'unavailable', required
  - `availabilityZone` string, required
  - `totalCapacity` integer, required
  - `freeCapacity` integer, required
  - `dockId` string, required
  - `extras` StoragePoolExtraSpec — StoragePoolExtraSpec object represents the extra properties of the pool, such as supported capabilities.
    - `dataStorage` DataStorageLoS — DataStorageLoS can be used to describe a service option covering storage provisioning and availability.
      - `recoveryTimeObjective` integer — Recovery Time Objective(RTO) is a maximum acceptable time within which storage must be restored after disaster. For e.g 10 sec.
      - `provisioningPolicy` 'Thin' | 'Thick' — The provisioning policy of the pool. It can be thick or thin.
      - `compression` boolean — The optimization policy to reduce the number of data bits to save storage space
      - `deduplication` boolean — The optimization policy to remove redundant data or file on the storage
      - `characterCodeSet` string — The code set to store the data
      - `maxFileNameLengthBytes` integer — The maximum filename length in bytes
      - `storageAccessCapability` string[] — The type of access capability. This can be set of read,write or execute.
    - `ioConnectivity` IOConnectivityLoS — IOConnectivityLoS can be used to specify the characteristics of storage connectivity.
      - `accessProtocol` 'iscsi' | 'rbd' | 'fibre_channel' | 'nvmeof' | 'DSWare' | 'NFS' — The type of access protocol. This can be iscsi, rbd, fibre channel, or DSWare(Data Service Middleware), nvmeof and nfs
      - `maxIOPS` integer — The maximum IOPS(Input/Output Operations Per Second) supported by storage. For e.g. 150IOPS
      - `minIOPS` integer — The minimum IOPS(Input/Output Operations Per Second) supported by storage. In other words, performance can not drop below this level. For e.g. 50IOPS
      - `maxBWS` integer — The maximum bandwidth supported by storage. For e.g. 5mbps
      - `minBWS` integer — The minimum bandwidth supported by storage. In other words, performance can not drop below this level. For e.g. 1mbps
      - `latency` integer — The latency of the storage in ns(nanosec.). For e.g. 1ns
    - `dataProtection` DataProtectionLoS — DataProtectionLoS describes a replica that protects data from loss. The requirements must be met collectively by the communication path and the replica.
      - `isIsolated` boolean — Isolated storage is designed to prevent data corruption and data loss
      - `minLifetime` string — It is an ISO 8601 duration that specifies the minimum lifetime required for the replica
      - `RecoveryGeographicObjective` 'Datacenter' | 'Rack' | 'RackGroup' | 'Region' | 'Row' | 'Server' — Supported failure domain from where data can be restored after disaster
      - `RecoveryPointObjectiveTime` string — It's an ISO 8601 time interval that specifies the maximum source information that may be lost on failure. In the case of isIsolated = false, failure of the domain is not considered.
      - `RecoveryTimeObjective` 'OnlineActive' | 'OnlinePassive' | 'Nearline' | 'Offline' — It specifies the relative time required to make a replica available as a source
      - `ReplicaType` 'Clone' | 'Mirror' | 'Snapshot' | 'TokenizedClone' — This value specify the type of replica
    - `customProperties` object

## Other responses

- `401` — NotAuthorized
- `403` — Forbidden
- `404` — The resource does not exist
- `500` — An unexpected error occured.

---

[API](https://skmtc.net/sodafoundation/apis/soda-api.md) · [All operations](https://skmtc.net/sodafoundation/apis/soda-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sodafoundation/soda-api/versions/62ce0f6c94b4/schema)