Obtains the information about a workflow.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
edas:ReadSchedulerxWorkflowQuery | get | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region information. | public |
Namespace | string | Yes | The ID of the namespace. | 4a06d5ea-f576-4326-842c-fb14ea043d8d |
NamespaceSource | string | No | The source of the namespace. | source |
GroupId | string | Yes | The ID of the application group. | hxm.test |
WorkflowId | long | Yes | The ID of the workflow. | 1234 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "45678xxx",
"Code": 200,
"Message": "workflow is not existed",
"Success": true,
"Data": {
"WorkFlowInfo": {
"WorkflowId": 0,
"Name": "workflow_111",
"Description": "my first workflow",
"Status": "Successful\n",
"TimeType": "cron",
"TimeExpression": "0 0 2 * * ?"
},
"WorkFlowNodeInfo": {
"Nodes": [
{
"Id": 0,
"Label": "job_111",
"Status": 1
}
],
"Edges": [
{
"Source": 100,
"Target": 200
}
]
}
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-10-18 | The response structure of the API has changed | View Change Details |
2022-12-26 | API Description Update | View Change Details |
2021-12-21 | The response structure of the API has changed | View Change Details |
2021-12-20 | Add Operation | View Change Details |
Sample code
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) {
// The ID of the region. Enter a value by referring to the Endpoints topic or based on the region in which you purchased the service.
String regionId = "public";
// The AccessKey ID that is used for authentication. You can obtain the AccessKey ID in the RAM console.
String accessKeyId = "xxxxxxx";
// The AccessKey secret that is used for authentication. You can obtain the AccessKey secret in the RAM console.
String accessKeySecret = "xxxxxxxxx";
// The name of the service.
String productName ="schedulerx2";
// The domain. Enter a domain by referring to the Endpoints topic.
String domain ="schedulerx.aliyuncs.com";
// Build an API client.
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("Basic workflow information:" + response.getData().getWorkFlowInfo());
System.out.println("Workflow node information:" + response.getData().getWorkFlowNodeInfo());
}
} catch (ServerException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (ClientException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}