DescirbeWorkflow - 查询已创建的所有工作流-阿里云帮助中心

调用DescribeWorkflow查询单个工作流的详细信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cs:DescirbeWorkflow	Read	全部资源 acs:cs::{#accountId}:	无	无

请求语法

GET /gs/workflow/{workflowName}

请求参数

名称	类型	必填	描述	示例值
workflowName	string	是	工作流名称	mapping-gpu-mhhgh

返回参数

名称	类型	描述	示例值
	object	返回体参数。
create_time	string	工作流创建时间。	2020-01-15 16:30:25 +0800 CST
duration	string	工作流经过时长。	1h15m33.529968361s
finish_time	string	任务结束时间。	0001-01-01 00:00:00 +0000 UTC
input_data_size	string	输入数据大小。	0
job_name	string	工作流名称。	wgs-gpu-97xfn
job_namespace	string	工作流所在命名空间。	1171330362041663
output_data_size	string	输出数据大小。	0
status	string	工作流当前状态。	Running
total_bases	string	碱基对个数。	0
total_reads	string	Reads 个数。	0
user_input_data	string	用户输入参数。	{\"wgs_oss_region\":\"cn-shenzhen\",\"wgs_fastq_first_name\":\"fastq/huada/MGISEQ-200019SZ0002402\",\"wgs_fastq_second_name\":\"fastq/huada/MGISEQ-200019SZ0002402\",\"wgs_bucket_name\":\"gene-shenzhen\",\"wgs_vcf_file_name\":\"output/vcf/huada.vcf\",\"wgs_bam_file_name\":\"output/bam/huada.bam\",\"wgs_reference_file\":\"hg19\",\"wgs_service\":\"g\"}

示例

正常返回示例

JSON格式

{
  "create_time": "2020-01-15 16:30:25 +0800 CST",
  "duration": "1h15m33.529968361s",
  "finish_time": "0001-01-01 00:00:00 +0000 UTC",
  "input_data_size": "0",
  "job_name": "wgs-gpu-97xfn",
  "job_namespace": "1171330362041663",
  "output_data_size": "0",
  "status": "Running",
  "total_bases": "0",
  "total_reads": "0",
  "user_input_data": "{\\\"wgs_oss_region\\\":\\\"cn-shenzhen\\\",\\\"wgs_fastq_first_name\\\":\\\"fastq/huada/MGISEQ-200019SZ0002402\\\",\\\"wgs_fastq_second_name\\\":\\\"fastq/huada/MGISEQ-200019SZ0002402\\\",\\\"wgs_bucket_name\\\":\\\"gene-shenzhen\\\",\\\"wgs_vcf_file_name\\\":\\\"output/vcf/huada.vcf\\\",\\\"wgs_bam_file_name\\\":\\\"output/bam/huada.bam\\\",\\\"wgs_reference_file\\\":\\\"hg19\\\",\\\"wgs_service\\\":\\\"g\\\"}"
}

错误码

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

变更历史

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

暂无变更历史