payload_filter_request

Optional

String

Path for filtering event parameters. The default value is $.

Valid JSONPath format

payload_filter_response

Optional

String

Path for filtering event results. The default value is $.

Valid JSONPath format

event_source

Mandatory

String

Type of source event

Enumerated value. Only OBS is supported.

trigger_type

Optional

Array String

List of OBS event types

Enumerated value. OBS event type description.

trigger_prefix

Optional

String

Prefix of an OBS event trigger

Regular expressions are not supported.

trigger_suffix

Optional

String

Suffix of an OBS event trigger

Regular expressions are not supported.

trigger_bucket

Optional

String

Bucket triggered by specific OBS events

The bucket must be an existing one.

parameter_name

Mandatory

String

The value contains 1 to 20 characters. Only lowercase letters, digits, and hyphens (-) are allowed.

Parameter name. You can define a maximum of 60 parameter names, and each name is unique.

type

Mandatory

• String
• Integer
• Float
• Boolean

-

Parameter type

description

Optional

String

The value contains 0 to 256 characters.

Parameter description information

default

Optional

String

The default value can be replaced by an external input when a workflow instance is created. If the default value is not specified, the value of this parameter must be entered.

The default value type should be consistent with the defined parameter type. If they are inconsistent, the parser automatically converts their types, leading to unexpected results.

label

Optional

String

String length: 0 to 64 characters

Label of a parameter. The labels defined here can be displayed by category during stack creation.

constraints

Optional

map

-

Parameter constraint, which is used to define the valid value range of an input parameter.

invisible

Optional

Boolean

If this parameter is set to true, the return value is ******.

Specifies whether to display the command output.

start

Optional

bool

Indicates the start state. In the figure, there must be only one state whose start value is true.

There is only one state whose start value is true.

type

Mandatory

string

DELAY, SWITCH, OPERATION, EVENT, END, Noop

Enumerated

payload_filter_in

Optional

string

Specifies whether to filter input parameters. The default value is $, indicating no filtering for input parameters.

Valid JSONPath format

payload_filter_out

Optional

string

Specifies whether to filter the state output. The default value is $, indicating no filtering for state output.

Valid JSONPath format

state_name

Mandatory

string

State name definition

The value contains 1 to 20 characters. Only lowercase letters, digits, and hyphens (-) are allowed.

events

Mandatory

Array

JSON array that defines the event messages in a queue. Each array member is an event message object.

-

event_timeout

Optional

int

Maximum waiting time for an event. Unit: seconds.

0 indicates that this parameter is not specified. The default value is 30s.

The value is an integer ranging from 0 to 86400.

action_mode

Optional

String

Specifies in which mode are actions invoked. The options are PARALLEL or SEQUENTIAL. The default value is SEQUENTIAL.

The value can be PARALLEL or SEQUENTIAL.

actions

Mandatory

Array

JSON array that defines an action.

One or more actions must be defined.

next_state

Mandatory

String

Name of the next state, which is a string and must exist in the graph definition

The value must be a state name in a workflow.

default

Mandatory

String

Specifies that if no branch is matched, the workflow is transferred to the node specified by default.

The value must be a state name in a workflow.

choices

Mandatory

Array

Path choices

There must be path choices and the choices.size value must be greater than 0.

time_delay

Mandatory

String

Waiting time, in seconds. The value is an integer.

The value ranges from 0 and to 86400.

next_state

Mandatory

String

Name of the next state, which is a string and must exist in the graph definition

The value must be a state name in a workflow template.

action_name

Mandatory

String

Action name

The value must be unique in a state. The action name is a string of 1 to 20 characters containing only digits, letters, hyphens (-), and underscores (_).

function

Mandatory

String

URN of a user-defined function

You can set it for either function or function-template.

function_template

Mandatory

String

URN of the built-in function template

You can set it for either function or function-template.

invocation_mode

Optional

String

Specifies the mode in which an action is invoked.

The value must be SYNC or ASYNC.

results

Optional

Array

Retry mechanism after an action failure

The value is a JSON array that contains the result definition. If the results exist, the value is greater than or equal to 0.

timeout

Optional

Int

Timeout interval of an action, or the maximum waiting duration. The default value is 30s.

The value is an integer ranging from 0 to 300. 0 indicates that this parameter is not specified.

payload_filter

Optional

String

Filtering path of results. The default value is $.

Valid JSONPath format

dynamic_source

Optional

Map

When a workflow is being created, a function based on the user-defined function template can be created and parameter values can be specified.

The value must be a specified parameter name. Otherwise, the parameter does not take effect.

match

Mandatory

String

Errors in matching

MatchAny, States.ActionFailed, States.PermissionError, States.ParameterError, States.NotFound, States.TooManyRequests, States.FunctionStageUnavailable, States.FunctionStageOtherErrors

retry_interval

Optional

Int

Retry interval, in seconds.

The value is an integer greater than or equal to 0.

max_retry

Optional

Int

Maximum number of retry times. If this parameter is not set, the default value 3 is used. 0 indicates no retries.

The value is an integer greater than or equal to 0.

next_state

Optional

String

Name of the next state, which is a string and must exist in the graph definition

The value must be a state name in a workflow template.

is_terminal

Mandatory

Bool

Specifies whether to interrupt an action in case of an exception. The default value is False.

True: needless to specify the next-state; False: The next-state must be specified.

event_expression

Mandatory

String

Waiting event ID

The value must be the name of an event in event-ref that exists in the event definition.

action_mode

Optional

String

Specifies in which mode are actions invoked. The options are PARALLEL or SEQUENTIAL. The default value is SEQUENTIAL.

The value can be PARALLEL or SEQUENTIAL.

actions

Optional

Array

JSON array that defines an action.

If this field exists, it should contain 0 or more actions.

next_state

Mandatory

String

Name of the next state, which is a string and must exist in the graph definition

The value must be a state name in a workflow template.

path

Mandatory

string

It is used to obtain a value from the output of the previous node and then compare it with the user-defined value.

-

value

Mandatory

string

User-defined value

-

next_state

Mandatory

string

Name of the next state after matching

The value must be a state name in a workflow template.

key

Mandatory

String

Tag key

A tag name contains 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

value

Mandatory

String

Tag value

A tag value is a string of 1 to 256 characters.

name

String

Workflow name

created_at

String

Creation time of a workflow template recorded in the system

name

String

Workflow name

created_at

String

Creation time of a workflow template recorded in the system

graph_urn

String

Workflow URN

id

Mandatory

String

Policy rule ID

A rule ID contains 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Each rule ID must be unique in a policy.

graph_urn

Mandatory

String

Workflow URN

You need to create the workflow first.

events

Mandatory

Array

OBS event list. For details, see the description about OBS event types.

-

prefix

Optional

String

Object name prefix

Key word of object names. Based on the prefix defined by this parameter, enter the key word for filtering objects. A longer string of characters delivers a more accurate filtering result. A maximum of 1024 characters are supported. It also can be empty.

In addition, the total length of the prefix and suffix cannot exceed 1024 characters.

suffix

Optional

String

Suffix of an object name

Key word of object names. Based on the suffix defined by this parameter, enter the key word for filtering objects. A longer string of characters delivers a more accurate filtering result. A maximum of 1024 characters are supported. It also can be empty.

In addition, the total length of the prefix and suffix cannot exceed 1024 characters.

graph_urn

String

Workflow URN

execution_urn

String

URN of a running instance

started_at

String

Start time of a running instance

stopped_at

String

Specifies the time when the instance stops running. This parameter is optional.

execution_state

String

Overall status of running instances

execution_type

String

Trigger type of a running instance. Value options: APICALL, TRIGGERCALL

start_state

String

First node of a workflow

isTest

bool

Specifies whether an instance is started by starting a workflow test. If yes, the value is true.

execution_name

String

Name of a running instance

output

String

Output of a running instance. This field does not exist when the current instance is running.

input

String

Input when an instance starts running

state_map

Dictionary

Includes information about each state. For details, see parameters in the ExecutionState structure.