Function list

python/ray/dashboard/modules/job/cli.py:586–600

Lists all running jobs and their information. Example: `ray job list` Args: address: Address of the Ray cluster to connect to. headers: JSON string of headers to attach to requests. verify: Path to a CA bundle, or boolean toggling TLS verification.

(address: Optional[str], headers: Optional[str], verify: Union[bool, str])

@add_click_logging_options
@PublicAPI(stability="stable")
def list(address: Optional[str], headers: Optional[str], verify: Union[bool, str]):
    """Lists all running jobs and their information.

    Example:
        `ray job list`

    Args:
        address: Address of the Ray cluster to connect to.
        headers: JSON string of headers to attach to requests.
        verify: Path to a CA bundle, or boolean toggling TLS verification.
    """
    client = _get_sdk_client(address, headers=headers, verify=verify)
    # Set no_format to True because the logs may have unescaped "{" and "}"
    # and the CLILogger calls str.format().
    cli_logger.print(pprint.pformat(client.list_jobs()), no_format=True)