文档首页/ AI开发平台ModelArts/ API参考/ Workflow工作流管理/ 总览Workflow工作流
更新时间：2024-10-23 GMT+08:00
查看PDF
分享

总览Workflow工作流

功能介绍

获取Workflow工作流统计信息。

接口约束

无

调试

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

URI

GET /v2/{project_id}/workflows/overview

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID。获取方法请参见获取项目ID和名称。
表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

否

String

工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

search_type

否

String

过滤方式。可选值如下：

  • equal表示精确匹配。

  • contain表示模糊匹配。

具体过滤的字段，由各个接口额外定义参数。例如Workflow支持按照名称（name）进行过滤，则相应的过滤字段为name。name=workflow&search_type=contain表示查询名称中含有Workflow字样的所有工作流。

name

否

String

工作流名称。填写1-64位，仅包含英文、数字、下划线（_）和中划线（-），并且以英文开头的名称。

description

否

String

工作流描述信息。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total

Integer

总数。

stat

Map<String,Integer>

状态。

请求示例

请求Workflow统计信息

GET https://{endpoint}/v2/{project_id}/workflows/overview

响应示例

状态码： 200

OK

{
  "total" : 1,
  "stat" : {
    "abnormal" : 0,
    "completed" : 1,
    "init" : 0,
    "never_executed" : 0,
    "running" : 0,
    "stopped" : 0
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档