函数工作流 FUNCTIONGRAPH-Yaml文件:triggers字段介绍

时间:2025-02-18 14:55:39

triggers字段介绍

Yaml文件中triggers字段说明请参考表4

表4 trigger参数说明

参数名

必填

类型

参数描述

triggerTypeCode

True

String

触发器类型。

status

False

Enum

触发器状态,取值为 ACTIVE、DISABLED,默认为 ACTIVE。

eventData

True

Struct

触发器配置,包括•APIG触发器, •TIMER触发器

  • APIG触发器
    表5 APIG参数说明

    参数名

    必填

    类型

    参数描述

    name

    False

    String

    API名称,默认使用函数名。

    groupName

    False

    String

    分组,默认选择当前第一个。

    auth

    False

    Enum

    安全认证,默认为 IAM

    API认证方式:
    • App: 采用Appkey&Appsecret认证,安全级别高,推荐使用,详情请参见APP认证
    • IAM: IAM认证,只允许IAM用户能访问,安全级别中等,详情请参见IAM认证
    • None: 无认证模式,所有用户均可访问。

    protocol

    False

    Enum

    请求协议,默认为 HTTPS。

    分为两种类型:

    • HTTP
    • HTTPS

    timeout

    False

    Number

    后端超时时间,单位为毫秒,取值范围为 1 ~ 60000。默认为 5000。

    参考案例:
    trigger:
        triggerTypeCode: APIG
        status: ACTIVE
        eventData:
            name: APIG_test
            groupName: APIGroup_xxx
            auth: IAM
            protocol: HTTPS
            timeout: 5000
  • TIMER触发器
    表6 TIMER参数说明

    参数名

    必填

    类型

    参数描述

    name

    False

    String

    定时器名称。

    scheduleType

    True

    Enum

    触发规则,取值为 Rate、Cron

    schedule

    True

    String

    定时器规则内容。

    userEvent

    False

    String

    附加信息,如果用户配置了触发事件,会将该事件填写到TIMER事件源的“user_event”字段。

    参考案例:
    trigger:
        triggerTypeCode: TIMER
        status: ACTIVE
        eventData:
            name: Timer-xxx
            scheduleType: Rate
            schedule: 3m
            userEvent: xxxx
    
    trigger:
        triggerTypeCode: TIMER
        status: ACTIVE
        eventData:
            name: Timer-xxx
            scheduleType: Cron
            schedule: 0 15 2 * * ?
            userEvent: xxxx
support.huaweicloud.com/devg-functiongraph/functiongraph_02_0725.html