文档

CreateRun - 创建运行任务

工作空间中创建运行任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
easygene:CreateRun
  • Run
    acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/*

请求参数

名称类型必填描述示例值
Workspacestring

工作空间名字

test-workspace
RunNamestring

任务名称

wgs_sentieon_hc_with_qc_NGPTS1900029301
AppNamestring

应用名称

Sentieon
AppRevisionstring

应用版本号

16
RevisionTagstring

应用版本唯一标签

ProduceVersion
Descriptionstring

任务描述

test run
Labelsstring

任务标签

{"env": "test"}
ExecuteOptionsobject

任务配置

CallCachingboolean

是否开启 CallCaching

True
DeleteIntermediateResultsboolean

是否删除中间文件

True
FailureModestring

失败模式

NoNewCalls
UseRelativeOutputPathsboolean

使用相对输出路径

True
ExecuteDirectorystring

任务执行目录

oss://my-bucket/exec/
Rolestring

可选参数,用户自定义的 RAM Role,在任务运行过程中,通过扮演这个 Role 访问用户的资源,如 OSS,ACR 等。如果不指定,使用默认的 aliyuneasygenedefaultrole

TestRole
OutputFolderstring

任务输出拷贝目录

oss://my-bucket/output/
DefaultRuntimestring

默认运行时

{}
Inputsstring

任务输入

{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }
ClientTokenstring

任务幂等 token

MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

DA980AD0-158F-44F3-847D-5EAB96C0EB6B
HostIdstring

主机 ID

easygene.cn-beijing.aliyuncs.com
Workspacestring

工作空间

test-workspace
RunIdstring

任务 ID

run-13BeYuxc0fxO24uA75UppTiMRoQ

示例

正常返回示例

JSON格式

{
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "Workspace": "test-workspace",
  "RunId": "run-13BeYuxc0fxO24uA75UppTiMRoQ"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter %s is invalid.无效的参数
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.缺少必要的参数
404InvalidUser.NotFoundThe specified user is not found.找不到该用户信息,请先购买开通基因云产品

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-12OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:RevisionTag
  • 本页导读 (0)
文档反馈