ray.util.state.list_jobs#

ray.util.state.list_jobs(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[JobState][源代码]#

列出提交到集群的作业，参考 Ray 作业提交。

参数:

  • address – Ray 引导地址，可以是 auto，localhost:6379。如果为 None，它将从已初始化的 Ray 中自动解析。

  • filters – 过滤键、谓词（= 或 !=）和过滤值的元组列表。例如，("status", "=", "abcd") 字符串过滤值不区分大小写。

  • limit – 状态后端返回的最大条目数。

  • timeout – 状态API请求的最大超时值。

  • detail – 当为 True 时，将查询并返回更多详细信息（在 JobState 中指定）。参见 JobState。

  • raise_on_missing_output – 当为 True 时，如果由于截断或数据源不可用而导致数据缺失，将引发异常。

  • _explain – 打印API信息，如API延迟或失败的查询信息。

返回:

字典化的 JobState 列表。

抛出:

RayStateApiException – 如果CLI未能查询数据。

开发者API: 此API可能会在Ray的次要版本之间发生变化。