GetRun_基因分析平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
easygene:GetRun
Get
Run
acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/{#RunId}

请求参数

字段名称字段详情
Workspacestring

工作空间名字

示例值:default-workspace参考取值来源:
    ListWorkspaces
    CreateWorkspace
RunIdstring

任务 ID

示例值:run-12kDbbqp5O9dfsH0sEdQeRclGQb参考取值来源:
    ListRuns
    CreateRun

返回参数

字段名称字段详情
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

任务配置

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" }
Labelsmap<string>

任务标签

OutputFolderstring

输出拷贝目录

示例值:oss://my-bucket/output/
ExecuteDirectorystring

任务执行目录

示例值:oss://my-bucket/exec/
DefaultRuntimestring

默认 runtime 值

示例值:{}
Descriptionstring

任务描述

示例值:test run
Timingstring

时序信息

示例值:{}
Callsstring

作业信息

示例值:{}
Failuresstring

错误信息

示例值:{}
BillingInstanceIdsarray<string>

任务 task 账单 ID 数组

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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
变更返回参数
2024-04-07
变更返回参数
2021-04-22
删除请求参数Attributes
变更请求参数Workspace
变更请求参数RunId
变更返回参数

相关示例