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

复制作业配置

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

我的收藏

1. 接口描述

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

复制一份已有的作业配置

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

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

2. 输入参数

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

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

原配置ID


示例值:rayjobspec-tcfoqk-wrzu
NewName String

新配置名称(可选,留空则自动命名为 '原名-copy')


示例值:test1111

3. 输出参数

参数名称 类型 描述
Id String

配置ID


示例值:rayjobspec-tcfqaq-hez2
Name String

配置名称


示例值:test1111
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

资源配置模板是否变更


示例值:false
ResourcePartitionId String

默认资源分区ID


示例值:dlc-p-ofvhyjzn
ResourcePartitionName String

默认资源分区名称


示例值:甘露-测试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
AppId Integer

应用ID


示例值:260090589
Uin String

创建者UIN


示例值:700002467852
CreateTime Integer

创建时间


示例值:1774408418323
UpdateTime Integer

更新时间


示例值:1774408418323
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: 随机分配
  • NULL: 无

示例值:RANDOM
SubmissionTarget String

作业提交目标:GROUP(按计算组分派)/ CLUSTER(指定集群)/ SERVERLESS(按 Serverless 拉起)

枚举值:

  • GROUP: 按计算组分派
  • CLUSTER: 指定集群
  • SERVERLESS: 按 Serverless 拉起

示例值: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: CopyJobSpec
<公共请求参数>

{
    "SpecId": "rayjobspec-tcfoqk-wrzu",
    "NewName": "test1111"
}

输出示例

{
    "Response": {
        "AppId": 260090589,
        "AutoscalerOptions": "{\"upscalingMode\":\"Default\",\"idleTimeoutSeconds\":60,\"resourceSpec\":\"small\",\"resources\":{\"cpu\":\"500m\",\"memory\":\"512Mi\"}}",
        "Catalog": "{\"CFSVolumes\":[],\"COSVolumes\":[]}",
        "CreateTime": 1774408418323,
        "Description": "rayjob-spec desc",
        "Entrypoint": "sleep 1",
        "HasRunningJobs": false,
        "Id": "rayjobspec-tcfqaq-hez2",
        "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": "test1111",
        "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",
        "ResourcePartitionName": "甘露-测试04",
        "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\"}",
        "Uin": "700002467852",
        "UpdateTime": 1774408418323,
        "RequestId": "77a17018-b964-419d-bc27-28065c537301"
    }
}

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