All Products
Search
Document Center

SchedulerX:GetWorkFlow

Last Updated:Dec 10, 2024

Obtains the information about a workflow.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
edas:ReadSchedulerxWorkflowQueryget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region information.

public
NamespacestringYes

The ID of the namespace.

4a06d5ea-f576-4326-842c-fb14ea043d8d
NamespaceSourcestringNo

The source of the namespace.

source
GroupIdstringYes

The ID of the application group.

hxm.test
WorkflowIdlongYes

The ID of the workflow.

1234

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

45678xxx
Codeinteger

Error codes

200
Messagestring

Error message

workflow is not existed
Successboolean

The result of the API call.

true
Dataobject

The data of the workflow.

WorkFlowInfoobject

The basic information of the workflow.

WorkflowIdlong

The ID of the workflow.

1234xxx
Namestring

The name of the workflow.

workflow_111
Descriptionstring

The description of the workflow.

my first workflow
Statusstring

The status of the workflow.

Successful
TimeTypestring

The time type of the workflow.

cron
TimeExpressionstring

The time expression of the workflow.

0 0 2 * * ?
WorkFlowNodeInfoobject

The node information of the workflow.

Nodesarray<object>

The list of workflow nodes.

Nodeobject
Idlong

The ID of the job.

123456xxx
Labelstring

The name of the job.

job_111
Statusinteger

The status of the job.

1
Edgesarray<object>

The workflow edges.

Edgeobject
Sourcelong

The ID of the source job.

100
Targetlong

The ID of the object job.

200

Examples

Sample success responses

JSONformat

{
  "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 timeSummary of changesOperation
2024-10-18The response structure of the API has changedView Change Details
2022-12-26API Description UpdateView Change Details
2021-12-21The response structure of the API has changedView Change Details
2021-12-20Add OperationView 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();
        }
    }
    
}