ray.util.state.list_placement_groups#

ray.util.state.list_placement_groups(address: str | None = None, filters: List[Tuple[str, str, str | bool | int | float]] | None = None, limit: int = 100, timeout: int = 30, detail: bool = False, raise_on_missing_output: bool = True, _explain: bool = False) → List[PlacementGroupState][source]#

List placement groups in the cluster.

Parameters:

  • address – Ray bootstrap address, could be auto, localhost:6379. If None, it will be resolved automatically from an initialized ray.

  • filters – List of tuples of filter key, predicate (=, or !=), and the filter value. E.g., ("state", "=", "abcd") String filter values are case-insensitive.

  • limit – Max number of entries returned by the state backend.

  • timeout – Max timeout value for the state APIs requests made.

  • detail – When True, more details info (specified in PlacementGroupState) will be queried and returned. See PlacementGroupState.

  • raise_on_missing_output – When True, exceptions will be raised if there is missing data due to truncation/data source unavailable.

  • _explain – Print the API information such as API latency or failed query information.

Returns:

List of PlacementGroupState.

Raises:

RayStateApiException – if the CLI failed to query the data.

DeveloperAPI: This API may change across minor Ray releases.