Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.
Important

IBM Quantum Platform is moving and this version will be sunset on July 1. To get started on the new platform, read the migration guide.

qiskit.providers.models.BackendStatus

class BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)

GitHub

Class representing Backend Status.

Initialize a BackendStatus object

Parameters

  • backend_name (str) – The backend’s name
  • backend_version (str) – The backend’s version of the form X.Y.Z
  • operational (bool) – True if the backend is operational
  • pending_jobs (int) – The number of pending jobs on the backend
  • status_msg (str) – The status msg for the backend

Raises

QiskitError – If the backend version is in an invalid format

__init__

__init__(backend_name, backend_version, operational, pending_jobs, status_msg)

Initialize a BackendStatus object

Parameters

  • backend_name (str) – The backend’s name
  • backend_version (str) – The backend’s version of the form X.Y.Z
  • operational (bool) – True if the backend is operational
  • pending_jobs (int) – The number of pending jobs on the backend
  • status_msg (str) – The status msg for the backend

Raises

QiskitError – If the backend version is in an invalid format


Methods

__init__(backend_name, backend_version, …)Initialize a BackendStatus object
from_dict(data)Create a new BackendStatus object from a dictionary.
to_dict()Return a dictionary format representation of the BackendStatus.

from_dict

classmethod from_dict(data)

Create a new BackendStatus object from a dictionary.

Parameters

data (dict) – A dictionary representing the BaseBakend to create. It will be in the same format as output by to_dict().

Returns

The BackendStatus from the input dictionary.

Return type

BackendStatus

to_dict

to_dict()

Return a dictionary format representation of the BackendStatus.

Returns

The dictionary form of the QobjHeader.

Return type

dict

Was this page helpful?
Report a bug or request content on GitHub.