GetWorkFlow-阿里云帮助中心

Retrieves workflow information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:ReadSchedulerxWorkflowQuery

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	public
Namespace	string	Yes	The namespace ID.	4a06d5ea-f576-4326-842c-fb14ea043d8d
NamespaceSource	string	No	The namespace source.	source
GroupId	string	Yes	The application group ID.	hxm.test
WorkflowId	integer	Yes	The workflow ID.	1234

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request.	45678xxx
Code	integer	The status code. A value of 200 indicates that the request was successful.	200
Message	string	The error message.	workflow is not existed
Success	boolean	Indicates whether the request was successful.	true
Data	object	The data of the workflow.
WorkFlowInfo	object	The basic information about the workflow.
WorkflowId	integer	The workflow ID.	1234xxx
Name	string	The name of the workflow.	workflow_111
Description	string	The description of the workflow.	my first workflow
Status	string	The status of the workflow.	enable
TimeType	string	The time type of the workflow.	cron
TimeExpression	string	The time expression of the workflow.	0 0 2 * * ?
GroupId	string	The ID of the application group.	hxm.test
Namespace	string	The ID of the namespace.	8150f906-2a40-4420-8cc1-68d2fe4dd69c
MaxConcurrency	string	The maximum number of concurrent instances.	1
WorkFlowNodeInfo	object	The information about the workflow nodes.
Nodes	array<object>	The list of workflow nodes.
	object
Id	integer	The job ID.	123456xxx
Label	string	The name of the job.	job_111
Status	integer	The status of the job.	1
Edges	array<object>	The list of workflow edges.
	object
Source	integer	The ID of the source job.	100
Target	integer	The ID of the destination job.	200

Examples

Success response

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": "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
        }
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.