Exceptions API

exception cloudify_rest_client.exceptions.CloudifyClientError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: Exception

exception cloudify_rest_client.exceptions.DeploymentEnvironmentCreationInProgressError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when there’s attempt to execute a deployment workflow and deployment environment creation workflow execution is still running. In such a case, workflow execution should be retried after a reasonable time or after the execution of deployment environment creation workflow has terminated.

ERROR_CODE = 'deployment_environment_creation_in_progress_error'

exception cloudify_rest_client.exceptions.DeploymentEnvironmentCreationPendingError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when there’s attempt to execute a deployment workflow and deployment environment creation workflow execution is pending. In such a case, workflow execution should be retried after a reasonable time or after the execution of deployment environment creation workflow has terminated.

ERROR_CODE = 'deployment_environment_creation_pending_error'

exception cloudify_rest_client.exceptions.IllegalExecutionParametersError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when an attempt to execute a workflow with wrong/missing parameters has been made.

ERROR_CODE = 'illegal_execution_parameters_error'

exception cloudify_rest_client.exceptions.NoSuchIncludeFieldError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when an _include query parameter contains a field which does not exist for the queried data model.

ERROR_CODE = 'no_such_include_field_error'

exception cloudify_rest_client.exceptions.MissingRequiredDeploymentInputError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a required deployment input was not specified on deployment creation.

ERROR_CODE = 'missing_required_deployment_input_error'

exception cloudify_rest_client.exceptions.UnknownDeploymentInputError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when an unexpected input was specified on deployment creation.

ERROR_CODE = 'unknown_deployment_input_error'

exception cloudify_rest_client.exceptions.UnknownDeploymentSecretError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a required secret was not found on deployment creation.

ERROR_CODE = 'unknown_deployment_secret_error'

exception cloudify_rest_client.exceptions.UnsupportedDeploymentGetSecretError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when an unsupported get_secret intrinsic function appears in the blueprint on deployment creation.

ERROR_CODE = 'unsupported_deployment_get_secret_error'

exception cloudify_rest_client.exceptions.FunctionsEvaluationError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when function evaluation failed.

ERROR_CODE = 'functions_evaluation_error'

exception cloudify_rest_client.exceptions.UnknownModificationStageError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when an unknown modification stage was provided.

ERROR_CODE = 'unknown_modification_stage_error'

exception cloudify_rest_client.exceptions.ExistingStartedDeploymentModificationError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a deployment modification start is attempted while another deployment modification is currently started

ERROR_CODE = 'existing_started_deployment_modification_error'

exception cloudify_rest_client.exceptions.DeploymentModificationAlreadyEndedError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a deployment modification finish/rollback is attempted on a deployment modification that has already been finished/rolledback

ERROR_CODE = 'deployment_modification_already_ended_error'

exception cloudify_rest_client.exceptions.UserUnauthorizedError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a call has been made to a secured resource with an unauthorized user (no credentials / bad credentials)

ERROR_CODE = 'unauthorized_error'

exception cloudify_rest_client.exceptions.ForbiddenError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a call has been made by a user that is not permitted to perform it

ERROR_CODE = 'forbidden_error'

exception cloudify_rest_client.exceptions.PluginInUseError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised if a central deployment agent plugin deletion is attempted and at least one deployment is currently using this plugin.

ERROR_CODE = 'plugin_in_use'

exception cloudify_rest_client.exceptions.BlueprintInUseError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised if an imported blueprint (is used in another active blueprint) deletion is attempted.

ERROR_CODE = 'blueprint_in_use'

exception cloudify_rest_client.exceptions.PluginInstallationError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised if a central deployment agent plugin installation fails.

ERROR_CODE = 'plugin_installation_error'

exception cloudify_rest_client.exceptions.PluginInstallationTimeout(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised if a central deployment agent plugin installation times out.

ERROR_CODE = 'plugin_installation_timeout'

exception cloudify_rest_client.exceptions.MaintenanceModeActiveError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a call has been blocked due to maintenance mode being active.

ERROR_CODE = 'maintenance_mode_active'

exception cloudify_rest_client.exceptions.MaintenanceModeActivatingError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a call has been blocked while maintenance mode is activating.

ERROR_CODE = 'entering_maintenance_mode'

exception cloudify_rest_client.exceptions.NotModifiedError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a 304 not modified error was returned

ERROR_CODE = 'not_modified'

exception cloudify_rest_client.exceptions.InvalidExecutionUpdateStatus(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when execution update failed do to invalid status update

ERROR_CODE = 'invalid_exception_status_update'

exception cloudify_rest_client.exceptions.NotClusterMaster(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when the request was served by a manager that is not the master node of a manager cluster. The client should query for the cluster status to learn the master’s address, and retry the request. If the client stores the server address, it should update the storage with the new master node address.

ERROR_CODE = 'not_cluster_master'

exception cloudify_rest_client.exceptions.RemovedFromCluster(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when attempting to contact a manager that was removed from a cluster. The client should retry the request with another manager in the cluster. If the client stores the server address, it should remove this node’s address from storage.

ERROR_CODE = 'removed_from_cluster'

exception cloudify_rest_client.exceptions.DeploymentPluginNotFound(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a plugin is listed in the blueprint but is not installed on the manager.

ERROR_CODE = 'deployment_plugin_not_found'

exception cloudify_rest_client.exceptions.IncompatibleClusterArchitectureError(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when a cluster node with architecture X is trying to join a cluster with architecture Y

E.G. - Master is all-in-one and slave has an external database

ERROR_CODE = 'incompatible_cluster_architecture'

exception cloudify_rest_client.exceptions.ExpiredCloudifyLicense(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when the Cloudify license on the Manager has expired

ERROR_CODE = 'expired_cloudify_license'

exception cloudify_rest_client.exceptions.MissingCloudifyLicense(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when there is no Cloudify license on the Manager

ERROR_CODE = 'missing_cloudify_license'

exception cloudify_rest_client.exceptions.InvalidFilterRule(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when one of the provided filter rules is invalid

ERROR_CODE = 'invalid_filter_rule'

exception cloudify_rest_client.exceptions.DeploymentParentNotFound(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

Raised when deployment reference parent that does not exist using labels in blueprint dsl

ERROR_CODE = 'deployment_parent_not_found_error'

exception cloudify_rest_client.exceptions.ForbiddenWhileCancelling(message, server_traceback=None, status_code=-1, error_code=None, response=None)

Bases: CloudifyClientError

ERROR_CODE = 'forbidden_while_cancelling'