cm_client.ParcelsResourceApi

All URIs are relative to https://localhost/api/v41

get_parcel_usage

ApiParcelUsage get_parcel_usage(cluster_name)

Retrieve details parcel usage information for the cluster.

Retrieve details parcel usage information for the cluster. This describes which processes, roles and hosts are using which parcels.

Example

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

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ParcelsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 

try:
    # Retrieve details parcel usage information for the cluster.
    api_response = api_instance.get_parcel_usage(cluster_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParcelsResourceApi->get_parcel_usage: %s\n" % e)

Parameters

Return type

ApiParcelUsage

Authorization

basic

HTTP request headers

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

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

read_parcels

ApiParcelList read_parcels(cluster_name, view=view)

Lists all parcels that the cluster has access to.

Lists all parcels that the cluster has access to.

Example

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

# Configure HTTP basic authorization: basic
configuration = cm_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = cm_client.ParcelsResourceApi(cm_client.ApiClient(configuration))
cluster_name = 'cluster_name_example' # str | 
view = 'summary' # str |  (optional) (default to summary)

try:
    # Lists all parcels that the cluster has access to.
    api_response = api_instance.read_parcels(cluster_name, view=view)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ParcelsResourceApi->read_parcels: %s\n" % e)

Parameters

Return type

ApiParcelList

Authorization

basic

HTTP request headers

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

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