SetWfInstanceSuccess - SchedulerX - Alibaba Cloud Documentation Center

Forcibly sets the state of a workflow instance to successful. 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:
- 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:ManageSchedulerxWfInstanceMarkSuccess	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	long	Yes	The workflow ID.	123
WfInstanceId	long	Yes	The workflow instance ID.	123456789

Response parameters

Parameter	Type	Description	Example
	object	The information about the array object.
RequestId	string	The request ID.	4F68ABED-AC31-4412-9297-D9A8F0401108
Code	integer	The HTTP status code.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Message	string	The error message that is returned only if the corresponding error occurs.	wofkflowId is not existed

Examples

Sample success responses

JSONformat

{
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Code": 200,
  "Success": true,
  "Message": "wofkflowId is not existed"
}

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