---
title: "Display Pool List"
method: GET
path: "/api/pool"
tags: ["Pool"]
---

# Display Pool List

`GET /api/pool`

## Query parameters

- `attrs` string
- `stats` boolean

## Response `200`

OK

- object[]
  - `application_metadata` string[]
  - `auid` integer
  - `cache_min_evict_age` integer
  - `cache_min_flush_age` integer
  - `cache_mode` string
  - `cache_target_dirty_high_ratio_micro` integer
  - `cache_target_dirty_ratio_micro` integer
  - `cache_target_full_ratio_micro` integer
  - `create_time` string
  - `crush_rule` string
  - `erasure_code_profile` string
  - `expected_num_objects` integer
  - `fast_read` boolean
  - `flags` integer
  - `flags_names` string — flags name
  - `grade_table` string[]
  - `hit_set_count` integer
  - `hit_set_grade_decay_rate` integer
  - `hit_set_params` object
    - `type` string, required
  - `hit_set_period` integer
  - `hit_set_search_last_n` integer
  - `last_change` string
  - `last_force_op_resend` string
  - `last_force_op_resend_preluminous` string
  - `last_force_op_resend_prenautilus` string
  - `last_pg_merge_meta` object
    - `last_epoch_clean` integer, required
    - `last_epoch_started` integer, required
    - `ready_epoch` integer, required
    - `source_pgid` string, required
    - `source_version` string, required
    - `target_version` string, required
  - `min_read_recency_for_promote` integer
  - `min_size` integer
  - `min_write_recency_for_promote` integer
  - `object_hash` integer
  - `options` object
    - `pg_num_max` integer, required
    - `pg_num_min` integer, required
  - `pg_autoscale_mode` string
  - `pg_num` integer
  - `pg_num_pending` integer
  - `pg_num_target` integer
  - `pg_placement_num` integer
  - `pg_placement_num_target` integer
  - `pool` integer — pool id
  - `pool_name` string — pool name
  - `pool_snaps` string[]
  - `quota_max_bytes` integer
  - `quota_max_objects` integer
  - `read_tier` integer
  - `removed_snaps` string[]
  - `size` integer — pool size
  - `snap_epoch` integer
  - `snap_mode` string
  - `snap_seq` integer
  - `stripe_width` integer
  - `target_max_bytes` integer
  - `target_max_objects` integer
  - `tier_of` integer
  - `tiers` string[]
  - `type` string — type of pool
  - `use_gmt_hitset` boolean
  - `write_tier` integer

## Other responses

- `400` — Operation exception. Please check the response body for details.
- `401` — Unauthenticated access. Please login first.
- `403` — Unauthorized access. Please check your permissions.
- `500` — Unexpected error. Please check the response body for the stack trace.

---

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