文档首页 > > API参考> API> Execution> 创建execution

创建execution

分享
更新时间: 2019/11/18 GMT+08:00

功能介绍

开始执行测序流程。

URI

POST /v1/executions

请求消息

请求参数

请求参数如表1所示。

表1 请求参数

参数

是否必选

参数类型

描述

name

String

执行结果名称。

输入字符最大长度为63字节,以小写字母开头,允许出现中划线(-)、数字和小写字母,且必须以小写字母或数字结尾。

cluster_id

String

如果使用已有集群,此处填写执行测序所使用的集群ID。

workflow_id

String

执行测序所使用的流程ID。

sfs_pvc_name

String

sfs存储名称。

namespace

String

cce集群下可用namespace/cci命名空间。如果为空,则cce默认为default namespace。

description

String

执行结果的描述,如果为空,则执行结果的描述为空。

取值范围:输入字符最大长度为255,中文算单个字符,不能包含<>#%&字符。

inputs_json

Object

流程输入参数,当为空时,将使用流程文件的inputs中定义的默认值。

timeout

Integer64

超时时间,如果不填,则默认是1440分钟。

priority

Integer64

execution的调度优先级。默认值为0,取值范围[0,999]。数据越大优先越高。

target

String

execution执行的环境类型。

  • cce
  • cci

label

Object

execution的标签,可自定义,样式为“key:value”。

notification

表2

execution执行结束时发送通知的配置。

advanced_options

表3

高级配置,如设置镜像拉取策略。

ref_bucket_name

String

参考组obs桶名名称。

data_bucket_name

String

数据obs桶名称。

表2 notification

参数

是否必选

参数类型

描述

events

Array of string

触发通知的事件,支持execution执行失败和成功时发送通知。

取值范围:

  • exec_failed
  • exec_succeeded

endpoints

表4

通知接收终端配置,可选项为邮件和短信。

表3 advanced_options

参数

是否必选

参数类型

描述

image_pull_policy

String

镜像拉取策略。默认IfNotPresent。支持选项:

  • IfNotPresent:在镜像已存在时,不再拉取镜像;
  • Always:总是拉取镜像;
  • Never:不再拉取镜像。

job_retry_count

String

job重试次数。cce默认为3次,cci默认为0次。

取值范围:大于0的整数。

表4 endpoints

参数

是否必选

参数类型

描述

email

Array of string

通知接受者邮箱地址列表。

sms

Array of string

通知接受者手机号列表。

请求示例

POST /v1/executions HTTP/1.1 
Host:Host Server   
Content-Type:application/json
{
    "name": "gcs-execution",
    "workflow_id": "3323db80-d1f6-9295-e8be-0242cdfc38e9",
    "cluster_id": "b2d6bb38-a065-11e8-b0e6-0255ac105768",
    "inputs_json": {
        "cpu": "4c",
	"memory": "32G",
    },
    "sfs_pvc_name": "gene-sfs-1111",
    "timeout": 1440,
    "target": "cce"
}

响应消息

响应参数

请求成功的响应参数如表5所示。

表5 成功响应参数

参数

参数类型

描述

id

String

执行结果ID。

响应示例

{
    "id": "e19d3faf-9f04-9685-e5c0-fbe8d40b96cd"
}

请求失败的响应参数如表9所示。

状态码

  • 正常

    状态码如表6所示。

表6 状态码

状态码

描述

201

创建执行结果成功。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区