keystoneauth1.exceptions package

keystoneauth1.exceptions package

Submodules

keystoneauth1.exceptions.auth module

exception keystoneauth1.exceptions.auth.AuthorizationFailure(message=None)

Bases: keystoneauth1.exceptions.base.ClientException

message = 'Cannot authorize API client.'

keystoneauth1.exceptions.auth_plugins module

exception keystoneauth1.exceptions.auth_plugins.AuthPluginException(message=None)

Bases: keystoneauth1.exceptions.base.ClientException

message = 'Unknown error with authentication plugins.'
exception keystoneauth1.exceptions.auth_plugins.MissingAuthPlugin(message=None)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

message = 'An authenticated request is required but no plugin available.'
exception keystoneauth1.exceptions.auth_plugins.NoMatchingPlugin(name)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

No auth plugins could be created from the parameters provided.

Parameters:name (str) – The name of the plugin that was attempted to load.
name

The name of the plugin that was attempted to load.

exception keystoneauth1.exceptions.auth_plugins.UnsupportedParameters(names)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

A parameter that was provided or returned is not supported.

Parameters:names (list(str)) – Names of the unsupported parameters.
names

Names of the unsupported parameters.

exception keystoneauth1.exceptions.auth_plugins.OptionError(message=None)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

A requirement of this plugin loader was not met.

This error can be raised by a specific plugin loader during the load_from_options stage to indicate a parameter problem that can not be handled by the generic options loader.

The intention here is that a plugin can do checks like if a name parameter is provided then a domain parameter must also be provided, but that Opt checking doesn’t handle.

exception keystoneauth1.exceptions.auth_plugins.MissingRequiredOptions(options)

Bases: keystoneauth1.exceptions.auth_plugins.OptionError

One or more required options were not provided.

Parameters:options (list(keystoneauth1.loading.Opt)) – Missing options.
options

List of the missing options.

keystoneauth1.exceptions.base module

exception keystoneauth1.exceptions.base.ClientException(message=None)

Bases: exceptions.Exception

The base exception for everything to do with clients.

message = 'ClientException'

keystoneauth1.exceptions.catalog module

exception keystoneauth1.exceptions.catalog.CatalogException(message=None)

Bases: keystoneauth1.exceptions.base.ClientException

message = 'Unknown error with service catalog.'
exception keystoneauth1.exceptions.catalog.EmptyCatalog(message=None)

Bases: keystoneauth1.exceptions.catalog.EndpointNotFound

message = 'The service catalog is empty.'
exception keystoneauth1.exceptions.catalog.EndpointNotFound(message=None)

Bases: keystoneauth1.exceptions.catalog.CatalogException

message = 'Could not find requested endpoint in Service Catalog.'

keystoneauth1.exceptions.connection module

exception keystoneauth1.exceptions.connection.ConnectionError(message=None)

Bases: keystoneauth1.exceptions.base.ClientException

message = 'Cannot connect to API service.'
exception keystoneauth1.exceptions.connection.ConnectTimeout(message=None)

Bases: keystoneauth1.exceptions.connection.ConnectionError, keystoneauth1.exceptions.connection.RetriableConnectionFailure

message = 'Timed out connecting to service.'
exception keystoneauth1.exceptions.connection.ConnectFailure(message=None)

Bases: keystoneauth1.exceptions.connection.ConnectionError, keystoneauth1.exceptions.connection.RetriableConnectionFailure

message = 'Connection failure that may be retried.'
exception keystoneauth1.exceptions.connection.SSLError(message=None)

Bases: keystoneauth1.exceptions.connection.ConnectionError

message = 'An SSL error occurred.'
exception keystoneauth1.exceptions.connection.RetriableConnectionFailure

Bases: exceptions.Exception

A mixin class that implies you can retry the most recent request.

exception keystoneauth1.exceptions.connection.UnknownConnectionError(msg, original)

Bases: keystoneauth1.exceptions.connection.ConnectionError

An error was encountered but we don’t know what it is.

keystoneauth1.exceptions.discovery module

exception keystoneauth1.exceptions.discovery.DiscoveryFailure(message=None)

Bases: keystoneauth1.exceptions.base.ClientException

message = 'Discovery of client versions failed.'
exception keystoneauth1.exceptions.discovery.ImpliedVersionMismatch(service_type, implied, given)

Bases: exceptions.ValueError

label = 'version'
exception keystoneauth1.exceptions.discovery.ImpliedMinVersionMismatch(service_type, implied, given)

Bases: keystoneauth1.exceptions.discovery.ImpliedVersionMismatch

label = 'min_version'
exception keystoneauth1.exceptions.discovery.ImpliedMaxVersionMismatch(service_type, implied, given)

Bases: keystoneauth1.exceptions.discovery.ImpliedVersionMismatch

label = 'max_version'
exception keystoneauth1.exceptions.discovery.VersionNotAvailable(message=None)

Bases: keystoneauth1.exceptions.discovery.DiscoveryFailure

message = 'Discovery failed. Requested version is not available.'

keystoneauth1.exceptions.http module

HTTP Exceptions used by keystoneauth1.

exception keystoneauth1.exceptions.http.HttpError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.base.ClientException

The base exception class for all HTTP exceptions.

http_status = 0
message = 'HTTP Error'
exception keystoneauth1.exceptions.http.HTTPClientError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HttpError

Client-side HTTP error.

Exception for cases in which the client seems to have erred.

message = 'HTTP Client Error'
exception keystoneauth1.exceptions.http.BadRequest(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 400 - Bad Request.

The request cannot be fulfilled due to bad syntax.

http_status = 400
message = 'Bad Request'
exception keystoneauth1.exceptions.http.Unauthorized(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 401 - Unauthorized.

Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided.

http_status = 401
message = 'Unauthorized'
exception keystoneauth1.exceptions.http.PaymentRequired(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 402 - Payment Required.

Reserved for future use.

http_status = 402
message = 'Payment Required'
exception keystoneauth1.exceptions.http.Forbidden(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 403 - Forbidden.

The request was a valid request, but the server is refusing to respond to it.

http_status = 403
message = 'Forbidden'
exception keystoneauth1.exceptions.http.NotFound(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 404 - Not Found.

The requested resource could not be found but may be available again in the future.

http_status = 404
message = 'Not Found'
exception keystoneauth1.exceptions.http.MethodNotAllowed(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 405 - Method Not Allowed.

A request was made of a resource using a request method not supported by that resource.

http_status = 405
message = 'Method Not Allowed'
exception keystoneauth1.exceptions.http.NotAcceptable(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 406 - Not Acceptable.

The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request.

http_status = 406
message = 'Not Acceptable'
exception keystoneauth1.exceptions.http.ProxyAuthenticationRequired(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 407 - Proxy Authentication Required.

The client must first authenticate itself with the proxy.

http_status = 407
message = 'Proxy Authentication Required'
exception keystoneauth1.exceptions.http.RequestTimeout(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 408 - Request Timeout.

The server timed out waiting for the request.

http_status = 408
message = 'Request Timeout'
exception keystoneauth1.exceptions.http.Conflict(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 409 - Conflict.

Indicates that the request could not be processed because of conflict in the request, such as an edit conflict.

http_status = 409
message = 'Conflict'
exception keystoneauth1.exceptions.http.Gone(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 410 - Gone.

Indicates that the resource requested is no longer available and will not be available again.

http_status = 410
message = 'Gone'
exception keystoneauth1.exceptions.http.LengthRequired(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 411 - Length Required.

The request did not specify the length of its content, which is required by the requested resource.

http_status = 411
message = 'Length Required'
exception keystoneauth1.exceptions.http.PreconditionFailed(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 412 - Precondition Failed.

The server does not meet one of the preconditions that the requester put on the request.

http_status = 412
message = 'Precondition Failed'
exception keystoneauth1.exceptions.http.RequestEntityTooLarge(*args, **kwargs)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 413 - Request Entity Too Large.

The request is larger than the server is willing or able to process.

http_status = 413
message = 'Request Entity Too Large'
exception keystoneauth1.exceptions.http.RequestUriTooLong(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 414 - Request-URI Too Long.

The URI provided was too long for the server to process.

http_status = 414
message = 'Request-URI Too Long'
exception keystoneauth1.exceptions.http.UnsupportedMediaType(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 415 - Unsupported Media Type.

The request entity has a media type which the server or resource does not support.

http_status = 415
message = 'Unsupported Media Type'
exception keystoneauth1.exceptions.http.RequestedRangeNotSatisfiable(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 416 - Requested Range Not Satisfiable.

The client has asked for a portion of the file, but the server cannot supply that portion.

http_status = 416
message = 'Requested Range Not Satisfiable'
exception keystoneauth1.exceptions.http.ExpectationFailed(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 417 - Expectation Failed.

The server cannot meet the requirements of the Expect request-header field.

http_status = 417
message = 'Expectation Failed'
exception keystoneauth1.exceptions.http.UnprocessableEntity(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HTTPClientError

HTTP 422 - Unprocessable Entity.

The request was well-formed but was unable to be followed due to semantic errors.

http_status = 422
message = 'Unprocessable Entity'
exception keystoneauth1.exceptions.http.HttpServerError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HttpError

Server-side HTTP error.

Exception for cases in which the server is aware that it has erred or is incapable of performing the request.

message = 'HTTP Server Error'
exception keystoneauth1.exceptions.http.InternalServerError(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HttpServerError

HTTP 500 - Internal Server Error.

A generic error message, given when no more specific message is suitable.

http_status = 500
message = 'Internal Server Error'
exception keystoneauth1.exceptions.http.HttpNotImplemented(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HttpServerError

HTTP 501 - Not Implemented.

The server either does not recognize the request method, or it lacks the ability to fulfill the request.

http_status = 501
message = 'Not Implemented'
exception keystoneauth1.exceptions.http.BadGateway(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HttpServerError

HTTP 502 - Bad Gateway.

The server was acting as a gateway or proxy and received an invalid response from the upstream server.

http_status = 502
message = 'Bad Gateway'
exception keystoneauth1.exceptions.http.ServiceUnavailable(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HttpServerError

HTTP 503 - Service Unavailable.

The server is currently unavailable.

http_status = 503
message = 'Service Unavailable'
exception keystoneauth1.exceptions.http.GatewayTimeout(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HttpServerError

HTTP 504 - Gateway Timeout.

The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.

http_status = 504
message = 'Gateway Timeout'
exception keystoneauth1.exceptions.http.HttpVersionNotSupported(message=None, details=None, response=None, request_id=None, url=None, method=None, http_status=None, retry_after=0)

Bases: keystoneauth1.exceptions.http.HttpServerError

HTTP 505 - HttpVersion Not Supported.

The server does not support the HTTP protocol version used in the request.

http_status = 505
message = 'HTTP Version Not Supported'
keystoneauth1.exceptions.http.from_response(response, method, url)

Return an instance of HttpError or subclass based on response.

Parameters:
  • response – instance of requests.Response class
  • method – HTTP method used for request
  • url – URL used for request

keystoneauth1.exceptions.oidc module

exception keystoneauth1.exceptions.oidc.InvalidDiscoveryEndpoint(message=None)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

message = 'OpenID Connect Discovery Document endpoint not set.'
exception keystoneauth1.exceptions.oidc.InvalidOidcDiscoveryDocument(message=None)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

message = 'OpenID Connect Discovery Document is not valid JSON.'
exception keystoneauth1.exceptions.oidc.OidcAccessTokenEndpointNotFound(message=None)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

message = 'OpenID Connect access token endpoint not provided.'
exception keystoneauth1.exceptions.oidc.OidcAuthorizationEndpointNotFound(message=None)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

message = 'OpenID Connect authorization endpoint not provided.'
exception keystoneauth1.exceptions.oidc.OidcGrantTypeMissmatch(message=None)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

message = 'Missmatch between OpenID Connect plugin and grant_type argument'
exception keystoneauth1.exceptions.oidc.OidcPluginNotSupported(message=None)

Bases: keystoneauth1.exceptions.auth_plugins.AuthPluginException

message = 'OpenID Connect grant type not supported by provider.'

keystoneauth1.exceptions.response module

exception keystoneauth1.exceptions.response.InvalidResponse(response)

Bases: keystoneauth1.exceptions.base.ClientException

message = 'Invalid response from server.'

keystoneauth1.exceptions.service_providers module

exception keystoneauth1.exceptions.service_providers.ServiceProviderNotFound(sp_id)

Bases: keystoneauth1.exceptions.base.ClientException

A Service Provider cannot be found.

Module contents

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.