数据湖计算 DLC 获取Ray任务详情

1. 接口描述

接口请求域名： dlc.tencentcloudapi.com 。

根据任务ID获取Ray任务详情

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：GetRayJob。
Version	是	String	公共参数，本接口取值：2021-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
Id	是	String	任务ID 示例值：rayjob-1773664701-twd4

3. 输出参数

参数名称	类型	描述
Id	String	任务ID 示例值：rayjob-1773664701-twd4
ResourcePartitionId	String	所属资源分区ID 示例值：dlc-p-mock0001
ResourcePartitionName	String	默认资源分区名称示例值：lukemeng
Queue	String	所属队列名称示例值：default
Status	String	任务状态示例值：FAILED
Entrypoint	String	入口命令示例值：sleep1
JobName	String	任务名称示例值：rayjob-1773664701-twd4
AppId	Integer	应用ID 示例值：260090589
Uin	String	用户主账号UIN 示例值：700002467852
SubAccountUin	String	创建账号示例值：700002467852
HistoryUrl	String	历史记录链接示例值：https://test-history-server.tcray.woa.com/history/kuberay-system/rayjob-1773664701-twd4/
RunningTime	Integer	运行时间(ms) 示例值：61225
FinishTime	Integer	完成时间示例值：1773664763806
CreateTime	Integer	创建时间示例值：1773664702002
ErrorMessage	String	失败原因/错误信息示例值：Job entrypoint command failed with exit code 127, last available logs (truncated to 20,000 chars):2026-03-16 20:39:14,666 INFO job_manager.py:587 -- Runtime env is setting up.Running entrypoint for job rayjob-1773664701-twd4-v6tz8:
RuntimeEnv	String	运行时环境配置(JSON) 示例值：{"py_modules":["/path/to/my_module","s3://bucket/my_lib.zip"],"working_dir":"https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260090589/20260324210556/b765a3a7-d630-46a5-bba3-866212d027d4.zip"}
Image	String	镜像地址示例值：ccr.ccs.tencentyun.com/emr-image/tcray:3.0.0.dev0-py311-cpu
ResourceConfig	String	资源配置(JSON) 示例值：{"Head":{"Name":"default-head","PodCpu":1,"PodMem":2,"PodNum":1,"GpuType":"","GpuNum":0,"Envs":[],"Labels":[]},"Worker":[{"Name":"default-worker","PodCpu":1,"PodMem":2,"MinPodNum":1,"MaxPodNum":1,"GpuType":"","GpuNum":0,"Envs":[],"Labels":[]}]}
Catalog	String	存储卷和挂载卷配置(JSON) 示例值：{"CFSVolumes":[],"COSVolumes":[]}
ImagePullPolicy	String	镜像拉取策略示例值：IfNotPresent
AutoscalerOptions	String	弹性伸缩配置(JSON) 示例值：{"upscalingMode":"Default","idleTimeoutSeconds":60,"resourceSpec":"small","resources":{"cpu":"500m","memory":"512Mi"}}
SpecId	String	来源配置ID 示例值：spec-cbc30f61
SpecName	String	来源配置名称示例值：test1111
AdvancedOptions	String	高级参数，JSON 字符串（透传到 Neutrino）示例值：{"spec.suspend":"true"}
Priority	Integer	作业优先级（1-9，数字越大优先级越高）示例值：6
Tags	Array of Tag	标签列表（TagKey-TagValue），用于将资源与腾讯云标签系统中的标签绑定
JobSource	String	业务来源标识（调用上下文，长度上限 64，禁止控制字符）示例值：workflow
ClusterName	String	集群名称示例值：test_cfs_ro_qzzhu
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取job详情

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRayJob
<公共请求参数>

{
    "Id": "rayjob-1773664701-twd4"
}

输出示例

{
    "Response": {
        "AppId": 260090589,
        "Catalog": "{\"CFSVolumes\":[],\"COSVolumes\":[]}",
        "CreateTime": 1773664702002,
        "Entrypoint": "sleep1",
        "ErrorMessage": "Job entrypoint command failed with exit code 127, last available logs (truncated to 20,000 chars):\n2026-03-16 20:39:14,666\tINFO job_manager.py:587 -- Runtime env is setting up.\nRunning entrypoint for job rayjob-1773664701-twd4-v6tz8: sleep1\n/bin/sh: 1: sleep1: not found\n",
        "FinishTime": 1773664763806,
        "HistoryUrl": "https://test-history-server.tcray.woa.com/history/kuberay-system/rayjob-1773664701-twd4/",
        "Id": "rayjob-1773664701-twd4",
        "Image": "ccr.ccs.tencentyun.com/emr-image/tcray:3.0.0.dev0-py311-cpu",
        "ImagePullPolicy": "IfNotPresent",
        "JobName": "rayjob-1773664701-twd4",
        "Queue": "default",
        "ResourceConfig": "{\"Head\":{\"Name\":\"default-head\",\"PodCpu\":1,\"PodMem\":2,\"PodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[]},\"Worker\":[{\"Name\":\"default-worker\",\"PodCpu\":1,\"PodMem\":2,\"MinPodNum\":1,\"MaxPodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[]}]}",
        "ResourcePartitionId": "dlc-p-mock0001",
        "RunningTime": 61225,
        "Status": "FAILED",
        "SubAccountUin": "700002467852",
        "Uin": "700002467852",
        "RequestId": "4f003913-0bd8-452b-a0d8-c4965b42d455"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.ExternalService	外部服务异常

获取Ray任务详情

本页目录：