帮你快速理解、总结文档立即下载

基于配置运行作业

最近更新时间:2026-08-04 01:50:06

我的收藏

1. 接口描述

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

基于指定作业配置提交一次作业实例

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RunJobSpec。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
SpecId String

配置ID


示例值:rayjobspec-tcfoqk-wrzu
FlowId String

外部工作流引擎业务键 flowId


示例值:flow-001
ExecutionId String

外部工作流引擎业务键 executionId


示例值:exec-001
JobSource String

业务来源标识(调用上下文,长度上限 64,禁止控制字符)


示例值:workflow

3. 输出参数

参数名称 类型 描述
Id String

任务ID


示例值:rayjob-20260325104827-xevb
ResourcePartitionId String

所属资源分区ID


示例值:dlc-p-ofvhyjzn
Queue String

所属队列名称


示例值:default
Status String

任务状态


示例值:SUBMITTED
Entrypoint String

入口命令


示例值:sleep 1
JobName String

任务名称


示例值:rayjob-spec-6-20260325104827-xevb
AppId Integer

应用ID


示例值:260090589
Uin String

用户UIN


示例值:700002467852
SubAccountUin String

子用户UIN


示例值:700002467852
RunningTime Integer

运行时间(ms)


示例值:54
CreateTime Integer

创建时间


示例值:1774406907461
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/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-cpu
ResourceConfig String

资源配置(JSON)


示例值:{"Head":{"Name":"Head","PodCpu":1,"PodMem":2,"PodNum":1,"GpuType":"","GpuNum":0,"Envs":[],"Labels":[],"HighAvailability":false,"ResourceType":null,"InstanceType":null,"Spec":null}]}
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


示例值:rayjobspec-tcfoqk-wrzu
SpecName String

来源配置名称


示例值:rayjob-spec-6
AdvancedOptions String

高级参数


示例值:{"spec.submitterPodTemplate.metadata.labels.test":"test"}
Priority Integer

优先级


示例值:5
Tags Array of Tag

标签列表(TagKey-TagValue),用于将资源与腾讯云标签系统中的标签绑定

JobSource String

业务来源标识(调用上下文,长度上限 64,禁止控制字符)


示例值:workflow
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 基于配置运行作业

输入示例

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

{
    "SpecId": "rayjobspec-tcfoqk-wrzu"
}

输出示例

{
    "Response": {
        "AppId": 260090589,
        "AutoscalerOptions": "{\"upscalingMode\":\"Default\",\"idleTimeoutSeconds\":60,\"resourceSpec\":\"small\",\"resources\":{\"cpu\":\"500m\",\"memory\":\"512Mi\"}}",
        "Catalog": "{\"CFSVolumes\":[],\"COSVolumes\":[]}",
        "CreateTime": 1774406907461,
        "Entrypoint": "sleep 1",
        "Id": "rayjob-20260325104827-xevb",
        "Image": "ccr.ccs.tencentyun.com/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-cpu",
        "ImagePullPolicy": "IfNotPresent",
        "JobName": "rayjob-spec-6-20260325104827-xevb",
        "Queue": "default",
        "ResourceConfig": "{\"Head\":{\"Name\":\"Head\",\"PodCpu\":1,\"PodMem\":2,\"PodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"HighAvailability\":false,\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null},\"Worker\":[{\"Name\":\"Worker01\",\"PodCpu\":1,\"PodMem\":2,\"MinPodNum\":1,\"MaxPodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null}]}",
        "ResourcePartitionId": "dlc-p-ofvhyjzn",
        "RunningTime": 54,
        "RuntimeEnv": "{\"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\"}",
        "SpecId": "rayjobspec-tcfoqk-wrzu",
        "SpecName": "rayjob-spec-6",
        "Status": "SUBMITTED",
        "SubAccountUin": "700002467852",
        "Uin": "700002467852",
        "RequestId": "cbf62ed2-a3b4-4b59-9540-22802e05be6c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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