网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
本文导读

展开导读

结构体说明

更新时间:2024-07-02 GMT+08:00
分享
表1 EventDef结构体参数说明

名称

是否必选

参数类型

描述

payload_filter_request

String

参数解释

事件的参数过滤路径。

约束限制:

必须是合法的JSONPath格式

默认取值:

$

payload_filter_response

String

参数解释

事件的结果过滤路径。

约束限制:

必须是合法的JSONPath格式

默认取值:

$

event_source

String

参数解释

事件触发类型

约束限制:

枚举,当前只支持“OBS”

取值范围:

OBS

默认取值:

trigger_type

Array String

参数解释

OBS事件类型列表

约束限制:

枚举,OBS事件类型描述

默认取值:

trigger_prefix

String

参数解释

OBS事件触发前缀

约束限制:

不支持正则

默认取值:

trigger_suffix

String

参数解释

OBS事件触发后缀

约束限制:

不支持正则

默认取值:

trigger_bucket

String

参数解释

OBS事件触发桶

约束限制:

trigger_bucket是已存在的桶

默认取值:

表2 Input结构体参数说明

名称

是否必选

参数类型

描述

parameter_name

String

参数解释

输入参数名称。

约束限制:

  • 最多可定义60个。
  • 命名必须唯一。

取值范围:

由小写字母、数字和中划线“-”组成,长度为[1, 20]

默认取值:

type

  • string:字符串
  • integer:数字
  • float:浮点数
  • boolean:布尔值

参数解释

参数类型。

取值范围:

  • string:字符串
  • integer:数字
  • float:浮点数
  • boolean:布尔值

默认取值:

description

String

参数解释

参数描述信息。

取值范围:

长度为[0, 256]。

默认取值:

default

String

参数解释

默认值

约束限制:

  • 默认值信息可在创建工作流实例时由外部输入替换;如果未填写默认值,外部输入将必须填写这个参数的值。
  • 默认值的类型和定义的参数类型必须统一。如果出现不一致,解析器可能会进行自动转换而导致出现与预期不符合的情况。

默认取值:

label

String

参数解释

参数的标签,此处定义的标签可在创建堆栈时进行分类展示。

取值范围:

长度为[0, 64]。

默认取值:

constraints

map

参数解释

参数约束,用于约束可以定义输入参数的合法值范围

默认取值:

invisible

Boolean

参数解释

是否回显。

取值范围:

true:回显,返回值为******。

false:不回显。

默认取值:

表3 State公共域说明

名称

是否必选

参数类型

描述

start

bool

参数解释

标识开始的state。

约束限制:

有且只有一个start为true的state。

取值范围:

true:标识此state为开始的state。

false:此state不为开始的state。

默认取值:

false

type

string

参数解释

state的类型。

取值范围:

DELAY、SWITCH、OPERATION、EVENT、END、Noop。

默认取值:

payload_filter_in

string

参数解释

过滤输入参数。

约束限制:

必须是合法的JSONPath格式。

默认取值:

$,表示不过滤。

payload_filter_out

string

参数解释

过滤state的输出结果。

约束限制:

必须是合法的JSONPath格式。

默认取值:

$,表示不过滤。

state_name

string

参数解释

state的名字定义。

取值范围:

由小写字母、数字和中划线“-”组成,长度为[1, 20]。

默认取值:

说明:

END State没有payload_filter_in和payload_filter_out属性

表4 EventState结构体参数说明

名称

是否必选

参数类型

描述

events

Array

参数解释

定义等待的事件消息的json数组。每一个数组成员是一个event消息对象。

默认取值:

event_timeout

int

参数解释

等待事件的最大时间,单位秒。

约束限制:

等于0时等同于不设置。默认值是30s

取值范围:

大于等于0且小于等于86400的整型。

默认取值:

表5 OperationState结构体参数说明

名称

是否必选

参数类型

说明

action_mode

String

参数解释

任务action调用的模式,并行或者串行。

取值范围:

  • PARALLEL:并行
  • SEQUENTIAL:串行

默认取值:

SEQUENTIAL

actions

Array

参数解释

定义action的json数组

约束限制:

必须定义1个或者以上的Action

默认取值:

next_state

String

参数解释

表示下一个state的名字。

约束限制:

必须是工作流中的state名字

默认取值:

表6 SwitchState结构体参数说明

名称

是否必选

参数类型

描述

default

String

参数解释

默认节点,标识如果所有分支匹配都没有命中,将默认流转到default指定的节点

约束限制:

必须是工作流中的state名字

默认取值:

choices

Array

参数解释

路径选择

约束限制:

choices.size > 0

默认取值:

表7 DelayState结构体参数说明

名称

是否必选

参数类型

描述

time_delay

String

参数解释

等待的时间。

取值范围:

必须大于0,最大值为86400,单位:秒。

默认取值:

next_state

String

参数解释

表示下一个state的名字。

约束限制:

必须是工作流模板中的state名字

默认取值:

表8 Action结构体参数说明

名称

是否必选

参数类型

描述

action_name

String

参数解释

action的名字。

约束限制:

要求state中唯一。

取值范围:

1-20长度的只含数字、字母、-和_的字符串。

默认取值:

function

String

参数解释

用户自定义函数URN

约束限制:

function与function-template只能设置其中一个。

默认取值:

function_template

String

参数解释

系统内置的函数模板URN

约束限制:

function与function-template只能设置其中一个。

默认取值:

invocation_mode

String

参数解释

调用模式

取值范围:

  • SYNC:同步。
  • ASYNC:异步。

默认取值:

results

Array

参数解释

Action失败后的捕获重试机制。

约束限制:

值是一个包含result定义的json数组,results如果存在时,size>=0

默认取值:

timeout

Int

参数解释

Action的超时时间,最长等待时间。

取值范围:

大于等于0且小于等于300的整型,等于0时等同于不设置,单位:秒。

默认取值:

30

payload_filter

String

参数解释

对结果进行过滤的路径。

约束限制:

必须是合法的JSONPath格式。

默认取值:

$

dynamic_source

Map

参数解释

在创建工作流时会根据OBS自定义的函数模板创建属于用户的function,并指定该参数设置的参数值

约束限制:

必须是指定的参数名称,否则不生效

默认取值:

表9 ActionResult结构体参数说明

名称

是否必选

参数类型

描述

match

String

参数解释

表示匹配的错误

取值范围:

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

默认取值:

retry_interval

Int

参数解释

表示重试的间隔时间。

取值范围:

大于等于0的整型数,单位:秒

默认取值:

max_retry

Int

参数解释

表示最大重试次数。

取值范围:

大于等于0的整型数,等于0时表示不重试,单位:秒

默认取值:

3

next_state

String

参数解释

表示下一个state的名字,String类型。

约束限制:

必须是工作流模板中的state名字。

默认取值:

is_terminal

Bool

参数解释

表示是否异常中断该Action,默认为False。

约束限制:

注:如果设置为True,那么不必设置nex-state; 如果设置为False,则必须设置next-state。

取值范围:

True:异常中断该Action。

False:异常不中断该Action。

默认取值:

表10 Event结构体参数说明

名称

是否必选

参数类型

描述

event_expression

String

参数解释

标识等待的事件

约束限制:

必须是event定义中存在的event-ref中event项的名字

默认取值:

action_mode

String

参数解释

任务action调用的模式,并行或者串行。

取值范围:

  • PARALLEL:并行
  • SEQUENTIAL:串行

默认取值:

SEQUENTIAL

actions

Array

参数解释

定义action的json数组。

约束限制:

如果存在则必须包含0个或者以上的Action

默认取值:

next_state

String

参数解释

表示下一个state的名字。

约束限制:

必须是工作流模板中的state名字

默认取值:

表11 Choice结构体参数说明

名称

是否必选

参数类型

描述

path

string

参数解释

用来从上一节点的输出中得到某个值,然后和用户预定义的值比较

默认取值:

value

string

参数解释

用户预定义的值

默认取值:

next_state

string

参数解释

匹配到后转到下一个state的名字

约束限制:

必须是工作流模板中的state名字

默认取值:

表12 Tag结构体参数说明

名称

是否必选

参数类型

描述

key

String

参数解释

Tag名称。

取值范围:

由大写或小写的英文字母、数字、下划线和连字符组成,长度在1到256个字符之间。

默认取值:

value

String

参数解释

Tag值。

取值范围:

长度在1到256之间的字符串。

默认取值:

表13 TemplateItem结构体说明

名称

参数类型

说明

name

String

参数解释

工作流的名称

约束限制:

名称必须以字母或数字开头,只能由字母、数字、下划线和中划线组成,长度小于等于64个字符,且不能重名。

默认取值:

created_at

String

参数解释

系统记录的创建工作流模板的时间

默认取值:

表14 GraphItem结构体说明

名称

参数类型

说明

name

String

参数解释

工作流的名称

约束限制:

名称必须以字母或数字开头,只能由字母、数字、下划线和中划线组成,长度小于等于64个字符,且不能重名。

默认取值:

created_at

String

参数解释

系统记录的创建工作流模板的时间

默认取值:

graph_urn

String

参数解释

工作流的URN

默认取值:

表15 Rule结构体

名称

是否必选

参数类型

描述

id

String

参数解释

策略规则ID。

约束限制:

策略中不允许出现相同规则ID。

取值范围:

由大写或小写的英文字母、数字、下划线和连字符组成,长度在1到256个字符之间。

默认取值:

graph_urn

String

参数解释

工作流URN。

约束限制:

需要先创建此工作流

默认取值:

events

Array

参数解释

OBS事件列表。

取值范围:

请参考OBS事件类型描述。

默认取值:

prefix

String

参数解释

对象名前缀,用于指定的对象名关键字,根据定义的前缀,输入需要过滤的对象的关键字信息,字符越长匹配精度越高。

约束限制:

prefix和suffix加起来长度最大为1024个字符。

取值范围:

0到1204长度的字符串

默认取值:

suffix

String

参数解释

对象名后缀,用于指定的对象名关键字,根据定义的后缀,输入需要过滤的对象的关键字信息,字符越长匹配精度越高。

约束限制:

prefix和suffix加起来长度最大为1024个字符。

取值范围:

0到1204长度的字符串

默认取值:

表16 ExecutionDetail结构体

名称

参数类型

说明

graph_urn

String

参数解释

工作流的URN

默认取值:

execution_urn

String

参数解释

运行实例的URN

默认取值:

started_at

String

参数解释

运行实例启动时间

默认取值:

stopped_at

String

参数解释

运行实例结束时间,可选字段

默认取值:

execution_state

String

参数解释

运行实例总体状态

默认取值:

execution_type

String

参数解释

运行实例的触发类型。

取值范围:

  • APICALL
  • TRIGGERCALL

默认取值:

start_state

String

参数解释

工作流的第一个节点

默认取值:

isTest

bool

参数解释

是否是通过启动工作流测试启动的实例。

取值范围:

true:通过启动工作流测试启动的实例

false:不通过启动工作流测试启动的实例

默认取值:

execution_name

String

参数解释

运行实例的名字

默认取值:

output

String

参数解释

运行实例的输出

约束限制:

当前实例未运行结束时,该字段不存在。

默认取值:

input

String

参数解释

运行实例启动时的输入

默认取值:

state_map

字典数据结构

参数解释

包括每个state信息。

取值范围:

参见ExecutionState结构体

默认取值:

表17 ExecutionState参数说明

名称

参数类型

说明

key

String

参数解释

工作流的节点名称。

约束限制:

此名称由用户提供,命名不固定,如"next1"。

默认取值:

state_name

String

参数解释

state的名称

默认取值:

status

String

参数解释

当前state的状态

默认取值:

started_at

String

参数解释

state开始时间

默认取值:

stopped_at

String

参数解释

state结束的时间,可选字段,state结束含有该项

默认取值:

type

String

参数解释

state的类型

默认取值:

input

String

参数解释

当前state启动时的输入,可选字段,state结束含有该项

默认取值:

output

String

参数解释

当前state启动时的输出

默认取值:

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容