Skip to content

Latest commit

 

History

History
352 lines (244 loc) · 9.59 KB

PoolsApi.md

File metadata and controls

352 lines (244 loc) · 9.59 KB
Raw

swagger_client.PoolsApi

All URIs are relative to https://{username}:{password}@localhost:{port}/{basePath}

Method HTTP request Description
api_v2_pools_get GET /api/v2/pools Pool list
api_v2_pools_poolid_get GET /api/v2/pools/{poolid} Find pool by PoolId
api_v2_pools_poolid_show_get GET /api/v2/pools/{poolid}/show Show pool
api_v2_pools_poolid_update_put PUT /api/v2/pools/{poolid}/update Update pool properties
api_v2_pools_poolid_update_volumes_put PUT /api/v2/pools/{poolid}/update/volumes Update properties all volumes in pool
api_v2_pools_poolid_volumes_get GET /api/v2/pools/{poolid}/volumes Get all volumes in pool
api_v2_pools_show_get GET /api/v2/pools/show Show pools

api_v2_pools_get

InlineResponse20032 api_v2_pools_get(limit=limit)

Pool list

Get pool list.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()
limit = 56 # int | Item limit (optional)

try:
    # Pool list
    api_response = api_instance.api_v2_pools_get(limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->api_v2_pools_get: %s\n" % e)

Parameters

Name Type Description Notes
limit int Item limit [optional]

Return type

InlineResponse20032

Authorization

No authorization required

HTTP request headers

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

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

api_v2_pools_poolid_get

InlineResponse20033 api_v2_pools_poolid_get(poolid)

Find pool by PoolId

Get pool by specific Pool identifier.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()
poolid = 56 # int | Pool identifier

try:
    # Find pool by PoolId
    api_response = api_instance.api_v2_pools_poolid_get(poolid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->api_v2_pools_poolid_get: %s\n" % e)

Parameters

Name Type Description Notes
poolid int Pool identifier

Return type

InlineResponse20033

Authorization

No authorization required

HTTP request headers

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

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

api_v2_pools_poolid_show_get

InlineResponse20035 api_v2_pools_poolid_show_get(poolid, output=output)

Show pool

Get 'show pools' bconsole command output for specific pool

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()
poolid = 56 # int | Pool identifier
output = 'output_example' # str | Output format (optional)

try:
    # Show pool
    api_response = api_instance.api_v2_pools_poolid_show_get(poolid, output=output)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->api_v2_pools_poolid_show_get: %s\n" % e)

Parameters

Name Type Description Notes
poolid int Pool identifier
output str Output format [optional]

Return type

InlineResponse20035

Authorization

No authorization required

HTTP request headers

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

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

api_v2_pools_poolid_update_put

InlineResponse20036 api_v2_pools_poolid_update_put(poolid)

Update pool properties

Update properties in specific pool

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()
poolid = 56 # int | Pool identifier

try:
    # Update pool properties
    api_response = api_instance.api_v2_pools_poolid_update_put(poolid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->api_v2_pools_poolid_update_put: %s\n" % e)

Parameters

Name Type Description Notes
poolid int Pool identifier

Return type

InlineResponse20036

Authorization

No authorization required

HTTP request headers

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

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

api_v2_pools_poolid_update_volumes_put

InlineResponse20037 api_v2_pools_poolid_update_volumes_put(poolid)

Update properties all volumes in pool

Update properties all volumes in specific pool

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()
poolid = 56 # int | Pool identifier

try:
    # Update properties all volumes in pool
    api_response = api_instance.api_v2_pools_poolid_update_volumes_put(poolid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->api_v2_pools_poolid_update_volumes_put: %s\n" % e)

Parameters

Name Type Description Notes
poolid int Pool identifier

Return type

InlineResponse20037

Authorization

No authorization required

HTTP request headers

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

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

api_v2_pools_poolid_volumes_get

InlineResponse20034 api_v2_pools_poolid_volumes_get(poolid)

Get all volumes in pool

Get all volumes in specific pool

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()
poolid = 56 # int | Pool identifier

try:
    # Get all volumes in pool
    api_response = api_instance.api_v2_pools_poolid_volumes_get(poolid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->api_v2_pools_poolid_volumes_get: %s\n" % e)

Parameters

Name Type Description Notes
poolid int Pool identifier

Return type

InlineResponse20034

Authorization

No authorization required

HTTP request headers

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

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

api_v2_pools_show_get

InlineResponse20038 api_v2_pools_show_get(name=name)

Show pools

Get 'show pools' bconsole command output

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PoolsApi()
name = 'name_example' # str | Pool name (optional)

try:
    # Show pools
    api_response = api_instance.api_v2_pools_show_get(name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PoolsApi->api_v2_pools_show_get: %s\n" % e)

Parameters

Name Type Description Notes
name str Pool name [optional]

Return type

InlineResponse20038

Authorization

No authorization required

HTTP request headers

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

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