文档

ListRuns - 获取运行任务列表

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

工作空间

test-workspace
Statusstring

状态

Running
SubmissionIdstring

提交 ID

sub-13BeXWnGvrOl3MC124tazcJVKaV
Searchstring

搜索 ID

run-13BeYuxc0fxO24uA75UppTiMRoQ
LabelSelectorstring

标签选择

env=test
AppNamestring

应用名称

MyApp
AppRevisionstring

应用的版本

4.1.4.1-v1.0
EntityTypestring

实体类型

sample
EntityNamestring

实体元素名称

S001
NextTokenstring

查询起始位置

MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK
MaxResultsinteger

最大返回个数

10
OrderBystring

排序依据

createtime
IsReversedboolean

是否逆序

false
GetTotalboolean

是否返回所有任务条数

false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

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

主机 ID

easygene.cn-beijing.aliyuncs.com
MaxResultsinteger

最大返回结果

10
NextTokenstring

下次查询 Token

MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK
TotalCountinteger

返回个数

10
Runsobject []

任务列表

AppNamestring

应用名称

MyApp
Sourcestring

应用来源

EasyGene
Labelsobject

任务标签

string

标签

test
RunNamestring

任务名称

test-run
AppRevisionstring

应用版本号

1
RunIdstring

任务 ID

run-13BeYuxc0fxO24uA75UppTiMRoQ
Statusstring

任务状态

Running
CreateTimestring

提交时间

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

开始时间

2021-06-10T13:31:20.414557061Z
EndTimestring

结束时间

2021-06-10T13:38:20.414557061Z
SubmissionIdstring

提交 ID

sub-13BeXWnGvrOl3MC124tazcJVKaV
EntityNamestring

实体名称

s1
EntityTypestring

实体对象 ID

sample
ExecuteDirectorystring

运行目录

oss://my-bucket/my-execdir/
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" }
DefaultRuntimestring

默认运行时

{}
Workspacestring

工作空间

test-workspace
RegionIdstring

区域

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错误码错误信息描述
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)
文档反馈