cyperf.UtilsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
check_eulas	GET /eula/v1/check	Check if all EULAs are accepted
get_cert_manager_certificate	GET /api/v2/cert-manager/certificate
get_disk_usage	GET /api/v2/disk-usage
get_disk_usage_consumer_by_id	GET /api/v2/disk-usage/consumers/{consumerId}
get_disk_usage_consumers	GET /api/v2/disk-usage/consumers
get_docs	GET /api/v2/docs
get_docs_json	GET /api/v2/docs.json
get_docs_yaml	GET /api/v2/docs.yaml
get_eula	GET /eula/v1/eula/CyPerf	Retrieve EULA detail
get_log_config	GET /api/v2/log-config
get_time	GET /api/v2/time
list_eulas	GET /eula/v1/eula	list of EULAs
post_eula	POST /eula/v1/eula/CyPerf	Update properties an EULA
start_cert_manager_generate	POST /api/v2/cert-manager/operations/generate
start_cert_manager_upload	POST /api/v2/cert-manager/operations/upload
start_disk_usage_cleanup_diagnostics	POST /api/v2/disk-usage/operations/cleanup-diagnostics
start_disk_usage_cleanup_logs	POST /api/v2/disk-usage/operations/cleanup-logs
start_disk_usage_cleanup_migration	POST /api/v2/disk-usage/operations/cleanup-migration
start_disk_usage_cleanup_notifications	POST /api/v2/disk-usage/operations/cleanup-notifications
start_disk_usage_cleanup_results	POST /api/v2/disk-usage/operations/cleanup-results
update_log_config	PUT /api/v2/log-config

check_eulas

check_eulas(x_kcos_eula_bypass=x_kcos_eula_bypass)

Check if all EULAs are accepted

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)
    x_kcos_eula_bypass = 'x_kcos_eula_bypass_example' # str |  (optional)

    try:
        # Check if all EULAs are accepted
        api_instance.check_eulas(x_kcos_eula_bypass=x_kcos_eula_bypass)
    except Exception as e:
        print("Exception when calling UtilsApi->check_eulas: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_kcos_eula_bypass	str		[optional]

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	All EULAs are accepted	-
401	One or more EULAs are not accepted	-

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

get_cert_manager_certificate

Certificate get_cert_manager_certificate()

Get controller's certificate.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.certificate import Certificate
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.get_cert_manager_certificate()
        print("The response of UtilsApi->get_cert_manager_certificate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->get_cert_manager_certificate: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Certificate

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The controller's certificate	-
500	Unexpected error	-

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

get_disk_usage

DiskUsage get_disk_usage()

Get information about the controller's disk usage.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.disk_usage import DiskUsage
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.get_disk_usage()
        print("The response of UtilsApi->get_disk_usage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->get_disk_usage: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

DiskUsage

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The controller disk usage	-
500	Unexpected error	-

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

get_disk_usage_consumer_by_id

Consumer get_disk_usage_consumer_by_id(consumer_id)

Get the size for logs and diagnostics.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.consumer import Consumer
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)
    consumer_id = 'consumer_id_example' # str | The ID of the consumer.

    try:
        api_response = api_instance.get_disk_usage_consumer_by_id(consumer_id)
        print("The response of UtilsApi->get_disk_usage_consumer_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->get_disk_usage_consumer_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
consumer_id	str	The ID of the consumer.

Return type

Consumer

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Information about logs and diagnostics size	-
400	Bad request	-
500	Unexpected error	-

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

get_disk_usage_consumers

GetDiskUsageConsumers200Response get_disk_usage_consumers(take=take, skip=skip)

Get the list of consumers.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.get_disk_usage_consumers200_response import GetDiskUsageConsumers200Response
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)
    take = 56 # int | The number of search results to return (optional)
    skip = 56 # int | The number of search results to skip (optional)

    try:
        api_response = api_instance.get_disk_usage_consumers(take=take, skip=skip)
        print("The response of UtilsApi->get_disk_usage_consumers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->get_disk_usage_consumers: %s\n" % e)

Parameters

Name	Type	Description	Notes
take	int	The number of search results to return	[optional]
skip	int	The number of search results to skip	[optional]

Return type

GetDiskUsageConsumers200Response

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The list of consumers which can be either logs or diagnostics	-
500	Unexpected error	-

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

get_docs

get_docs()

Get the OpenAPI definitions.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_instance.get_docs()
    except Exception as e:
        print("Exception when calling UtilsApi->get_docs: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The OpenAPI definitions	-
500	Unexpected error	-

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

get_docs_json

get_docs_json()

Get the OpenAPI definitions.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_instance.get_docs_json()
    except Exception as e:
        print("Exception when calling UtilsApi->get_docs_json: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The OpenAPI definitions	-
500	Unexpected error	-

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

get_docs_yaml

str get_docs_yaml()

Get the OpenAPI definitions.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.get_docs_yaml()
        print("The response of UtilsApi->get_docs_yaml:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->get_docs_yaml: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: text/yaml, application/json

HTTP response details

Status code	Description	Response headers
200	The OpenAPI definitions	-
500	Unexpected error	-

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

get_eula

EulaDetails get_eula()

Retrieve EULA detail

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.eula_details import EulaDetails
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        # Retrieve EULA detail
        api_response = api_instance.get_eula()
        print("The response of UtilsApi->get_eula:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->get_eula: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

EulaDetails

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
404	EULA not found	-

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

get_log_config

LogConfig get_log_config()

Get the current global log level.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.log_config import LogConfig
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.get_log_config()
        print("The response of UtilsApi->get_log_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->get_log_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

LogConfig

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The current global log level	-
500	Unexpected error	-

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

get_time

TimeValue get_time()

Get the cluster time.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.time_value import TimeValue
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.get_time()
        print("The response of UtilsApi->get_time:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->get_time: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

TimeValue

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The current cluster time	-

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

list_eulas

List[EulaSummary] list_eulas()

list of EULAs

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.eula_summary import EulaSummary
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        # list of EULAs
        api_response = api_instance.list_eulas()
        print("The response of UtilsApi->list_eulas:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->list_eulas: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[EulaSummary]

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

post_eula

str post_eula(eula_summary=eula_summary)

Update properties an EULA

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.eula_summary import EulaSummary
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)
    eula_summary = cyperf.EulaSummary() # EulaSummary |  (optional)

    try:
        # Update properties an EULA
        api_response = api_instance.post_eula(eula_summary=eula_summary)
        print("The response of UtilsApi->post_eula:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->post_eula: %s\n" % e)

Parameters

Name	Type	Description	Notes
eula_summary	EulaSummary		[optional]

Return type

str

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
404	EULA not found	-

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

start_cert_manager_generate

AsyncContext start_cert_manager_generate(certificate=certificate)

Generate a certificate.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.models.certificate import Certificate
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)
    certificate = cyperf.Certificate() # Certificate |  (optional)

    try:
        api_response = api_instance.start_cert_manager_generate(certificate=certificate)
        print("The response of UtilsApi->start_cert_manager_generate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->start_cert_manager_generate: %s\n" % e)

Parameters

Name	Type	Description	Notes
certificate	Certificate		[optional]

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_cert_manager_upload

AsyncContext start_cert_manager_upload()

Upload a certificate/key pair that will replace the system certificate.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.start_cert_manager_upload()
        print("The response of UtilsApi->start_cert_manager_upload:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->start_cert_manager_upload: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_disk_usage_cleanup_diagnostics

AsyncContext start_disk_usage_cleanup_diagnostics()

Clean the system diagnostics.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.start_disk_usage_cleanup_diagnostics()
        print("The response of UtilsApi->start_disk_usage_cleanup_diagnostics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->start_disk_usage_cleanup_diagnostics: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_disk_usage_cleanup_logs

AsyncContext start_disk_usage_cleanup_logs()

Clean the system logs.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.start_disk_usage_cleanup_logs()
        print("The response of UtilsApi->start_disk_usage_cleanup_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->start_disk_usage_cleanup_logs: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_disk_usage_cleanup_migration

AsyncContext start_disk_usage_cleanup_migration()

Clean the migration packages.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.start_disk_usage_cleanup_migration()
        print("The response of UtilsApi->start_disk_usage_cleanup_migration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->start_disk_usage_cleanup_migration: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_disk_usage_cleanup_notifications

AsyncContext start_disk_usage_cleanup_notifications()

Clean all notifications.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.start_disk_usage_cleanup_notifications()
        print("The response of UtilsApi->start_disk_usage_cleanup_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->start_disk_usage_cleanup_notifications: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

start_disk_usage_cleanup_results

AsyncContext start_disk_usage_cleanup_results()

Clean all statistics.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.async_context import AsyncContext
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)

    try:
        api_response = api_instance.start_disk_usage_cleanup_results()
        print("The response of UtilsApi->start_disk_usage_cleanup_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->start_disk_usage_cleanup_results: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Details about the operation that just started	-

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

update_log_config

LogConfig update_log_config(log_config=log_config)

Update the global log level for all services.

Example

OAuth Authentication (OAuth2):
OAuth Authentication (OAuth2):

import cyperf
from cyperf.models.log_config import LogConfig
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.UtilsApi(api_client)
    log_config = cyperf.LogConfig() # LogConfig |  (optional)

    try:
        api_response = api_instance.update_log_config(log_config=log_config)
        print("The response of UtilsApi->update_log_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UtilsApi->update_log_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
log_config	LogConfig		[optional]

Return type

LogConfig

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The current global log level	-
500	Unexpected error	-

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

FilesExpand file tree

UtilsApi.md

Latest commit

History

UtilsApi.md

File metadata and controls

cyperf.UtilsApi

check_eulas

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_cert_manager_certificate

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_disk_usage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_disk_usage_consumer_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_disk_usage_consumers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_docs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_docs_json

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_docs_yaml

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_eula

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_log_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_time

Example

Parameters