controllers.app_instance_controller module

class controllers.app_instance_controller.AppInstanceController(config=None, client=None, call_back=None)

Bases: cohesity_management_sdk.controllers.base_controller.BaseController

A Controller to access Endpoints in the cohesity_management_sdk API.

get_app_instances()

Does a GET request to /public/appInstances.

Api provides the list of the app instances. Instances can be in different states including stopped.

Returns:

AppInstance: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

launch_app_instance(body)

Does a POST request to /public/appInstances.

Starts the application instance launch on the cluster. Only installed apps can be launched.

Args:

body (LaunchAppInstance): TODO: type description

here. Example:

Returns:

AppInstanceIdParameter: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

update_app_instance_settings(app_instance_id, body)

Does a PUT request to /public/appInstanceSettings/{appInstanceId}.

Changes the settings of the app instance.

Args:

app_instance_id (string): Specifies the app instance Id. body (UpdateAppInstanceSettingsParameters): Request to update app

instance settings.

Returns:

void: Response from the API. No Content

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

update_app_instance_state(app_instance_id, body)

Does a PUT request to /public/appInstances/{appInstanceId}/states.

Changes the state of the app instances.

Args:

app_instance_id (int): Specifies the app instance Id. body (UpdateAppInstanceStateParameters): Request to update app instance state.

Returns:

void: Response from the API. No Content

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.