帮你快速理解、总结文档立即下载
文档中心>API 中心>数据湖计算 DLC>AI DLC 作业配置相关接口>获取作业配置详情

获取作业配置详情

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

我的收藏

本页目录：

1. 接口描述

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

根据配置ID获取作业配置详情

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

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

2. 输入参数

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

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

配置ID


示例值：rayjobspec-tcenff-ykws

3. 输出参数

参数名称 类型 描述
Id String

配置ID


示例值：rayjobspec-tcenff-ykws
Name String

配置名称


示例值：rayjob-spec-3
Description String

配置描述


示例值：rayjob-spec desc
Entrypoint String

入口命令


示例值：sleep 1
Image String

镜像地址


示例值：ccr.ccs.tencentyun.com/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-cpu
ImagePullType String

镜像拉取类型（Builtin: 内置, Custom: 自定义）


示例值：Builtin
ImagePullPolicy String

镜像拉取策略


示例值：IfNotPresent
ResourceConfig String

资源配置(JSON)


示例值：{"Head":{"Name":"Head","PodCpu":1,"PodMem":2,"GpuType":"","GpuNum":0,"Envs":[],"Labels":[],"PodNum":1,"HighAvailability":false},"Worker":[{"Name":"Worker01","PodCpu":1,"PodMem":2,"GpuType":"","GpuNum":0,"Envs":[],"Labels":[],"MinPodNum":1,"MaxPodNum":1}]}
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"}
Catalog String

存储卷和挂载卷配置(JSON)


示例值：{"CFSVolumes":[],"COSVolumes":[]}
AutoscalerOptions String

弹性伸缩配置(JSON)


示例值：{"upscalingMode":"Default","idleTimeoutSeconds":60,"resourceSpec":"small","resources":{"cpu":"500m","memory":"512Mi"}}
ResourceConfigId String

资源配置ID


示例值：ccbe672e-44be-4518-bcdf-ff85189f7059
ResourceConfigChanged Boolean

资源配置模板是否变更


注意：此字段可能返回 null，表示取不到有效值。
示例值：false
ResourcePartitionId String

默认资源分区ID


示例值：dlc-p-ofvhyjzn
ResourcePartitionName String

默认资源分区名称


注意：此字段可能返回 null，表示取不到有效值。
示例值：甘露-测试04
Queue String

默认队列名称


示例值：default
JobPackage String

作业包URL


示例值：https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260090589/20260324210556/b765a3a7-d630-46a5-bba3-866212d027d4.zip
JobPackageName String

作业包名称


示例值：test.zip
JobPackageSource String

作业包来源类型（Local: 本地上传, Cos: 用户自有 COS 桶地址）；缺省时按 Local 处理


示例值：Cos
AppId Integer

应用ID


示例值：1300057089
Uin String

创建者UIN


示例值：600000563453
SubAccountUin String

子用户UIN


示例值：600000563453
SubAccountName String

子用户名称（由聚合层通过 CAM 接口回填）


示例值：700002744585
CreateTime Integer

创建时间


示例值：1774358043010
UpdateTime Integer

更新时间


示例值：1774358043010
JobInstanceCount Integer

该配置产生的作业实例数量


示例值：0
HasRunningJobs Boolean

是否有运行中的作业实例


示例值：false
AdvancedOptions String

高级参数json


示例值：{"spec.rayClusterSpec.headGroupSpec.template.spec.tolerations":"[{"key":"dedicated","operator":"Equal","value":"ray","effect":"NoSchedule"}]"}
GroupId String

默认计算组名称（与 ClusterGroup 等价，新调用方使用 GroupId）


注意：此字段可能返回 null，表示取不到有效值。
示例值：rayclustergroup-tfodxh-vwro
ClusterId String

默认集群 ID（与 GroupId 互斥）


注意：此字段可能返回 null，表示取不到有效值。
示例值：raycluster-20260527172902-mfpk
Priority Integer

作业优先级（1-9，数字越大优先级越高）


注意：此字段可能返回 null，表示取不到有效值。
示例值：5
Tags Array of Tag

标签列表（TagKey-TagValue），用于将资源与腾讯云标签系统中的标签绑定
DispatchStrategy String

集群分派策略

枚举值：

  • RANDOM： 随机分配

示例值：RANDOM
SubmissionTarget String

作业提交目标

枚举值：

  • GROUP： 按计算组分派

示例值：GROUP
GroupName String

计算组名称


示例值：group-mao
ClusterName String

集群名称


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

4. 示例

示例1 获取作业配置详情

输入示例

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

{
    "SpecId": "rayjobspec-tcenff-ykws"
}

输出示例

{
    "Response": {
        "AppId": 1300057089,
        "AutoscalerOptions": "{\"upscalingMode\":\"Default\",\"idleTimeoutSeconds\":60,\"resourceSpec\":\"small\",\"resources\":{\"cpu\":\"500m\",\"memory\":\"512Mi\"}}",
        "Catalog": "{\"CFSVolumes\":[],\"COSVolumes\":[]}",
        "CreateTime": 1774358043010,
        "Description": "rayjob-spec desc",
        "Entrypoint": "sleep 1",
        "HasRunningJobs": false,
        "Id": "rayjobspec-tcenff-ykws",
        "Image": "ccr.ccs.tencentyun.com/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-cpu",
        "ImagePullPolicy": "IfNotPresent",
        "ImagePullType": "Builtin",
        "JobInstanceCount": 0,
        "JobPackage": "https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260090589/20260324210556/b765a3a7-d630-46a5-bba3-866212d027d4.zip",
        "JobPackageName": "test.zip",
        "Name": "rayjob-spec-3",
        "Queue": "default",
        "ResourceConfig": "{\"Head\":{\"Name\":\"Head\",\"PodCpu\":1,\"PodMem\":2,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"PodNum\":1,\"HighAvailability\":false},\"Worker\":[{\"Name\":\"Worker01\",\"PodCpu\":1,\"PodMem\":2,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"MinPodNum\":1,\"MaxPodNum\":1}]}",
        "ResourceConfigChanged": false,
        "ResourceConfigId": "ccbe672e-44be-4518-bcdf-ff85189f7059",
        "ResourcePartitionId": "dlc-p-ofvhyjzn",
        "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\"}",
        "SubAccountUin": "600000563453",
        "Uin": "600000563453",
        "UpdateTime": 1774358043010,
        "RequestId": "b7eba7d7-8a2d-4783-91fc-469af14da08c"
    }
}

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 外部服务异常
中国站