提交作业任务

最近更新时间:2025-10-31 02:13:21

我的收藏

1. 接口描述

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

本接口 (SubmitJob) 用于提交一个作业任务。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SubmitJob。
Version String 公共参数,本接口取值:2023-03-21。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 集群id
示例值:hpc-cy4pnyp9
Job Job 作业任务参数配置
QueueName String 队列名称。不指定则为默认队列:
SLURM默认队列为:compute。
SGE默认队列为:all.q。
示例值:compute

3. 输出参数

参数名称 类型 描述
JobId String 作业任务ID
示例值:job-xxxx
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 提交一个"hello world"作业任务

提交一个"hello world"作业任务

输入示例

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

{
    "ClusterId": "hpc-5fdafdsas",
    "Job": {
        "Tasks": [
            {
                "Application": {
                    "Commands": [
                        {
                            "Command": "echo hello world"
                        }
                    ],
                    "StorageMounts": [
                        {
                            "Source": "/mnt/",
                            "Target": "/data/"
                        }
                    ],
                    "EnvVars": [
                        {
                            "Name": "ENV",
                            "Value": "prod"
                        }
                    ],
                    "Docker": {
                        "Image": "test:test",
                        "RunArgs": [
                            "--privileged",
                            "--cap-add=IPC_LOCK",
                            "--net=host",
                            "--ipc=host",
                            " --gpus all"
                        ]
                    },
                    "OutputRedirect": {
                        "Driver": "local",
                        "Options": [
                            "stdout=/data/${BATCH_JOB_ID}.log",
                            "stderr=/data/${BATCH_JOB_ID}.log"
                        ]
                    }
                },
                "TaskName": "task-test-v1",
                "TaskInstanceNum": 2,
                "Timeout": 3600
            }
        ],
        "JobName": "hello world",
        "JobDescription": "job test",
        "Priority": 1
    },
    "QueueName": "compute"
}

输出示例

{
    "Response": {
        "JobId": "job-mudfdafada",
        "RequestId": "ef8a9572-db7f-450b-b736-265feffafda34"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter.Malformed 参数格式有误。
InvalidParameterValue.JobDescriptionTooLong The length of job description should less than %(max_size)s.
InvalidParameterValue.JobNameTooLong The length of job name should less than %(max_size)s.
InvalidParameterValue.TaskDependenciesUnfeasible Task dependencies unfeasible, please check.
InvalidParameterValue.ValueDuplicated 参数值重复。不支持此操作。
LimitExceeded.TaskInstanceNumLimit Task instance number %(max_count)s limit reached.
ResourceNotFound.ClusterId 集群不存在。
UnsupportedOperation.ClusterStatusNotSupport 该集群当前状态不支持该操作。