跳转至

创建任务

1. 接口描述

本接口用于创建一个任务实例。

2. 输入参数

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

参数名称 必选 类型 描述
namespace Number 任务所属空间
job.displayName String 任务显示名称
job.group String 任务所属工作组
job.workCluster String 指定任务执行的工作集群ID,参考 工作集群
job.workflow.uid String 指定任务执行的工作流模板ID
job.priority Number 任务的执行优先级

3. 输出参数

参数名称 必选 类型 描述
metadata Object 任务实体的元数据
name String 任务唯一标识
displayName String 任务显示名称
group String 任务所属工作组
workflow.uid String 指定任务执行的工作流模板ID
priority Number 任务的执行优先级
status Object 资源实体的状态信息
inputs Object 任务的输入参数
outputs Object 任务的输出参数
status.startedAt String 任务创建时间
status.finishedAt String 任务完成时间
argonWorkflow Object 任务对应的argo工作流模板

4. 示例

实例1 创建一个普通任务

ab413c83-573f-4a42-8a50-ab89d01563ce 空间下创建一个显示名称为 "常规任务bbb31937", 优先级为0,最大重试次数为2重试间隔为3s的普通计算任务

输入示例

POST /api/v1/namespaces/ab413c83-573f-4a42-8a50-ab89d01563ce/jobs
Body
    {
        "namespace": "ab413c83-573f-4a42-8a50-ab89d01563ce",
        "job": {
            "metadata": {},
            "displayName": "常规任务8406fba3",
            "group": "",
            "workflow": {
                "uid": "7b6f4fe7-f3eb-4771-9a4f-20c16f48d417"
            },
            "type": "normal",
            "inputs": [
                {
                    "id": "e1b60939",
                    "anchors": [
                        {
                            "source": "69096571",
                            "sourceAnchor": "5a100672"
                        }
                    ],
                    "displayName": "参数0",
                    "controls": "input",
                    "default": "{\"Records\":[{\"cos\":{\"cosNotificationId\":\"unkown\",\"cosSchemaVersion\":\"1.0\",\"cosBucket\":{\"appid\":\"1304062298\",\"region\":\"bj\",\"name\":\"hermes-video-converter\"},\"cosObject\":{\"key\":\"/1304062298/hermes-video-converter/video/source/chengzi/2021/03/25/deae7e2734ea4a169d58a60e98931af3.mp4\",\"size\":36976000,\"url\":\"http://hermes-video-converter-1304062298.cos.ap-beijing.myqcloud.com/video/source/chengzi/2021/03/25/deae7e2734ea4a169d58a60e98931af3.mp4\",\"meta\":{\"Content-Type\":\"\",\"x-cos-meta-context\":\"{\\\"callbackEnv\\\":\\\"online\\\",\\\"taskSource\\\":9,\\\"vid\\\":11459109}\",\"x-cos-request-id\":\"NjA1YmU5OThfOWJiNzJhMDlfOTE2M18yNWUxM2I=\"},\"vid\":\"\"}}}]}",
                    "type": "string"
                }
            ],
            "outputs": [
                {
                    "id": "8574175a",
                    "anchors": [
                        {
                            "source": "69096571",
                            "sourceAnchor": "411007f5"
                        }
                    ],
                    "displayName": "参数1",
                    "controls": "input",
                    "default": "/tmp",
                    "type": "string"
                }
            ],
            "priority": 0,
            "retryOption": {
                "maxretry": 2,
                "retryInterval": 3000
            },
            "namespace": "ab413c83-573f-4a42-8a50-ab89d01563ce",
            "workCluster": "b2143e29-4541-42b5-9b9e-649439790f08",
            "workspace": "9d10d32a-315d-4386-99ef-6b49313d7d55"
        }
    }

输出示例

   {
        "metadata": {
            "namespace": "ab413c83-573f-4a42-8a50-ab89d01563ce",
            "uid": "c7c688d9-82bc-423c-a900-8a74422faec1"
        },
        "name": "job-c7c688d9-82bc-423c-a900-8a74422faec1",
        "displayName": "常规任务8406fba3",
        "type": "normal",
        "workflow": {
            "uid": "7b6f4fe7-f3eb-4771-9a4f-20c16f48d417"
        },
        "inputs": [
            {
                "id": "e1b60939",
                "anchors": [
                    {
                        "source": "69096571",
                        "sourceAnchor": "5a100672"
                    }
                ],
                "displayName": "参数0",
                "controls": "input",
                "default": "{\"Records\":[{\"cos\":{\"cosNotificationId\":\"unkown\",\"cosSchemaVersion\":\"1.0\",\"cosBucket\":{\"appid\":\"1304062298\",\"region\":\"bj\",\"name\":\"hermes-video-converter\"},\"cosObject\":{\"key\":\"/1304062298/hermes-video-converter/video/source/chengzi/2021/03/25/deae7e2734ea4a169d58a60e98931af3.mp4\",\"size\":36976000,\"url\":\"http://hermes-video-converter-1304062298.cos.ap-beijing.myqcloud.com/video/source/chengzi/2021/03/25/deae7e2734ea4a169d58a60e98931af3.mp4\",\"meta\":{\"Content-Type\":\"\",\"x-cos-meta-context\":\"{\\\"callbackEnv\\\":\\\"online\\\",\\\"taskSource\\\":9,\\\"vid\\\":11459109}\",\"x-cos-request-id\":\"NjA1YmU5OThfOWJiNzJhMDlfOTE2M18yNWUxM2I=\"},\"vid\":\"\"}}}]}",
                "type": "string"
            }
        ],
        "outputs": [
            {
                "id": "8574175a",
                "anchors": [
                    {
                        "source": "69096571",
                        "sourceAnchor": "411007f5"
                    }
                ],
                "displayName": "参数1",
                "controls": "input",
                "default": "/tmp",
                "type": "string"
            }
        ],
        "priority": 0,
        "retryOption": {
            "maxRetry": 2,
            "retryInterval": 3000
        },
        "argoWorkflow": {
            "name": "build-from-job-c7c688d9-82bc-423c-a900-8a74422faec1-r4xs8",
            "spec": {
                "templates": [
                    {
                        "name": "template-69096571",
                        "arguments": {},
                        "inputs": {
                            "parameters": [
                                {
                                    "name": "out",
                                    "value": "{{workflow.parameters.8574175a}}"
                                },
                                {
                                    "name": "cos_event",
                                    "value": "{{workflow.parameters.e1b60939}}"
                                }
                            ]
                        },
                        "outputs": {
                            "parameters": [
                                {
                                    "name": "out",
                                    "valueFrom": {
                                        "path": "/tmp/argon.outputs.out"
                                    }
                                }
                            ]
                        },
                        "metadata": {
                            "annotations": {
                                "multicluster.admiralty.io/elect": ""
                            }
                        },
                        "container": {
                            "name": "",
                            "image": "hub.imgo.tv/mtc/chengzi",
                            "command": [
                                "/opt/chengzi",
                                "-e",
                                "{{inputs.parameters.cos_event}}"
                            ],
                            "resources": {},
                            "volumeMounts": [
                                {
                                    "name": "workdir",
                                    "mountPath": "/data/argon/"
                                }
                            ],
                            "imagePullPolicy": "IfNotPresent"
                        }
                    }
                ],
                "entrypoint": "template-69096571",
                "arguments": {
                    "parameters": [
                        {
                            "name": "e1b60939",
                            "value": "{\"Records\":[{\"cos\":{\"cosNotificationId\":\"unkown\",\"cosSchemaVersion\":\"1.0\",\"cosBucket\":{\"appid\":\"1304062298\",\"region\":\"bj\",\"name\":\"hermes-video-converter\"},\"cosObject\":{\"key\":\"/1304062298/hermes-video-converter/video/source/chengzi/2021/03/25/deae7e2734ea4a169d58a60e98931af3.mp4\",\"size\":36976000,\"url\":\"http://hermes-video-converter-1304062298.cos.ap-beijing.myqcloud.com/video/source/chengzi/2021/03/25/deae7e2734ea4a169d58a60e98931af3.mp4\",\"meta\":{\"Content-Type\":\"\",\"x-cos-meta-context\":\"{\\\"callbackEnv\\\":\\\"online\\\",\\\"taskSource\\\":9,\\\"vid\\\":11459109}\",\"x-cos-request-id\":\"NjA1YmU5OThfOWJiNzJhMDlfOTE2M18yNWUxM2I=\"},\"vid\":\"\"}}}]}"
                        },
                        {
                            "name": "8574175a",
                            "value": "/tmp"
                        }
                    ]
                },
                "serviceAccountName": "argon-argo-workflow",
                "volumes": [
                    {
                        "name": "workdir",
                        "persistentVolumeClaim": {
                            "claimName": "argon-pvc"
                        }
                    }
                ],
                "nodeSelector": {
                    "argon-virtual-cluster/admiralty": "admiralty-tencent-tke"
                },
                "priority": 0
            }
        },
        "workspace": "9d10d32a-315d-4386-99ef-6b49313d7d55",
        "workCluster": "b2143e29-4541-42b5-9b9e-649439790f08",
        "status": {
            "startedAt": "2021-04-02T03:43:39Z",
            "finishedAt": null
        }
    }

实例2 创建一个带回调接口的任务

实例3 创建一个定时执行的任务