文档首页/ 基因容器 GCS/ API参考/ API/ Execution/ 批量创建execution
更新时间:2022-06-15 GMT+08:00
分享

批量创建execution

功能介绍

批量执行测序流程。该接口使用同一流程模板批量创建多个execution,每个execution可以单独指定inputs参数。批量创建execution的数量上限为50

URI

POST /v1/executions_iter

请求消息

请求参数

请求参数如表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_list

Array of object

流程输入参数。

数组元素个数表明批量创建execution的数量,数组内元素个数不能超过50。

数组内参数为单个execution的输入参数,当为空时,将使用流程文件中定义的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桶名称。

enterprise_project_id

String

企业项目id,默认为"0"

表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_iter HTTP/1.1 
Host:Host Server   
Content-Type:application/json
{
	"name": "gcs-execution-batch",
	"workflow_id": "272c9d24-4562-3fa7-050a-8c5b39d6f81a",
	"inputs_json_list": [{
		"cpu": "0.5c",
		"memory": "2G"
	},
	{
		"cpu": "0.25c",
		"memory": "1G"
	}],
	"sfs_pvc_name": "cce-efs",
	"timeout": 1440,
	"priority": 0,
	"advanced_options": {
		"job_retry_count": "3"
	},
	"data_bucket_name": "gene-container-data",
	"cluster_id": "89541b29-5f56-11e9-850d-0255ac1001a9",
	"target": "cce",
        "enterprise_project_id":"0"
}

响应消息

响应参数

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

表5 成功响应参数

参数

参数类型

描述

executions

Array of 表6 objects

执行结果

表6 executions详细信息

参数

参数类型

描述

id

String

execution GUID

error

表9 Object

错误信息,如果execution创建成功,该字段返回为空,创建失败,展示错误详情

响应示例

{
  "executions": [
    {
      "id": "edbd357f-a3ac-11e9-b509-0255ac100860"
    },
    {
      "id": "ee0603be-a3ac-11e9-b509-0255ac100860"
    }
  ]
}

状态码

  • 正常

    状态码如表7所示。

    表7 状态码

    状态码

    描述

    201

    创建执行结果成功

相关文档