总览Workflow工作流 - ShowWorkflowsOverview
功能介绍
总览Workflow工作流接口用于查看所有已创建的工作流的概览信息。
该接口适用于以下场景：当用户需要管理多个工作流、查看所有工作流的概览信息时，用户可通过此接口。使用该接口的前提条件是用户具有查看工作流的权限，调用成功后，接口将返回工作流执行记录的概览信息。若用户未登录、权限不足或系统中不存在工作流，接口将返回相应的错误信息。
接口约束
无
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。获取该接口关联的CLI示例： hcloud ModelArts ShowWorkflowsOverview。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
modelarts:workflow:list
List
-
-
-
-
URI
GET /v2/{project_id}/workflows/overview
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
workspace_id |
否 |
String |
参数解释：工作空间ID。获取方法请参见查询工作空间列表。 约束限制：存在并使用的工作空间。 取值范围：不涉及。 默认取值：“0”。 |
|
search_type |
否 |
String |
参数解释：过滤方式。 约束限制：具体过滤的字段，由各个接口额外定义参数。例如Workflow支持按照名称（name）进行过滤，则相应的过滤字段为name。name=workflow&search_type=contain表示查询名称中含有Workflow字样的所有工作流。 取值范围：可选值如下：
默认取值：不涉及。 |
|
name |
否 |
String |
参数解释：工作流名称。 约束限制：填写1-64位，仅包含英文、数字、下划线（_）和中划线（-），并且以英文开头的名称。 取值范围：不涉及。 默认取值：不涉及。 |
|
description |
否 |
String |
参数解释：工作流描述信息。 约束限制：不涉及。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
错误码
请参见错误码。
