\PoolsApi

All URIs are relative to https://localhost/v1

Method	HTTP request	Description
AddOsdsToPool	Put /pools/{pool_id}/osds
CreatePool	Post /pools/
DeletePool	Delete /pools/{pool_id}
DisableDeviceTypeCheck	Post /pools/{pool_id}:disable-device-type-check
EnableDeviceTypeCheck	Post /pools/{pool_id}:enable-device-type-check
GetPool	Get /pools/{pool_id}
GetPoolPredictions	Get /pools/{pool_id}/predictions
GetPoolSamples	Get /pools/{pool_id}/samples
GetPoolTopology	Get /pools/{pool_id}/topology
ListPools	Get /pools/
RemoveOsdsFromPool	Delete /pools/{pool_id}/osds
ReweightPool	Post /pools/{pool_id}:reweight
SwitchPoolRole	Post /pools/{pool_id}:switch-role
UpdatePool	Patch /pools/{pool_id}

AddOsdsToPool

PoolResp AddOsdsToPool(ctx, poolId, body)

Add osds to pool

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id
body	OsdsAddReq	osd infos

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreatePool

PoolResp CreatePool(ctx, body)

Create pool

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
body	PoolCreateReq	the pool info

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeletePool

PoolResp DeletePool(ctx, poolId, optional)

Delete pool

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
poolId	int64	pool id
force	bool	force delete or not

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DisableDeviceTypeCheck

PoolResp DisableDeviceTypeCheck(ctx, poolId)

Disable device type check when add osd

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnableDeviceTypeCheck

PoolResp EnableDeviceTypeCheck(ctx, poolId)

Enable device type check when add osd

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPool

PoolResp GetPool(ctx, poolId)

get pool

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPoolPredictions

PoolPredictionsResp GetPoolPredictions(ctx, poolId)

get a pool's prediction

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id

Return type

PoolPredictionsResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPoolSamples

PoolSamplesResp GetPoolSamples(ctx, poolId, optional)

get pool's samples

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
poolId	int64	pool id
durationBegin	string	duration begin timestamp
durationEnd	string	duration end timestamp
period	string	samples period

Return type

PoolSamplesResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPoolTopology

PoolTopologyResp GetPoolTopology(ctx, poolId)

get pool topology

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id

Return type

PoolTopologyResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListPools

PoolsResp ListPools(ctx, optional)

List pools

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
limit	int64	paging param
offset	int64	paging param
all	bool	show all pools
protectionDomainId	int64	protection domain id
compoundOsdOnly	bool	filter pool with only compound osds
osdGroupId	int64	osd group id
poolType	string	filter pool by type
poolRole	string	filter pool by role
poolMode	string	filter pool by pool_mode
stretched	bool	filter stretched pool
withCompound	bool	with compound pool
osPolicyId	int64	filter data pool by object storage policy id
storageClassId	int64	filter data pool by os storage class id
storageClassPoolType	string	storage class pool type(active inactive) to query
q	string	query param of search
sort	string	sort param of search

Return type

PoolsResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveOsdsFromPool

PoolResp RemoveOsdsFromPool(ctx, poolId, body)

Remove multiple osds from a pool

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id
body	OsdsRemoveReq	osd infos

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReweightPool

PoolResp ReweightPool(ctx, poolId)

Reweight a pool

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SwitchPoolRole

PoolResp SwitchPoolRole(ctx, poolId)

Switch pool role to compound

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatePool

PoolResp UpdatePool(ctx, poolId, body)

update pool info

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
poolId	int64	pool id
body	PoolUpdateReq	pool info

Return type

PoolResp

Authorization

tokenInHeader, tokenInQuery

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]