GetWorkflow - 获取工作流的基本信息-微服务引擎(MSE)-阿里云帮助中心

获取工作流的基本信息

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。	xxljob-b6ec1xxxx
AppName	string	是	应用名称。	xxl-job-executor-sample
WorkflowId	long	是	工作流 ID	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	integer	响应码。	200
Message	string	错误信息。	Parameter error: content is null.
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	27B1345D-5F71-5972-8E4C-AABA6C6232F0
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true
Data	object
WorkflowId	long	工作流 ID	10
Name	string	工作流名称	myWorkflow
Description	string	工作流描述	my first workflow
Status	integer	工作流状态 0：禁用 1：启用	2
MaxConcurrency	integer	最大并发数。	100
TimeType	integer	调度类型： -1: none 1：cron 100:：api	1
TimeExpression	string	时间表达式，根据选择的时间类型设置时间表达式。 none：无需填写 cron：填写标准的 cron 表达式，支持在线验证。 api：无需填写	0 0 12 * * ?
Timezone	string	时区说明默认使用当前 region 服务器所在时区	GMT+8
Calendar	string	自定义日历	workday
Creator	string	创建人。	18582193685027xx
Updater	string	更新人。	18582193685027xx
Xattrs	string	扩展属性。说明暂不支持	null
AppName	string	应用名称。	test-app

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Parameter error: content is null.",
  "RequestId": "27B1345D-5F71-5972-8E4C-AABA6C6232F0",
  "Success": true,
  "Data": {
    "WorkflowId": 10,
    "Name": "myWorkflow",
    "Description": "my first workflow",
    "Status": 2,
    "MaxConcurrency": 100,
    "TimeType": 1,
    "TimeExpression": "0 0 12 * * ?",
    "Timezone": "GMT+8",
    "Calendar": "workday",
    "Creator": "18582193685027xx",
    "Updater": "18582193685027xx",
    "Xattrs": null,
    "AppName": "test-app"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Parameter error: %s.	参数错误: %s
401	IllegalRequest	IllegalRequest: %s.	非法请求：%s
403	NoPermission	No permission to perform this operation: %s.	没有权限去执行该操作：%s
404	NotFound	Not found: %s.	资源不存在：%s
500	InternalError	InternalError: %s.	系统内部错误：%s

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

变更历史

变更时间	变更内容概要	操作
2025-12-25	新增 OpenAPI	查看变更详情