/pools/

List pools

请求参数

Query 参数

limit

integer

可选

paging param

offset

integer

可选

paging param

all

string

可选

show all pools

protection_domain_id

integer

可选

protection domain id

cluster_id

string

可选

cluster id

compound_osd_only

string

可选

filter pool with only compound osds

osd_group_id

integer

可选

osd group id

pool_type

string

可选

filter pool by type

pool_role

string

可选

filter pool by role

pool_mode

string

可选

filter pool by pool_mode

stretched

string

可选

filter stretched pool

with_compound

string

可选

with compound pool

is_cache

string

可选

list cache pool

os_policy_id

integer

可选

filter data pool by object storage policy id

storage_class_id

integer

可选

filter data pool by os storage class id

storage_class_pool_type

string

可选

storage class pool type(active inactive) to query

string

可选

query param of search

sort

string

可选

sort param of search

Header 参数

x-sddc-token

string

可选

默认值:

78ce2df0c80e4b10a28c7779af4dc10f

返回响应

🟢200OK

application/json

Body

paging

object (Paging contains result of pagination.)

可选

count

integer <int64>

可选

duration

integer <int64>

可选

duration_begin

string <date-time>

可选

duration_end

string <date-time>

可选

limit

integer <int64>

可选

string

可选

offset

integer <int64>

可选

period

string

可选

total_count

integer <int64>

可选

truncated

boolean

可选

pools

array[null (PoolRecord) {2}]

pools

必需

object (Pool)

可选

A pool consists of many OSDs to provide storage capacity for objects

object

可选

示例

{
    "paging": {
        "count": 0,
        "duration": 0,
        "duration_begin": "2019-08-24T14:15:22Z",
        "duration_end": "2019-08-24T14:15:22Z",
        "limit": 0,
        "next": "string",
        "offset": 0,
        "period": "string",
        "total_count": 0,
        "truncated": true
    },
    "pools": [
        {
            "action_status": "string",
            "allocated_size": 0,
            "bind_osd_num": 0,
            "block_volume_num": 0,
            "cache_pool": {
                "id": 0,
                "name": "string",
                "status": "string"
            },
            "cluster": {
                "fs_id": "string",
                "id": 0,
                "name": "string"
            },
            "coding_chunk_num": 0,
            "compress_algorithm": "string",
            "compressed": true,
            "create": "2019-08-24T14:15:22Z",
            "data_chunk_num": 0,
            "data_pool": {
                "id": 0,
                "name": "string",
                "status": "string"
            },
            "default_managed_volume_format": 0,
            "device_type": "string",
            "device_type_check_disabled": true,
            "failure_domain_type": "string",
            "gc_policy": {
                "enable": true,
                "id": 0,
                "reserve_ratio": 0,
                "scan": true,
                "scan_water": 0,
                "stop_decrement": 0,
                "throttle_bandwidth_base": 0,
                "throttle_bandwidth_step": 0,
                "water_level": 0
            },
            "hidden": true,
            "id": 0,
            "inner_pool_id": 0,
            "io_bypass_enabled": true,
            "io_bypass_threshold": 0,
            "min_alloc_size": 0,
            "min_osd_num": 0,
            "name": "string",
            "osd_group": {
                "id": 0
            },
            "osd_num": 0,
            "osd_num_per_host": 0,
            "out_failure_domain_num": 0,
            "pool_id": 0,
            "pool_mode": "string",
            "pool_name": "string",
            "pool_role": "string",
            "pool_type": "string",
            "primary_placement_node": {
                "id": 0,
                "parent": {
                    "create": "2019-08-24T14:15:22Z",
                    "id": 0,
                    "name": "string",
                    "parent": {
                        "create": "2019-08-24T14:15:22Z",
                        "id": 0,
                        "name": "string",
                        "parent": {},
                        "properties": {
                            "is_witness": true
                        },
                        "type": "string",
                        "update": "2019-08-24T14:15:22Z"
                    },
                    "properties": {
                        "is_witness": true
                    },
                    "type": "string",
                    "update": "2019-08-24T14:15:22Z"
                }
            },
            "product_type": "string",
            "property": {
                "async_recovery_max_updates": 0,
                "cache_target_dirty_ratio": 0,
                "cache_target_full_ratio": 0,
                "enable_transport": true,
                "hit_set_count": 0,
                "hit_set_period": 0,
                "hit_set_type": "string",
                "min_read_recency_for_promote": 0,
                "osd_full_ratio": 0,
                "osd_omap_backfillfull_ratio": 0,
                "osd_omap_full_ratio": 0,
                "osd_omap_nearfull_ratio": 0,
                "scrub_begin": "string",
                "scrub_end": "string",
                "target_max_bytes": 0
            },
            "protection_domain": {
                "id": 0,
                "name": "string"
            },
            "qos": {
                "bandwidth": 0,
                "bandwidth_max": 0,
                "client_threshold": 0,
                "id": 0,
                "mode": 0,
                "recovery_rate_type": "string"
            },
            "replicate_size": 0,
            "reserved_percent": 0,
            "size_per_osd": 0,
            "status": "string",
            "stretched": true,
            "suggested_omap_size": 0,
            "thin_provisioned": true,
            "tier_status": "string",
            "transport_mode": "string",
            "update": "2019-08-24T14:15:22Z",
            "samples": [
                {
                    "actual_kbyte": 0,
                    "compress_ratio": 0,
                    "create": "2019-08-24T14:15:22Z",
                    "creating_num": 0,
                    "data_kbyte": 0,
                    "degraded_num": 0,
                    "degraded_percent": 0,
                    "error_kbyte": 0,
                    "garbage_ratio": 0,
                    "healthy_num": 0,
                    "healthy_percent": 0,
                    "min_garbage_kbyte": 0,
                    "omap_total_kbyte": 0,
                    "omap_used_kbyte": 0,
                    "omap_used_percent": 0,
                    "read_bandwidth_kbyte": 0,
                    "read_iops": 0,
                    "read_latency_us": 0,
                    "recovery_bandwidth_kbyte": 0,
                    "recovery_iops": 0,
                    "recovery_num": 0,
                    "recovery_percent": 0,
                    "recovery_remain_second": 0,
                    "remove_bandwidth_kbyte": 0,
                    "remove_iops": 0,
                    "snap_kbyte": 0,
                    "total_bandwidth_kbyte": 0,
                    "total_iops": 0,
                    "total_kbyte": 0,
                    "unavailable_num": 0,
                    "unavailable_percent": 0,
                    "used_kbyte": 0,
                    "used_percent": 0,
                    "water_level": 0,
                    "write_bandwidth_kbyte": 0,
                    "write_cache_kbyte": 0,
                    "write_iops": 0,
                    "write_latency_us": 0
                }
            ]
        }
    ]
}

🟠400BadRequest

🔴500InternalServerError

请求参数

示例代码

返回响应