QiskitRuntimeService.backends¶
- QiskitRuntimeService.backends(name=None, min_num_qubits=None, instance=None, filters=None, **kwargs)[source]¶
Return all backends accessible via this account, subject to optional filtering.
- Parameters:
name (
Optional
[str
]) – Backend name to filter by.min_num_qubits (
Optional
[int
]) – Minimum number of qubits the backend has to have.instance (
Optional
[str
]) – This is only supported foribm_quantum
runtime and is in the hub/group/project format.filters (
Optional
[Callable
[[List
[IBMBackend
]],bool
]]) –More complex filters, such as lambda functions. For example:
QiskitRuntimeService.backends( filters=lambda b: b.max_shots > 50000) QiskitRuntimeService.backends( filters=lambda x: ("rz" in x.basis_gates )
**kwargs –
Simple filters that require a specific value for an attribute in backend configuration or status. Examples:
# Get the operational real backends QiskitRuntimeService.backends(simulator=False, operational=True) # Get the backends with at least 127 qubits QiskitRuntimeService.backends(min_num_qubits=127) # Get the backends that support OpenPulse QiskitRuntimeService.backends(open_pulse=True)
For the full list of backend attributes, see the IBMBackend class documentation <https://qiskit.org/documentation/apidoc/providers_models.html>
- Return type:
List
[IBMBackend
]- Returns:
The list of available backends that match the filter.
- Raises:
IBMInputValueError – If an input is invalid.
QiskitBackendNotFoundError – If the backend is not in any instance.