ironicclient.common.apiclient.exceptions module

Exception definitions.

exception ironicclient.common.apiclient.exceptions.AmbiguousEndpoints(endpoints: object | None = None)

Bases: EndpointException

Found more than one matching endpoint in Service Catalog.

exception ironicclient.common.apiclient.exceptions.AuthPluginOptionsMissing(opt_names: list[str])

Bases: AuthorizationFailure

Auth plugin misses some options.

exception ironicclient.common.apiclient.exceptions.AuthSystemNotFound(auth_system: str)

Bases: AuthorizationFailure

User has specified an AuthSystem that is not installed.

exception ironicclient.common.apiclient.exceptions.AuthorizationFailure

Bases: ClientException

Cannot authorize API client.

exception ironicclient.common.apiclient.exceptions.BadGateway(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: 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: int = 502

message: str = 'Bad Gateway'

exception ironicclient.common.apiclient.exceptions.BadRequest(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 400 - Bad Request.

The request cannot be fulfilled due to bad syntax.

http_status: int = 400

message: str = 'Bad Request'

exception ironicclient.common.apiclient.exceptions.ClientException

Bases: Exception

The base exception class for all exceptions this library raises.

exception ironicclient.common.apiclient.exceptions.CommandError

Bases: ClientException

Error in CLI tool.

exception ironicclient.common.apiclient.exceptions.Conflict(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: 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: int = 409

message: str = 'Conflict'

exception ironicclient.common.apiclient.exceptions.ConnectionError

Bases: ClientException

Cannot connect to API service.

exception ironicclient.common.apiclient.exceptions.ConnectionRefused

Bases: ConnectionError

Connection refused while trying to connect to API service.

exception ironicclient.common.apiclient.exceptions.EndpointException

Bases: ClientException

Something is rotten in Service Catalog.

exception ironicclient.common.apiclient.exceptions.EndpointNotFound

Bases: EndpointException

Could not find requested endpoint in Service Catalog.

exception ironicclient.common.apiclient.exceptions.ExpectationFailed(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 417 - Expectation Failed.

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

http_status: int = 417

message: str = 'Expectation Failed'

exception ironicclient.common.apiclient.exceptions.Forbidden(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 403 - Forbidden.

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

http_status: int = 403

message: str = 'Forbidden'

exception ironicclient.common.apiclient.exceptions.GatewayTimeout(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: 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: int = 504

message: str = 'Gateway Timeout'

exception ironicclient.common.apiclient.exceptions.Gone(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 410 - Gone.

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

http_status: int = 410

message: str = 'Gone'

exception ironicclient.common.apiclient.exceptions.HTTPClientError(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HttpError

Client-side HTTP error.

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

message: str = 'HTTP Client Error'

exception ironicclient.common.apiclient.exceptions.HTTPRedirection(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HttpError

HTTP Redirection.

message: str = 'HTTP Redirection'

exception ironicclient.common.apiclient.exceptions.HttpError(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: ClientException

The base exception class for all HTTP exceptions.

http_status: int = 0

message: str = 'HTTP Error'

exception ironicclient.common.apiclient.exceptions.HttpNotImplemented(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: 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: int = 501

message: str = 'Not Implemented'

exception ironicclient.common.apiclient.exceptions.HttpServerError(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: 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: str = 'HTTP Server Error'

exception ironicclient.common.apiclient.exceptions.HttpVersionNotSupported(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HttpServerError

HTTP 505 - HttpVersion Not Supported.

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

http_status: int = 505

message: str = 'HTTP Version Not Supported'

exception ironicclient.common.apiclient.exceptions.InternalServerError(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HttpServerError

HTTP 500 - Internal Server Error.

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

http_status: int = 500

message: str = 'Internal Server Error'

exception ironicclient.common.apiclient.exceptions.LengthRequired(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 411 - Length Required.

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

http_status: int = 411

message: str = 'Length Required'

exception ironicclient.common.apiclient.exceptions.MethodNotAllowed(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 405 - Method Not Allowed.

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

http_status: int = 405

message: str = 'Method Not Allowed'

exception ironicclient.common.apiclient.exceptions.MultipleChoices(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPRedirection

HTTP 300 - Multiple Choices.

Indicates multiple options for the resource that the client may follow.

http_status: int = 300

message: str = 'Multiple Choices'

exception ironicclient.common.apiclient.exceptions.NoUniqueMatch

Bases: ClientException

Multiple entities found instead of one.

exception ironicclient.common.apiclient.exceptions.NotAcceptable(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: 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: int = 406

message: str = 'Not Acceptable'

exception ironicclient.common.apiclient.exceptions.NotFound(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 404 - Not Found.

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

http_status: int = 404

message: str = 'Not Found'

exception ironicclient.common.apiclient.exceptions.PaymentRequired(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 402 - Payment Required.

Reserved for future use.

http_status: int = 402

message: str = 'Payment Required'

exception ironicclient.common.apiclient.exceptions.PreconditionFailed(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 412 - Precondition Failed.

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

http_status: int = 412

message: str = 'Precondition Failed'

exception ironicclient.common.apiclient.exceptions.ProxyAuthenticationRequired(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 407 - Proxy Authentication Required.

The client must first authenticate itself with the proxy.

http_status: int = 407

message: str = 'Proxy Authentication Required'

exception ironicclient.common.apiclient.exceptions.RequestEntityTooLarge(*args: Any, **kwargs: Any)

Bases: HTTPClientError

HTTP 413 - Request Entity Too Large.

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

http_status: int = 413

message: str = 'Request Entity Too Large'

exception ironicclient.common.apiclient.exceptions.RequestTimeout(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 408 - Request Timeout.

The server timed out waiting for the request.

http_status: int = 408

message: str = 'Request Timeout'

exception ironicclient.common.apiclient.exceptions.RequestUriTooLong(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 414 - Request-URI Too Long.

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

http_status: int = 414

message: str = 'Request-URI Too Long'

exception ironicclient.common.apiclient.exceptions.RequestedRangeNotSatisfiable(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: 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: int = 416

message: str = 'Requested Range Not Satisfiable'

exception ironicclient.common.apiclient.exceptions.ServiceUnavailable(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HttpServerError

HTTP 503 - Service Unavailable.

The server is currently unavailable.

http_status: int = 503

message: str = 'Service Unavailable'

exception ironicclient.common.apiclient.exceptions.Unauthorized(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: 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: int = 401

message: str = 'Unauthorized'

exception ironicclient.common.apiclient.exceptions.UnprocessableEntity(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 422 - Unprocessable Entity.

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

http_status: int = 422

message: str = 'Unprocessable Entity'

exception ironicclient.common.apiclient.exceptions.UnsupportedMediaType(message: str | None = None, details: str | None = None, response: Response | None = None, request_id: str | None = None, url: str | None = None, method: str | None = None, http_status: int | None = None)

Bases: HTTPClientError

HTTP 415 - Unsupported Media Type.

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

http_status: int = 415

message: str = 'Unsupported Media Type'

exception ironicclient.common.apiclient.exceptions.UnsupportedVersion

Bases: ClientException

User is trying to use an unsupported version of the API.

exception ironicclient.common.apiclient.exceptions.ValidationError

Bases: ClientException

Error in validation on API client side.

ironicclient.common.apiclient.exceptions.from_response(response: Response, method: str, url: str) → HttpError

Returns 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