调用ListRuns获取运行任务列表_基因分析平台-阿里云帮助中心

获取工作空间下运行任务列表。

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

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

请求参数

名称	类型	必填	描述	示例值
Workspace	string	是	工作空间	test-workspace
Status	string	否	状态	Running
SubmissionId	string	否	提交 ID	sub-13BeXWnGvrOl3MC124tazcJVKaV
Search	string	否	搜索 ID	run-13BeYuxc0fxO24uA75UppTiMRoQ
LabelSelector	string	否	标签选择	env=test
AppName	string	否	应用名称	MyApp
AppRevision	string	否	应用的版本	4.1.4.1-v1.0
EntityType	string	否	实体类型	sample
EntityName	string	否	实体元素名称	S001
NextToken	string	否	查询起始位置	MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK
MaxResults	integer	否	最大返回个数	10
OrderBy	string	否	排序依据	createtime
IsReversed	boolean	否	是否逆序	false
GetTotal	boolean	否	是否返回所有任务条数	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	DA980AD0-158F-44F3-847D-5EAB96C0EB6B
HostId	string	主机 ID	easygene.cn-beijing.aliyuncs.com
MaxResults	integer	最大返回结果	10
NextToken	string	下次查询 Token	MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK
TotalCount	integer	返回个数	10
Runs	array<object>	任务列表
	object	任务列表
AppName	string	应用名称	MyApp
Source	string	应用来源	EasyGene
Labels	object	任务标签
	string	标签	test
RunName	string	任务名称	test-run
AppRevision	string	应用版本号	1
RunId	string	任务 ID	run-13BeYuxc0fxO24uA75UppTiMRoQ
Status	string	任务状态	Running
CreateTime	string	提交时间	2021-06-10T13:30:20.414557061Z
StartTime	string	开始时间	2021-06-10T13:31:20.414557061Z
EndTime	string	结束时间	2021-06-10T13:38:20.414557061Z
SubmissionId	string	提交 ID	sub-13BeXWnGvrOl3MC124tazcJVKaV
EntityName	string	实体名称	s1
EntityType	string	实体对象 ID	sample
ExecuteDirectory	string	运行目录	oss://my-bucket/my-execdir/
ExecuteOptions	object	执行选项
CallCaching	boolean	是否开启 CallCaching	false
DeleteIntermediateResults	boolean	是否删除中间文件	false
FailureMode	string	失败模式	NoNewCalls
UseRelativeOutputPaths	boolean	使用相对路径	false
Inputs	string	输入参数	{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }
DefaultRuntime	string	默认运行时	{}
Workspace	string	工作空间	test-workspace
RegionId	string	区域	cn-beijing

示例

正常返回示例

JSON格式

{
  "RequestId": "DA980AD0-158F-44F3-847D-5EAB96C0EB6B",
  "HostId": "easygene.cn-beijing.aliyuncs.com",
  "MaxResults": 10,
  "NextToken": "MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK",
  "TotalCount": 10,
  "Runs": [
    {
      "AppName": "MyApp",
      "Source": "EasyGene",
      "Labels": {
        "key": "test"
      },
      "RunName": "test-run",
      "AppRevision": "1",
      "RunId": "run-13BeYuxc0fxO24uA75UppTiMRoQ",
      "Status": "Running",
      "CreateTime": "2021-06-10T13:30:20.414557061Z",
      "StartTime": "2021-06-10T13:31:20.414557061Z",
      "EndTime": "2021-06-10T13:38:20.414557061Z",
      "SubmissionId": "sub-13BeXWnGvrOl3MC124tazcJVKaV",
      "EntityName": "s1",
      "EntityType": "sample",
      "ExecuteDirectory": "oss://my-bucket/my-execdir/",
      "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\" }",
      "DefaultRuntime": "{}",
      "Workspace": "test-workspace",
      "RegionId": "cn-beijing"
    }
  ]
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史