ListWorkFlows - 获取工作流信息列表

更新时间:
复制为 MD 格式

获取工作流信息列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

edas:ReadSchedulerxWorkflowQuery

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

Namespace

string

命名空间 uid

4a06d5ea-f576-4326-842c-fb14ea043d8d

NamespaceSource

string

命名空间来源,特殊来源才需要填写。

schedulerx

GroupId

string

应用分组 ID

hxm.test

WorkflowName

string

工作流名称

Test3

PageNum

integer

页码

1

PageSize

integer

分查询时设置的每页大小。

10

Status

integer

任务状态。

  • 0:表示禁用

  • 1:表示启用

1

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求唯一 ID

883AFE93-FB03-4FA9-A958-E750C6DE120C

Code

integer

错误码

200

Message

string

错误信息

workflow is not existed

Success

boolean

会否成功

true

Data

object

工作流的数据

Records

array<object>

单行数据。

object

Namespace

string

命名空间 ID,在控制台的命名空间页面中获取。

4a06d5ea-f576-4326-842c-fb14ea043d8d

GroupId

string

应用 ID。

hxm.test

Name

string

工作流名称

Test3

WorkflowId

integer

工作流 ID

1339

Description

string

任务描述

No description

TimeType

string

工作流时间类型

cron

TimeExpression

string

时间表达式

0 0 5 */1 * ?

MaxConcurrency

string

最大并发数

1

Calendar

string

日历

workday

Creator

string

创建人

1144881807903942

Updater

string

更新人

1144881807903942

PageNumber

integer

页码

1

PageSize

integer

页大小

10

Total

integer

总记录数

1

示例

正常返回示例

JSON格式

{
  "RequestId": "883AFE93-FB03-4FA9-A958-E750C6DE120C",
  "Code": 200,
  "Message": "workflow is not existed",
  "Success": true,
  "Data": {
    "Records": [
      {
        "Namespace": "4a06d5ea-f576-4326-842c-fb14ea043d8d\n",
        "GroupId": "hxm.test",
        "Name": "Test3",
        "WorkflowId": 1339,
        "Description": "No description",
        "TimeType": "cron",
        "TimeExpression": "0 0 5 */1 * ?",
        "MaxConcurrency": "1",
        "Calendar": "workday",
        "Creator": "1144881807903942",
        "Updater": "1144881807903942"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "Total": 1
  }
}

错误码

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

变更历史

更多信息,参考变更详情