工作空间中创建运行任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
easygene:CreateRun | create | *Run acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Workspace | string | 是 | 工作空间名字 | test-workspace |
RunName | string | 否 | 任务名称 | wgs_sentieon_hc_with_qc_NGPTS1900029301 |
AppName | string | 是 | 应用名称 | Sentieon |
AppRevision | string | 否 | 应用版本号 | 16 |
RevisionTag | string | 否 | 应用版本唯一标签 | ProduceVersion |
Description | string | 否 | 任务描述 | test run |
Labels | string | 否 | 任务标签 | {"env": "test"} |
ExecuteOptions | object | 否 | 任务配置 | |
CallCaching | boolean | 否 | 是否开启 CallCaching | True |
DeleteIntermediateResults | boolean | 否 | 是否删除中间文件 | True |
FailureMode | string | 否 | 失败模式 | NoNewCalls |
UseRelativeOutputPaths | boolean | 否 | 使用相对输出路径 | True |
ExecuteDirectory | string | 否 | 任务执行目录 | oss://my-bucket/exec/ |
Role | string | 否 | 可选参数,用户自定义的 RAM Role,在任务运行过程中,通过扮演这个 Role 访问用户的资源,如 OSS,ACR 等。如果不指定,使用默认的 aliyuneasygenedefaultrole | TestRole |
OutputFolder | string | 否 | 任务输出拷贝目录 | oss://my-bucket/output/ |
DefaultRuntime | string | 否 | 默认运行时 | {} |
Inputs | string | 是 | 任务输入 | { "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" } |
ClientToken | string | 否 | 任务幂等 token | MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
"HostId": "easygene.cn-beijing.aliyuncs.com",
"Workspace": "test-workspace",
"RunId": "run-13BeYuxc0fxO24uA75UppTiMRoQ"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter %s is invalid. | 无效的参数 |
400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. | 缺少必要的参数 |
404 | InvalidUser.NotFound | The specified user is not found. | 找不到该用户信息,请先购买开通基因云产品 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-10 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-01-12 | OpenAPI 入参发生变更 | 查看变更详情 |