GetCreateWorkflowInstancesResult-阿里云帮助中心

Queries the result of asynchronously creating a workflow instance.

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this feature.

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

dataworks:GetCreateWorkflowInstancesResult

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OperationId	string	Yes	The operation ID. This parameter is used to query the result of asynchronously creating a workflow instance. You can call the CreateWorkflowInstances operation to query the ID.	e15ad21c-b0e9-4792-8f55-b037xxxxxxxx

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	22C97E95-F023-56B5-8852-B1A77A17XXXX
Result	object	The creation result of the workflow instance.
Status	string	The creation status. Valid values: Creating Created CreateFailure	Created
FailureMessage	string	The error message. This parameter is returned only if the creation fails.	Invalid Param xxx
WorkflowInstanceIds	array	The workflow instance IDs. This parameter is returned only if the creation is successful.
	integer	The workflow instance ID.	1234
WorkflowTaskInstanceIds	array	The list of task instance IDs corresponding to the workflow instance. This field is returned after successful creation.
	integer	The task instance ID corresponding to the workflow instance.	1234
UnifiedWorkflowInstanceIds	array	Unified workflow instance ID. For all task instances triggered under the same data timestamp in a single trigger, the value of this field is identical. This field is returned after successful creation.
	integer	Unified workflow instance ID.	1234

Examples

Success response

JSON format

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Result": {
    "Status": "Created",
    "FailureMessage": "Invalid Param xxx",
    "WorkflowInstanceIds": [
      1234
    ],
    "WorkflowTaskInstanceIds": [
      1234
    ],
    "UnifiedWorkflowInstanceIds": [
      1234
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.