UpdateWorkflow - SchedulerX - Alibaba Cloud Documentation Center

Updates the basic information about a workflow. You can call this operation only in the professional edition.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ManageSchedulerxWorkflowModify	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
Namespace	string	Yes	The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console.	adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSource	string	No	The source of the namespace. This parameter is required only for a special third party.	schedulerx
GroupId	string	Yes	The application group ID. You can obtain the application group ID on the Application Management page in the SchedulerX console.	testSchedulerx.defaultGroup
WorkflowId	string	Yes	The workflow ID.	123
Name	string	No	The name of the workflow.	helloworld
Description	string	No	The description of the workflow.	Test
TimeType	integer	No	The method that is used to specify the time. Valid values: 1: cron 100: api	1
TimeExpression	string	No	The time expression. You can set the time expression based on the selected method that is used to specify time. If you set TimeType to cron, you need to enter a standard cron expression. Online verification is supported. If you set TimeType to api, no time expression is required.	0 0/10 * * * ?

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	39090022-1F3B-4797-8518-6B61095F1AF0
Code	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Message	string	The returned error message.	timetype is invalid

Examples

Sample success responses

JSONformat

{
  "RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
  "Code": 200,
  "Success": true,
  "Message": "timetype is invalid"
}

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