使用GetWorkFlow API获取工作流详情和依赖关系-分布式任务调度-阿里云-分布式任务调度(SchedulerX)-阿里云帮助中心

获取工作流信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

edas:ReadSchedulerxWorkflowQuery

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域	public
Namespace	string	是	命名空间 ID	4a06d5ea-f576-4326-842c-fb14ea043d8d
NamespaceSource	string	否	命名空间来源	source
GroupId	string	是	应用分组 ID	hxm.test
WorkflowId	integer	是	工作流 ID	1234

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID	45678xxx
Code	integer	错误码	200
Message	string	错误信息	workflow is not existed
Success	boolean	结果	true
Data	object	工作流的数据
WorkFlowInfo	object	工作流基本信息
WorkflowId	integer	工作流 ID	1234xxx
Name	string	工作流名称	workflow_111
Description	string	工作流描述	my first workflow
Status	string	工作流状态	enable
TimeType	string	工作流时间类型	cron
TimeExpression	string	工作流时间表达式	0 0 2 * * ?
GroupId	string	应用分组 ID	hxm.test
Namespace	string	命名空间 ID	8150f906-2a40-4420-8cc1-68d2fe4dd69c
MaxConcurrency	string	最大并发数	1
WorkFlowNodeInfo	object	工作流节点信息
Nodes	array<object>	工作流节点列表
	object
Id	integer	任务 ID	123456xxx
Label	string	任务名称	job_111
Status	integer	任务状态	1
Edges	array<object>	工作流边列表
	object
Source	integer	起始任务 ID	100
Target	integer	目的任务 ID	200

示例

正常返回示例

JSON格式

{
  "RequestId": "45678xxx",
  "Code": 200,
  "Message": "workflow is not existed",
  "Success": true,
  "Data": {
    "WorkFlowInfo": {
      "WorkflowId": 0,
      "Name": "workflow_111",
      "Description": "my first workflow",
      "Status": "enable",
      "TimeType": "cron",
      "TimeExpression": "0 0 2 * * ?",
      "GroupId": "hxm.test",
      "Namespace": "8150f906-2a40-4420-8cc1-68d2fe4dd69c",
      "MaxConcurrency": "1"
    },
    "WorkFlowNodeInfo": {
      "Nodes": [
        {
          "Id": 0,
          "Label": "job_111",
          "Status": 1
        }
      ],
      "Edges": [
        {
          "Source": 100,
          "Target": 200
        }
      ]
    }
  }
}

错误码

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

变更历史

更多信息，参考变更详情。