# 查询作业详情 - ShowRayJob #### 功能介绍 查看Ray作业详情。本接口为同步接口，当前查看Ray作业详情请求下发成功后会返回结果。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-aidatalake/aidatalake_02_0003.html)。 #### URI GET /v2/workspaces/{workspace_id}/ray-jobs/{job_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 是 | String | **参数解释**：工作空间ID。 **约束限制**：不涉及。 **取值范围**：长度为1\~36的英文字符、数字和中划线的组合。 **默认取值**：不涉及。 | | job_id | 是 | String | **参数解释**：作业ID。 **约束限制**：不涉及。 **取值范围**：长度为1\~36的字母、数字、中划线的组合。 **默认取值**：不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**：租户Token。 **约束限制**：不涉及。 **取值范围**：长度不超过65534个字符。 **默认取值**：不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：Job名称。 **取值范围**：长度为1\~47的英文字母、数字、中划线。 | | endpoint_name | String | **参数解释**：端点名称。 **取值范围**：长度为1\~63个字符。包含小写字母、数字、中划线的组合。字母开头、字母或数字结尾。 | | config | [RayJobConfig] object | **参数解释**：Ray作业类型的配置信息。 | | description | String | **参数解释**：描述信息。 **取值范围**：长度为0\~1024的中文、英文字母、数字、下划线、中划线、点号、空格的组合。 | | id | String | **参数解释**：作业ID。 **取值范围**：长度为1\~36的英文字符、数字和中划线的组合。 | | duration | Integer | **参数解释**：运行时长，单位：秒。 **取值范围**：不涉及。 | | submission_id | String | **参数解释**：Ray Job的唯一ID标识。 **取值范围**：长度为0\~64个字符。 | | create_time | String | **参数解释**：创建时间。 **取值范围**：不涉及。 | | update_time | String | **参数解释**：更新时间。 **取值范围**：不涉及。 | | start_time | String | **参数解释**：作业开始执行的时间。 **取值范围**：不涉及。 | | end_time | String | **参数解释**：结束时间。 **取值范围**：不涉及。 | | status | String | **参数解释**：运行状态。 **取值范围**： - QUEUED：排队中。 - PENDING：待处理。 - RUNNING：运行中。 - CANCELING：取消中。 - CANCELED：已取消。 - FAILED：失败。 - QUEUED_TIMEOUT：排队超时。 - RUNNING_TIMEOUT：运行超时。 - SUCCEEDED：成功。 | | create_user | [User] object | **参数解释**：租户信息内容，包含账户名称、账户ID和用户名称、用户ID。 | | error | [ErrorMessage] object | **参数解释**：失败时返回的文本消息内容，包含错误码、错误描述和解决方案描述。 | 表4RayJobConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | entrypoint | String | **参数解释**：运行作业主脚本。 **取值范围**：长度为1\~102400个字符。 | | runtime_env | [RuntimeEnv] object | **参数解释**：作业的运行时环境配置。 **取值范围**：可选参数有： - working_dir：代码将在其中运行的工作目录，必须是远程URI，如OBS路径。 - pip：要安装的pip软件包列表。 - env_vars：要设置的环境变量。 | | image | [V2ImageBriefInfo] object | **参数解释**：镜像信息。 | | resource_config | [RayResourceConfig] object | **参数解释**：Ray节点资源配置。 | | rayjob_strategy | [RayJobStrategy] object | **参数解释**：Ray Job提交策略。 | | history_server_enabled | Boolean | **参数解释**：指示该作业是否启用了历史服务器（History Server）功能。 **取值范围**： - true：启用History Server。 - false：禁用History Server。 | 表5RuntimeEnv | 参数 | 参数类型 | 描述 | |:---|:---|:---| | working_dir | String | **参数解释**：代码将在其中运行的工作目录。 **取值范围**：最小长度1，最大长度2048。 | | pip | Array of strings | **参数解释**：要安装的pip软件包列表。 | | env_vars | Map\ | **参数解释**：要设置的环境变量。 | | config | Map\ | **参数解释**：运行环境的配置。 **取值范围**：不涉及。 | 表6V2ImageBriefInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | image_id | String | **参数解释**：用户作业使用的镜像ID。 **取值范围**：不涉及。 | | image_version_id | String | **参数解释**：镜像版本。 **取值范围**：不涉及。 | 表7RayResourceConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | head_resource_spec | [RayHeadResourceSpec] object | **参数解释**：head资源配置。 | | worker_resource_spec | Array of [RayWorkerResourceSpec] objects | **参数解释**：worker资源配置。 | 表8RayHeadResourceSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu | Integer | **参数解释**：CPU核数量，单位为毫核。 **取值范围**：最小值为1000。 | | memory | Integer | **参数解释**：单个head内存大小，单位MB。 **取值范围**：最小值为1024。 | | gpu | Double | **参数解释**：节点的GPU数量。 **取值范围**：需配置为大于0的浮点数。 | | npu | Double | **参数解释**：节点的NPU数量。 **取值范围**：需配置为大于0的浮点数。 | 表9RayWorkerResourceSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu | Integer | **参数解释**：CPU核数量，单位为毫核。 **取值范围**：最小值为1000。 | | memory | Integer | **参数解释**：内存大小，单位MB。 **取值范围**：最小值为1024。 | | gpu | Double | **参数解释**：节点的GPU数量。 **取值范围**：需配置为大于0的浮点数。 | | npu | Double | **参数解释**：节点的NPU数量。 **取值范围**：需配置为大于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。 | 表10RayJobStrategy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | queued_timeout | Integer | **参数解释**：作业提交超时时间，如果超过此时间作业仍未运行，则作业失败。 **取值范围**：最大值为1天，最小值为10分钟。单位：分钟。 | | running_timeout | Integer | **参数解释**：作业运行超时时间，如果超过此时间作业还未运行结束，则作业会取消运行，并标记失败。 **取值范围**：最小时间为10分钟，最大时间为7天。 | 表11User | 参数 | 参数类型 | 描述 | |:---|:---|:---| | domain_name | String | **参数解释**：账户名称。 **取值范围**：长度为0\~64个字符。 | | domain_id | String | **参数解释**：账号ID。 **取值范围**：长度为1\~36的数字、英文字符和中划线的组合。 | | user_name | String | **参数解释**：用户名称。 **取值范围**：长度为0\~64个字符。 | | user_id | String | **参数解释**：用户ID。 **取值范围**：长度为1\~36的数字、英文字符和中划线的组合。 | 表12ErrorMessage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案描述。 **取值范围**：长度为0\~4096个字符。 | **状态码：400** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案描述。 **取值范围**：长度为0\~4096个字符。 | **状态码：401** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案描述。 **取值范围**：长度为0\~4096个字符。 | **状态码：404** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案描述。 **取值范围**：长度为0\~4096个字符。 | **状态码：408** 表16响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案描述。 **取值范围**：长度为0\~4096个字符。 | **状态码：500** 表17响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**：错误码。 **取值范围**：长度为8\~36个字符。 | | error_msg | String | **参数解释**：错误描述。 **取值范围**：长度为2\~512个字符。 | | solution_msg | String | **参数解释**：解决方案描述。 **取值范围**：长度为0\~4096个字符。 | #### 请求示例 查看Ray作业详情。本接口为同步接口，当前查看Ray作业详情请求下发成功后会返回结果。 ``` GET /v2/workspaces/{workspace_id}/ray-jobs/{job_id} ``` #### 响应示例 **状态码：200** 请求成功。 ``` { "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" : 0, "npu" : 0 }, "worker_resource_spec" : [ { "cpu" : 2000, "memory" : 4096, "gpu" : 0, "npu" : 0, "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", "display_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" } ``` **状态码：401** 未经授权。 ``` { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } ``` **状态码：403** 请求被拒绝访问。 ``` { "error" : { "code" : "403", "message" : "X-Auth-Token is invalid in the request", "title" : "Forbidden" }, "error_code" : 403, "error_msg" : "X-Auth-Token is invalid in the request", "title" : "Forbidden" } ``` **状态码：404** 所请求的资源不存在。 ``` { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" } ``` **状态码：408** 请求超时。 ``` { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" } ``` **状态码：500** 服务器内部错误。 ``` { "error_code" : "common.00000500", "error_msg" : "internal error" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 | | 400 | 非法请求。 | | 401 | 未经授权。 | | 403 | 请求被拒绝访问。 | | 404 | 所请求的资源不存在。 | | 408 | 请求超时。 | | 500 | 服务器内部错误。 |