ListWorkFlows-阿里云帮助中心

Queries the information of a workflow.

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.	cn-hangzhou
Namespace	string	Yes	The namespace ID.	4a06d5ea-f576-4326-842c-fb14ea043d8d
NamespaceSource	string	No	The source of the namespace. This parameter is required only for special sources.	schedulerx
GroupId	string	Yes	The ID of the application group.	hxm.test
WorkflowName	string	No	The workflow name.	Test3
PageNum	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
Status	integer	No	The job status. 0: disables the job. 1: enables the routing policy.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	883AFE93-FB03-4FA9-A958-E750C6DE120C
Code	integer	The error code.	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.
Records	array<object>	The row of data.
	object
Namespace	string	The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console.	4a06d5ea-f576-4326-842c-fb14ea043d8d
GroupId	string	The application ID.	hxm.test
Name	string	The workflow name.	Test3
WorkflowId	integer	The workflow ID.	1339
Description	string	The job description.	No description
TimeType	string	The time type of the workflow.	cron
TimeExpression	string	The time expression.	0 0 5 /1 ?
MaxConcurrency	string	The maximum concurrency.	1
Calendar	string	The calendar.	workday
Creator	string	The creator.	1144881807903942
Updater	string	The updater.	1144881807903942
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Total	integer	The total number of entries returned.	1

Examples

Success response

JSON format

{
  "RequestId": "883AFE93-FB03-4FA9-A958-E750C6DE120C",
  "Code": 200,
  "Message": "workflow is not existed",
  "Success": true,
  "Data": {
    "Records": [
      {
        "Namespace": "4a06d5ea-f576-4326-842c-fb14ea043d8d\n",
        "GroupId": "hxm.test",
        "Name": "Test3",
        "WorkflowId": 1339,
        "Description": "No description",
        "TimeType": "cron",
        "TimeExpression": "0 0 5 */1 * ?",
        "MaxConcurrency": "1",
        "Calendar": "workday",
        "Creator": "1144881807903942",
        "Updater": "1144881807903942"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "Total": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.