cyperf.TestOperationsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
poll_test_calibrate_start	GET /api/v2/sessions/{sessionId}/test-calibrate/operations/start/{id}
poll_test_calibrate_stop	GET /api/v2/sessions/{sessionId}/test-calibrate/operations/stop/{id}
poll_test_run_abort	GET /api/v2/sessions/{sessionId}/test-run/operations/abort/{id}
poll_test_run_start	GET /api/v2/sessions/{sessionId}/test-run/operations/start/{id}
poll_test_run_stop	GET /api/v2/sessions/{sessionId}/test-run/operations/stop/{id}
start_test_calibrate_start	POST /api/v2/sessions/{sessionId}/test-calibrate/operations/start
start_test_calibrate_stop	POST /api/v2/sessions/{sessionId}/test-calibrate/operations/stop
start_test_run_abort	POST /api/v2/sessions/{sessionId}/test-run/operations/abort
start_test_run_start	POST /api/v2/sessions/{sessionId}/test-run/operations/start
start_test_run_stop	POST /api/v2/sessions/{sessionId}/test-run/operations/stop

poll_test_calibrate_start

AsyncContext poll_test_calibrate_start(session_id, id)

Get the state of an ongoing operation.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_test_calibrate_start(session_id, id)
        print("The response of TestOperationsApi->poll_test_calibrate_start:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestOperationsApi->poll_test_calibrate_start: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

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

poll_test_calibrate_stop

AsyncContext poll_test_calibrate_stop(session_id, id)

Get the state of an ongoing operation.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_test_calibrate_stop(session_id, id)
        print("The response of TestOperationsApi->poll_test_calibrate_stop:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestOperationsApi->poll_test_calibrate_stop: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

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

poll_test_run_abort

AsyncContext poll_test_run_abort(session_id, id)

Get the state of an ongoing operation.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_test_run_abort(session_id, id)
        print("The response of TestOperationsApi->poll_test_run_abort:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestOperationsApi->poll_test_run_abort: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

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

poll_test_run_start

AsyncContext poll_test_run_start(session_id, id)

Get the state of an ongoing operation.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_test_run_start(session_id, id)
        print("The response of TestOperationsApi->poll_test_run_start:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestOperationsApi->poll_test_run_start: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

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

poll_test_run_stop

AsyncContext poll_test_run_stop(session_id, id)

Get the state of an ongoing operation.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.
    id = 56 # int | The ID of the async operation.

    try:
        api_response = api_instance.poll_test_run_stop(session_id, id)
        print("The response of TestOperationsApi->poll_test_run_stop:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TestOperationsApi->poll_test_run_stop: %s\n" % e)

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.
id	int	The ID of the async operation.

Return type

AsyncContext

Authorization

OAuth2, OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Details about the ongoing operation	-
400	Bad request	-

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

start_test_calibrate_start

AsyncContext start_test_calibrate_start(session_id)

Start calibration for the test configured in the current session.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

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

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

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_test_calibrate_stop

AsyncContext start_test_calibrate_stop(session_id)

Stop calibration for the test configured in the current session.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

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

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

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_test_run_abort

AsyncContext start_test_run_abort(session_id)

Abort traffic for the test configured in the current session.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

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

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

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_test_run_start

AsyncContext start_test_run_start(session_id)

Start traffic for the test configured in the current session.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

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

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

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_test_run_stop

AsyncContext start_test_run_stop(session_id)

Stop traffic for the test configured in the current session.

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.TestOperationsApi(api_client)
    session_id = 'session_id_example' # str | The ID of the session.

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

Parameters

Name	Type	Description	Notes
session_id	str	The ID of the session.

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]

FilesExpand file tree

TestOperationsApi.md

Latest commit

History

TestOperationsApi.md

File metadata and controls

cyperf.TestOperationsApi

poll_test_calibrate_start

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

poll_test_calibrate_stop

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

poll_test_run_abort

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

poll_test_run_start

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

poll_test_run_stop

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_test_calibrate_start

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_test_calibrate_stop

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_test_run_abort

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_test_run_start

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

start_test_run_stop

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details