文档首页/ 智能数据湖 AI DataLake/ API参考/ Ray相关API/ RayJob管理/ 查询Ray作业列表 - ListRayJobs
更新时间：2026-10-19 GMT+08:00
查看PDF
分享

查询Ray作业列表 - ListRayJobs

功能介绍

列举所有Ray作业。列举工作空间下的作业，分页返回。本接口为同步接口，当前列举所有Ray作业请求下发后会返回结果。

调用方法

请参见如何调用API。

URI

GET /v2/workspaces/{workspace_id}/ray-jobs

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间ID。获取方法，请参见获取工作空间ID。

约束限制：不涉及。

取值范围：长度为1~36的英文字符、数字和中划线的组合。

默认取值：不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

marker

否

String

参数解释：上一页中最后一条记录id，查询第一页时传空值。

约束限制：不涉及。

取值范围：长度为1~36的字母、数字、中划线的组合。

默认取值：不涉及。

limit

否

Integer

参数解释：指定每一页返回的最大条目数。

约束限制：不涉及。

取值范围：1~100。

默认取值：10。

name

否

String

参数解释：通过名字搜索作业。

约束限制：不涉及。

取值范围：长度为1~64的中文、字母、数字、下划线、中划线的组合。

默认取值：不涉及。

id

否

String

参数解释：通过作业id检索。

约束限制：不涉及。

取值范围：长度为1~36的英文字符、数字和中划线的组合。

默认取值：不涉及。

endpoint_name

否

String

参数解释：通过端点名称检索的参数。

约束限制：不涉及。

取值范围：长度为1~64的中文、英文字母、数字、下划线、中划线、点号、空格的组合。

默认取值：不涉及。

status

否

Array of strings

参数解释：状态过滤，支持多种状态查询，默认查询所有。

约束限制：不涉及。

取值范围：可选值有：

  • QUEUED：排队中。

  • PENDING：待处理。

  • RUNNING：运行中。

  • CANCELING：取消中。

  • CANCELED：已取消。

  • FAILED：失败。

  • QUEUED_TIMEOUT：排队超时。

  • RUNNING_TIMEOUT：运行超时。

  • SUCCEEDED：成功。

默认取值：不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：用户Token，通过调用获取IAM用户Token接口获取。

约束限制：不涉及。

取值范围：长度不超过65534个字符。

默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

next_marker

String

参数解释：下一页查询marker值，若为空表示当前已是最后一页。

取值范围：不涉及。

previous_marker

String

参数解释：返回前一页查询地址，为空则表示是第一页。

取值范围：不涉及。

current_count

Integer

参数解释：本次查询记录总数。

取值范围：不涉及。

jobs

Array of RayJobInfo objects

参数解释：Ray作业信息列表，包含作业名称、状态、配置等详细信息。数组中的每个元素为一个RayJobInfo对象。
表5 RayJobInfo

参数

参数类型

描述

name

String

参数解释：Job名称。

取值范围：长度为1~47的英文字母、数字、中划线。

endpoint_name

String

参数解释：端点名称。

取值范围：长度为1~63个字符。包含小写字母、数字、中划线的组合。字母开头、字母或数字结尾。

config

RayJobConfig object

参数解释：Ray作业类型的配置信息。key为配置项名称，value为配置项值。

description

String

参数解释：描述信息。

取值范围：长度为0~1024的中文、英文字母、数字、下划线、中划线、点号、空格的组合。

id

String

参数解释：作业ID。可通过查询Ray作业列表获取。

取值范围：长度为1~36的英文字符、数字和中划线的组合。

duration

Integer

参数解释：运行时长，单位：秒。

取值范围：不涉及。

submission_id

String

参数解释：Ray Job的唯一ID标识。

取值范围：长度为0~64个字符。

endpoint_type

String

参数解释：作业对应的端点类型。

取值范围：

  • RAY_JOB: RayJob类型的端点作业；

  • RAY_CLUSTER: RayCluster类型的端点作业；

  • RAY_FEDERATION: Ray联邦端点作业。

endpoint_id

String

参数解释：Endpoint ID。

取值范围：长度为32~36的英文字符、数字和中划线的组合。

federation_id

String

参数解释：联邦ID。

取值范围：长度为32~36的英文字符、数字和中划线的组合。

federation_name

String

参数解释：联邦名称。

取值范围：长度为1~63个字符。

create_time

String

参数解释：创建时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如2023-05-30T12:24:30.401Z。

取值范围：不涉及。

update_time

String

参数解释：更新时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如2023-05-30T12:24:30.401Z。

取值范围：不涉及。

start_time

String

参数解释：作业开始执行的时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如2023-05-30T12:24:30.401Z。

取值范围：不涉及。

end_time

String

参数解释：结束时间。使用UTC时间格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如2023-05-30T12:24:30.401Z。

取值范围：不涉及。

status

String

参数解释：运行状态。

取值范围：

  • QUEUED：排队中。

  • PENDING：待处理。

  • RUNNING：运行中。

  • CANCELING：取消中。

  • CANCELED：已取消。

  • FAILED：失败。

  • QUEUED_TIMEOUT：排队超时。

  • RUNNING_TIMEOUT：运行超时。

  • SUCCEEDED：成功。

create_user

User object

参数解释：租户信息内容，包含账户名称、账户ID和用户名称、用户ID。

error

ErrorMessage object

参数解释：失败时返回的文本消息内容，包含错误码、错误描述和解决方案描述。

history_server_enabled

Boolean

参数解释：指示该作业是否启用了历史服务器（History Server）功能。

取值范围：

  • true：启用History Server。

  • false：禁用History Server。
表6 RayJobConfig

参数

参数类型

描述

entrypoint

String

参数解释：运行作业主脚本。运行作业时会自动解压作业脚本的.zip文件。如果解压后的第一层只有一个文件夹，该文件夹会被自动去掉，因此此处直接写脚本文件名即可，无需包含父目录。

取值范围：长度为1~102400个字符。

runtime_env

RuntimeEnv object

参数解释：作业的运行时环境配置。

image

V2ImageBriefInfo object

参数解释：镜像信息。

resource_config

RayResourceConfig object

参数解释：Ray节点资源配置。

rayjob_strategy

RayJobStrategy object

参数解释：Ray Job提交策略。

metadata

Map<String,String>

参数解释：用户自定义作业元数据（键值对）。
表7 RuntimeEnv

参数

参数类型

描述

working_dir

String

参数解释：代码将在其中运行的工作目录。

取值范围：最小长度1，最大长度2048。

pip

Array of strings

参数解释：要安装的pip软件包列表。

env_vars

Map<String,String>

参数解释：要设置的环境变量。key为环境变量名称，value为环境变量值，均为String类型。

config

Map<String,Object>

参数解释：运行环境的配置。key为配置项名称，value为配置项值。
表8 V2ImageBriefInfo

参数

参数类型

描述

image_id

String

参数解释：镜像ID。获取方式请参见查看镜像列表。

取值范围：长度为32~36的英文、数字、中划线的组合。

image_version_id

String

参数解释：镜像版本ID。获取方式请参见查询镜像详情。

取值范围：长度为32~36的英文、数字、中划线的组合。
表9 RayResourceConfig

参数

参数类型

描述

head_resource_spec

RayHeadResourceSpec object

参数解释：head资源配置。

worker_resource_spec

Array of RayWorkerResourceSpec objects

参数解释：worker资源配置。
表10 RayHeadResourceSpec

参数

参数类型

描述

cpu

Integer

参数解释：CPU核数量，单位为毫核。

取值范围：最小值为1000。

memory

Integer

参数解释：单个head内存大小，单位MB。

取值范围：最小值为1024。

gpu

Double

参数解释：节点的GPU数量。

取值范围：需配置为大于等于1.0，且必须为整数值（如1.0, 2.0, 3.0, ...）。

npu

Double

参数解释：节点的NPU数量。

取值范围：需配置为大于等于1.0，且必须为整数值（如1.0, 2.0, 3.0, ...）。
表11 RayWorkerResourceSpec

参数

参数类型

描述

cpu

Integer

参数解释：CPU核数量，单位为毫核。

取值范围：最小值为1000。

memory

Integer

参数解释：内存大小，单位MB。

取值范围：最小值为1024。

gpu

Double

参数解释：节点的GPU数量。

取值范围：需配置为大于等于1.0，且必须为整数值（如1.0, 2.0, 3.0, ...）。

npu

Double

参数解释：节点的NPU数量。

取值范围：需配置为大于等于1.0，且必须为整数值（如1.0, 2.0, 3.0, ...）。

worker_replicas

Integer

参数解释：Worker副本数量。

取值范围：1~64。

enable_autoscaling

Boolean

参数解释：是否开启worker节点的弹性伸缩。

取值范围：可选值有：

  • true：开启弹性伸缩。取该值时worker_min_replicas和worker_max_replicas必须设置。

  • false：不开启弹性伸缩。取该值时worker_replicas必须设置。

worker_min_replicas

Integer

参数解释：Worker最小副本数量。

取值范围：0~64。

worker_max_replicas

Integer

参数解释：Worker最大副本数量。

取值范围：1~64。
表12 RayJobStrategy

参数

参数类型

描述

queued_timeout

Integer

参数解释：作业提交超时时间，如果超过此时间作业仍未运行，则作业失败。单位为分钟。

取值范围：10~1440。

running_timeout

Integer

参数解释：作业运行超时时间，如果超过此时间作业还未运行结束，则作业会取消运行，并标记失败。单位为分钟。

取值范围：-1~10080（-1表示不配置超时）。
表13 User

参数

参数类型

描述

domain_name

String

参数解释：账户名称。

取值范围：长度为0~64个字符。

domain_id

String

参数解释：账号ID。

取值范围：长度为1~36的数字、英文字符和中划线的组合。

user_name

String

参数解释：用户名称。

取值范围：长度为0~64个字符。

user_id

String

参数解释：用户ID。

取值范围：长度为1~36的数字、英文字符和中划线的组合。
表14 ErrorMessage

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为0~4096个字符。

状态码：400

表15 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为0~4096个字符。

状态码：401

表16 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为0~4096个字符。

状态码：403

表17 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为0~4096个字符。

状态码：404

表18 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为0~4096个字符。

状态码：408

表19 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为0~4096个字符。

状态码：500

表20 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

取值范围：长度为8~36个字符。

error_msg

String

参数解释：错误描述。

取值范围：长度为2~512个字符。

solution_msg

String

参数解释：解决方案描述。

取值范围：长度为0~4096个字符。

请求示例

列举所有Ray作业。

GET /v2/workspaces/{workspace_id}/ray-jobs

响应示例

状态码：200

{
  "current_count" : 1,
  "jobs" : [ {
    "name" : "rayjob1",
    "description" : "rayjob1",
    "config" : {
      "entrypoint" : "echo helloworldstart;\\n sleep 100;\\necho helloworldend;\\n",
      "image" : {
        "image_id" : "2ca95307-9e39-4ab5-a101-7c05486977b4",
        "image_version_id" : "8952ce4a-86bb-4f24-95e8-f2091bfa3f49"
      },
      "resource_config" : {
        "head_resource_spec" : {
          "cpu" : 2000,
          "memory" : 4096,
          "gpu" : 1,
          "npu" : 1
        },
        "worker_resource_spec" : [ {
          "cpu" : 2000,
          "memory" : 4096,
          "gpu" : 1,
          "npu" : 1,
          "worker_replicas" : 1,
          "enable_autoscaling" : true,
          "worker_min_replicas" : 1,
          "worker_max_replicas" : 1
        } ]
      },
      "rayjob_strategy" : {
        "queued_timeout" : 180,
        "running_timeout" : 180
      }
    },
    "history_server_enabled" : false,
    "endpoint_name" : "ray-cpu-endpoint",
    "federation_name" : "ray-abc-federation",
    "id" : "019ef7e8-a783-78aa-bd98-6f56b32786c4",
    "duration" : 325,
    "create_time" : "2026-06-27T10:05:24.593+00:00",
    "update_time" : "2026-06-27T10:10:57.177+00:00",
    "start_time" : "2026-06-27T10:05:32.000+00:00",
    "end_time" : "2026-06-27T10:10:57.000+00:00",
    "status" : "SUCCEEDED",
    "create_user" : {
      "domain_name" : "your_domain_name",
      "domain_id" : "your-domain-id",
      "user_name" : "your_user_name",
      "user_id" : "your-user-id"
    },
    "error" : {
      "error_msg" : "Job finished successfully."
    }
  } ]
}

状态码：400

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException",
  "solution_msg" : "Check whether the request parameters comply with the API definition and try again"
}

状态码：401

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed",
  "solution_msg" : "Please check if auth token is included in the request header."
}

状态码：403

{
  "error_code" : "APIG.1003",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "solution_msg" : "Check whether the token in the request is valid and try again."
}

状态码：404

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404",
  "solution_msg" : "Please try to use correct info."
}

状态码：408

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred",
  "solution_msg" : "The backend request timed out — check service health and network connectivity, then retry."
}

状态码：500

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error",
  "solution_msg" : "Contact operations for analysis."
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

401

未经授权。

403

请求被拒绝访问。

404

所请求的资源不存在。

408

请求超时。

500

服务器内部错误。
父主题： RayJob管理

相关文档