更新时间:2024-05-09 GMT+08:00
分享

获取流程详情

功能介绍

获取流程详情

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/nextflow/workflows/{workflow_id}

表1 路径参数

参数

是否必选

参数类型

描述

eihealth_project_id

String

平台项目ID,您可以在平台单击所需的项目名称,进入项目设置页面查看。

最小长度:1

最大长度:128

project_id

String

华为云项目ID,您可以从获取项目ID中获取。

最小长度:1

最大长度:128

workflow_id

String

流程id

最小长度:1

最大长度:128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

最小长度:1

最大长度:32768

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

流程id

name

String

流程名称

description

String

流程描述

labels

Array of strings

流程标签

workflow_file

String

流程的文件名

workflow_file_url

String

流程的文件名下载地址

main_file

String

主文件名

params_file

String

用户上传时使用的参数文件名

params

Array of NextflowParamsDto objects

流程参数列表

create_time

String

流程的创建时间

update_time

String

流程的更新时间

source_project_name

String

源项目名称

source_resource_id

String

源资源id

表4 NextflowParamsDto

参数

参数类型

描述

name

String

参数名

最小长度:1

最大长度:1024

value

String

参数值

最小长度:0

最大长度:65535

type

String

参数类型,取值[Other|File|Directory]

最小长度:0

最大长度:20

description

String

参数描述。取值范围:[0-255]

最小长度:0

最大长度:255

required

Boolean

参数是否必填

请求示例

响应示例

状态码: 200

OK

{
  "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
  "name" : "demo-workflow",
  "description" : "description",
  "labels" : [ "labelA", "labelB" ],
  "create_time" : "2021-01-30T02:34:36Z",
  "update_time" : "2021-01-30T02:53:26Z",
  "workflow_file" : "workflow.zip",
  "workflow_file_url" : "https://workflow.zip",
  "main_file" : "main.nf",
  "params_file" : "p1.yaml",
  "source_project_name" : "src",
  "source_resource_id" : "src-id",
  "params" : [ {
    "name" : "p1",
    "value" : "hello",
    "type" : "Other",
    "description" : "desc",
    "required" : true
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档