You need to enable JavaScript to run this app.
导航
生信操作系统Bio-OS
  • 文档首页
    • /
  • 生信操作系统Bio-OS

ListSubmissions

最近更新时间：2024.01.04 09:53:15

首次发布时间：2023.02.10 20:00:03

我的收藏
ListSubmissions

查询工作流投递列表

接口说明

模块：投递管理
类型：open
场景：公有云

请求参数

参数名称类型是否必选示例值描述
ActionString是ListSubmissions公共参数，本接口值：ListSubmissions
VersionString是2021-03-04公共参数，本接口值：2021-03-04
PageNumberInteger否1分页页码
PageSizeInteger否10分页页长
FilterObject
ListSubmissionsFilter		否筛选条件
WorkspaceIDString是wcxxxxxxxxxxxxxxxxxxx工作空间 ID

ListSubmissionsFilter

参数名称类型是否必选示例值描述
WorkflowIDString否fcxxxxxxxxxxxxxxxxxxx工作流 ID
StatusArray of String否["Running"]状态 Running Succeeded Failed Cancelled Cancelling
ClusterIDString否ucxxxxxxxxxxxxxxxxxxx集群 ID
KeywordString否模糊匹配名称
IDsArray of String否根据ID查询

请求示例

POST /?Action=ListSubmissions&Version=2021-03-04
Content-Type:application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "WorkflowID": "fcxxxxxxxxxxxxxxxxxxx",
        "Status": ["Running"],
        "ClusterID": "ucxxxxxxxxxxxxxxxxxxx",
        "Keyword": "xxxxxxxx",
        "IDs": ["xxxxxxxx"]
    },
    "WorkspaceID": "wcxxxxxxxxxxxxxxxxxxx"
}

返回参数

参数名称类型示例值描述
ItemsArray of SubmissionsItem投递记录列表
PageNumberInteger1分页页码
PageSizeInteger10分页页长
TotalCountInteger10总条数

SubmissionsItem

参数名称类型示例值描述
IDStringscxxxxxxxxxxxxxxxxxxx投递记录 ID
NameStringname投递记录名称
DescriptionStringdescription投递记录描述
StatusStringSucceeded投递记录状态 Succeeded,Failed,Running,Cancelled,Cancelling
RunStatusObject
RunStatus		工作流运行状态统计
StartTimeObject
Timestamp		1673525239起始时间
FinishTimeObject
Timestamp		1673525239截止时间
DurationLong10分析耗时(单位为s)
WorkflowIDStringfcxxxxxxxxxxxxxxxxxxx工作流 ID
ClusterIDStringucxxxxxxxxxxxxxxxxxxx集群 ID
ClusterTypeStringvolc-vke集群类型 volc-vke, external, shared 若集群已不存在则为空
DataModelIDStringdcxxxxxxxxxxxxxxxxxxx数据实体ID
InputsString{"test.name1":"this.name1","test.name2":"this.name2","test.request":"this.requestFile"}输入配置，json 序列化后的 string
OutputsString{"test.response1":"this.response1","test.response2":"this.response2"}输出配置，json 序列化后的 string
ExposedOptionsObject
ExposedOptions		平台暴露的 Workflow Options
OwnerNameStringname创建者名称
DataEntityObject
DataEntity		数据实体统计

RunStatus

参数名称类型示例值描述
CountLong1工作流运行统计
SucceededLong1运行成功的工作流运行总数
FailedLong1运行失败的工作流运行总数
RunningLong1运行中的工作流运行总数
PendingLong1启动中的工作流运行总数
CancellingLong1终止中的工作流运行总数
CancelledLong1已终止的工作流运行总数

ExposedOptions

参数名称类型示例值描述
ReadFromCacheBooleanfalse是否开启读 call-cache 功能
ExecutionRootDirString/root工作流执行根路径

DataEntity

参数名称类型示例值描述
IDStringdxxxxxxxxxxxxxxxxxxxx数据实体 ID
NameStringname数据实体名称
RowIDsArray of String["1"]数据实体行 IDs

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "ListSubmissions",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "ID": "scxxxxxxxxxxxxxxxxxxx",
                "Name": "name",
                "Description": "description",
                "Status": "Succeeded",
                "RunStatus": {
                    "Count": 1,
                    "Succeeded": 1,
                    "Failed": 1,
                    "Running": 1,
                    "Pending": 1,
                    "Cancelling": 1,
                    "Cancelled": 1
                },
                "StartTime": ,
                "FinishTime": ,
                "Duration": 10,
                "WorkflowID": "fcxxxxxxxxxxxxxxxxxxx",
                "ClusterID": "ucxxxxxxxxxxxxxxxxxxx",
                "ClusterType": "volc-vke",
                "DataModelID": "dcxxxxxxxxxxxxxxxxxxx",
                "Inputs": "{\"test.name1\":\"this.name1\",\"test.name2\":\"this.name2\",\"test.request\":\"this.requestFile\"}",
                "Outputs": "{\"test.response1\":\"this.response1\",\"test.response2\":\"this.response2\"}",
                "ExposedOptions": {
                    "ReadFromCache": false,
                    "ExecutionRootDir": "/root"
                },
                "OwnerName": "name",
                "DataEntity": {
                    "ID": "dxxxxxxxxxxxxxxxxxxxx",
                    "Name": "name",
                    "RowIDs": ["1"]
                }
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 10
    }
}

错误码

HTTP 状态码错误码错误信息描述
400ParamErr<透传错误内容>参数错误
500InternalErr<透传错误内容>内部错误