文档

GetRun - GetRun

更新时间:

查询工作空间下特定运行任务详情。

调试

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

授权信息

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

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

请求参数

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

工作空间名字

default-workspace
RunIdstring

任务 ID

run-12kDbbqp5O9dfsH0sEdQeRclGQb

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

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

主机 ID

easygene.cn-beijing.aliyuncs.com
Workspacestring

工作空间名字

test-workspace
RunIdstring

任务 ID

run-13BeYuxc0fxO24uA75UppTiMRoQ
RunNamestring

任务名称

test-run
SubmissionIdstring

提交 ID

sub-13BeXWnGvrOl3MC124tazcJVKaV
Sourcestring

应用来源

EasyGene
AppNamestring

应用名称

Sentieon
AppRevisionstring

应用版本

1
EntityTypestring

实体类型

sample
EntityNamestring

实体对象名称

s1
Userstring

用户 ID

13579222
Statusstring

任务状态

Running
CreateTimestring

提交时间

2021-06-10T13:30:20.414557061Z
StartTimestring

开始时间

2021-06-10T13:30:24.414557061Z
EndTimestring

结束时间

2021-06-10T13:36:20.405878292Z
ExecuteOptionsobject

任务配置

CallCachingboolean

是否开启 CallCaching

false
DeleteIntermediateResultsboolean

是否删除中间文件

false
FailureModestring

失败模式

NoNewCalls
UseRelativeOutputPathsboolean

相对输出路径

false
Inputsstring

任务输入

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

任务输出

{ "workflow1.bam": "oss://my-bucket/test.bam", "workflow1.vcf": "oss://my-bucket/test.vcf" }
Labelsobject

任务标签

string

标签

test
OutputFolderstring

输出拷贝目录

oss://my-bucket/output/
ExecuteDirectorystring

任务执行目录

oss://my-bucket/exec/
DefaultRuntimestring

默认 runtime 值

{}
Descriptionstring

任务描述

test run
Timingstring

时序信息

{}
Callsstring

作业信息

{}
Failuresstring

错误信息

{}

示例

正常返回示例

JSON格式

{
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "Workspace": "test-workspace",
  "RunId": "run-13BeYuxc0fxO24uA75UppTiMRoQ",
  "RunName": "test-run",
  "SubmissionId": "sub-13BeXWnGvrOl3MC124tazcJVKaV",
  "Source": "EasyGene",
  "AppName": "Sentieon",
  "AppRevision": "1",
  "EntityType": "sample",
  "EntityName": "s1",
  "User": "13579222",
  "Status": "Running",
  "CreateTime": "2021-06-10T13:30:20.414557061Z",
  "StartTime": "2021-06-10T13:30:24.414557061Z",
  "EndTime": "2021-06-10T13:36:20.405878292Z",
  "ExecuteOptions": {
    "CallCaching": false,
    "DeleteIntermediateResults": false,
    "FailureMode": "NoNewCalls",
    "UseRelativeOutputPaths": false
  },
  "Inputs": "{     \"workflow1.task1.param1\": \"helloooo.txt\",     \"workflow1.task1.param2\": \"abc\",     \"workflow1.task2.param1\": \"new_helloooo.txt\",     \"workflow1.task2.param2\": \"def\" }",
  "Outputs": "{         \"workflow1.bam\": \"oss://my-bucket/test.bam\",         \"workflow1.vcf\": \"oss://my-bucket/test.vcf\"     }",
  "Labels": {
    "key": "test"
  },
  "OutputFolder": "oss://my-bucket/output/",
  "ExecuteDirectory": "oss://my-bucket/exec/",
  "DefaultRuntime": "{}",
  "Description": "test run",
  "Timing": "{}",
  "Calls": "{}",
  "Failures": "{}"
}

错误码

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.找不到该用户信息,请先购买开通基因云产品

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈