获取工作流信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 | public |
| Namespace | string | 是 | 命名空间 ID | 4a06d5ea-f576-4326-842c-fb14ea043d8d |
| NamespaceSource | string | 否 | 命名空间来源 | source |
| GroupId | string | 是 | 应用分组 ID | hxm.test |
| WorkflowId | long | 是 | 工作流 ID | 1234 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "45678xxx",
"Code": 200,
"Message": "workflow is not existed",
"Success": true,
"Data": {
"WorkFlowInfo": {
"WorkflowId": 0,
"Name": "workflow_111",
"Description": "my first workflow",
"Status": "成功",
"TimeType": "cron",
"TimeExpression": "0 0 2 * * ?"
},
"WorkFlowNodeInfo": {
"Nodes": [
{
"Id": 0,
"Label": "job_111",
"Status": 1
}
],
"Edges": [
{
"Source": 100,
"Target": 200
}
]
}
},
"AccessDeniedDetail": {
"AuthAction": "",
"AuthPrincipalDisplayName": "",
"AuthPrincipalOwnerId": "",
"AuthPrincipalType": "",
"EncodedDiagnosticMessage": "",
"NoPermissionType": "",
"PolicyType": ""
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-12-26 | OpenAPI 描述信息更新 | 查看变更详情 |
| 2021-12-21 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2021-12-20 | 新增 OpenAPI | 查看变更详情 |
示例 Demo
package com.alibaba.schedulerx.pop;
import com.alibaba.schedulerx.common.util.JsonUtil;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.GetWorkFlowRequest;
import com.aliyuncs.schedulerx2.model.v20190430.GetWorkFlowResponse;
public class TestGetWorkFlow {
public static void main(String[] args) {
// OpenAPI 的接入点，具体请查看支持地域列表或根据购买地域填写
String regionId = "public";
//鉴权使用的 AccessKey ID，由阿里云官网控制台获取
String accessKeyId = "xxxxxxx";
//鉴权使用的 AccessKey Secret，由阿里云官网控制台获取
String accessKeySecret = "xxxxxxxxx";
//产品名称
String productName ="schedulerx2";
//对照支持地域列表选择 Domain 填写
String domain ="schedulerx.aliyuncs.com";
//构建 OpenAPI 客户端
DefaultProfile.addEndpoint(regionId, productName, domain);
DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
GetWorkFlowRequest request = new GetWorkFlowRequest();
request.setNamespace("433d8b23-06e9-408c-aaaa-90d4d1b9a4af");
request.setGroupId("xuren_test");
request.setWorkflowId(29L);
GetWorkFlowResponse response;
try {
response = client.getAcsResponse(request);
if (!response.getSuccess()) {
System.out.println(JsonUtil.toJson(response));
} else {
System.out.println("工作流基本信息：" + response.getData().getWorkFlowInfo());
System.out.println("工作流节点信息：" + response.getData().getWorkFlowNodeInfo());
}
} catch (ServerException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (ClientException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}