调用ListWorkflowInstance获取工作流实例列表_分布式任务调度(SchedulerX)-阿里云帮助中心

获取工作流的历史执行记录，只有专业版才支持。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID	cn-hangzhou
Namespace	string	是	命名空间 ID，在控制台的命名空间页面中获取	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	否	特殊第三方才需要填写	schedulerx
GroupId	string	是	应用分组 ID，在控制台的应用管理页面中获取	testSchedulerx.defaultGroup
WorkflowId	string	是	工作流 ID	123

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求唯一 ID	39090022-1F3B-4797-8518-6B61095F1AF0
Code	integer	返回码	200
Success	boolean	API 执行是否成功。取值如下： true：成功。 false：失败。	true
Message	string	错误信息	workflowId=xxx is not existed
Data	object	工作流实例列表封装在 data 里
WfInstanceInfos	array<object>	工作流实例的列表
WfInstanceInfos	object	工作流实例数据结构
WfInstanceId	long	工作流实例 ID	123456
WorkflowId	long	工作流 ID	123
Status	integer	工作流实例状态，取值如下： 1: 等待中 2: 准备中 3：运行中 4：成功 5：失败	5
StartTime	string	开始时间	2023-01-03 18:00:01
EndTime	string	结束时间	2023-01-03 18:00:21
ScheduleTime	string	计划调度时间	2023-01-03 18:00:00
DataTime	string	数据时间	2023-01-03 18:00:00

示例

正常返回示例

JSON格式

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "workflowId=xxx is not existed",
  "Data": {
    "WfInstanceInfos": [
      {
        "WfInstanceId": 123456,
        "WorkflowId": 123,
        "Status": 5,
        "StartTime": "2023-01-03 18:00:01",
        "EndTime": "2023-01-03 18:00:21",
        "ScheduleTime": "2023-01-03 18:00:00",
        "DataTime": "2023-01-03 18:00:00"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

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

变更历史

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

暂无变更历史