文档首页 > > Python SDK参考> GCS接口> GCS流程执行> 创建execution

创建execution

分享
更新时间: 2019/10/28 GMT+08:00

create_execution(name, workflow_id, sfs_pvc_name, cluster_id="", priority=0, inputs_json={}, namespace="", timeout=720, description="", email=[], sms=[], events=["exec_failed", "exec_succeeded"], email_message="", email_subject="", email_display_name="", sms_message="", image_pull_policy="IfNotPresent", job_retry_count=3, target="cci")

功能描述

开始执行测序流程。

输入参数

表1 输入参数

参数

是否必选

参数类型

参数描述

name

String

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

workflow_id

String

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

cluster_id

String

集群ID,通过get_environments或者get_environment(environment_id)获取。默认为空,创建基于CCE的execution时必选。

sfs_pvc_name

String

高速共享存储PVC名称。

  • 环境为CCI时,请打开CCI控制台,在左侧导航选择“存储管理>文件存储卷”,选择环境所设置的命名空间,通过“文件存储名”即可获取到“卷名”,即PVC名称。

  • 环境为CCE时,请在基因容器控制台按下图方法获取。

priority

Int64

execution创建操作优先级,取值范围[0,999](包括0和999),0表示优先级最低,999表示优先级最高,默认值为0。

namespace

String

若target为“cce”,该字段表示云容器引擎(CCE)中已存在的命名空间,如果为空,则默认为default;若target为“cci”,该字段表示云容器实例(CCI)中已存在的命名空间且为必填字段。

description

String

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

inputs_json

Map

流程输入参数,当为空时,使用流程文件的inputs中定义的默认值,否则替换流程文件中的inputs值,例如{"key1":"value1", "key2":"value2"}。

timeout

Int64

超时时间,单位为分钟,如果不填,则默认是720分钟。

email

Array

接收者邮件列表,每个元素为一个接收者邮件地址。

sms

Array

接收者短信列表,每个元素为一个接收者手机号。

events

Array

通知触发事件列表,可选值为:

  • exec_failed:execution执行失败时发送通知。
  • exec_succeeded:execution执行成功时发送通知。

email_message

String

自定义邮件模板,默认为空,最大长度为360个字符。支持guid/name/status三个默认参数,例如:"这是一条简单的模板,execution的ID为{guid},execution的名称为{name},当前的状态为{status}“。

email_subject

String

自定义邮件主题,默认为空。

email_display_name

String

自定义邮件发送者,默认为空。建议设置为具有意义的发送者,不采用默认值。

sms_message

String

自定义短信模板,默认为空。最大长度为360个字符。支持guid/name/status三个默认参数,例如:"这是一条简单的模板,execution的ID为{guid},execution的名称为{name},当前的状态为{status}“。

image_pull_policy

String

镜像拉取策略,可选值为:

  • IfNotPresent:本地镜像不存在时,从镜像库重新拉取镜像。
  • Always:总是从镜像库重新拉取镜像。
  • Never:不管镜像存不存在,都不从镜像库重新拉取镜像。

job_retry_count

Int64

Job失败时的重试次数,默认3次

target

String

execution运行环境的类型,默认为“cci”,可选值为:

  • cci:创建基于CCI的execution。
  • cce:创建基于CCE的execution。

返回值

参数

参数类型

参数描述

id

String

执行ID。

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区