更新时间:2022-04-18 GMT+08:00
分享

函数Trigger Management触发器模型

介绍Trigger Management触发器模型的返回字段。

触发器类型模型

{ 
    "trigger_type_code":"string", 
    "display_name":"string", 
    "status":"string", 
    "event_codes":"array of string", 
    "description":"string" 
}

触发器类型模型字段说明如表1所示。

表1 触发器类型模型字段说明

字段名称

字段说明

trigger_type_code

触发器类型代码,取值:SMN、APIG、OBS、TIMER、DMS、DIS、LTS、DDS、CTS、kafka、DEDICATEDGATEWAY、APIC。

display_name

触发器类型显示值。

status

触发器类型状态,可能的状态如下:

  • DISABLED:禁用该触发器。
  • TEST:触发器处于测试状态,用户端应设为不可见。
  • ACTIVE:触发器可用。

event_codes

触发器事件属性字段。

description

触发器说明。

触发器实例模型

{ 
    "trigger_id":"string",
    "trigger_type_code":"string",
    "event_type_code":"string",
    "status":"string",
    "event_data":"json struct",
    "last_updated_time":"string",
    "created_time":"string" 
}

触发器实例模型字段说明如表2所示。

表2 触发器实例模型字段说明

字段名称

字段说明

trigger_id

触发器ID。

trigger_type_code

触发器类型代码,取值:SMN、APIG、OBS、TIMER、DMS、DIS、LTS、DDS、CTS、kafka。

event_type_code

事件类型代码,必填字段,可以填任意非空字符串(deprecated)。

status

触发器状态:ACTIVE / DISABLED。

event_data

触发器相关定义数据,以JSON结构形式出现。

last_updated_time

最后一次更新时间。

created_time

创建时间。

触发器实例数据

  • SMN触发器数据如下。
    { 
        "topic_urn":"string", 
        "subscription_status":"string" 
    } 

    SMN触发器数据说明如表3所示。

    表3 SMN触发器数据说明

    字段名称

    字段说明

    topic_urn

    SMN服务的topic_urn,创建时必填。

    subscription_status

    topic_urn的订阅状态:Unconfirmed / Confirmed。

  • DMS触发器数据如下。
    { 
        "queue_id":"string", 
        "consumer_group_id":"string", 
        "polling_interval":"int" 
    }

    DMS触发器数据说明如表4所示。

    表4 DMS触发器数据说明

    字段名称

    字段说明

    queue_id

    DMS队列名,创建时必填。

    consumer_group_id

    DMS消费组名,创建时必填。

    polling_interval

    检查消息间隔,以秒为单位,缺省为30秒,创建时必填。

  • OBS触发器数据如下。
    { 
       "bucket": "yourBucketName", 
       "events": ["s3:ObjectCreated:Put"], 
       "prefix": "yourPrefix", 
       "suffix": "yourSuffix" 
    }
    表5 OBS触发器数据说明

    字段名称

    字段说明

    bucket

    OBS桶名,必填。

    events

    OBS触发事件集合,取值有如下情况:["s3:ObjectCreated:*","s3:ObjectCreated:Put","s3:ObjectCreated:Post","s3:ObjectCreated:Copy","s3:ObjectCreated:CompleteMultipartUpload","s3:ObjectRemoved:*","s3:ObjectRemoved:DeleteMarkerCreated","s3:ObjectRemoved:Delete"],必填。

    其中“s3:objectcreated:*”包含所有其他以“s3:objectcreated”开头的所有事件,“s3:objectremoved:*”包含所有以“s3:objectremoved”开头的所有事件。

    prefix

    OBS对象的前缀,选填。

    suffix

    OBS对象的后缀,选填。

  • DIS触发器数据如下。
    {
    "stream_name": "dis-qYPJ",
    "polling_interval": 30,
    "batch_size": 100,
    "sharditerator_type": "TRIM_HORIZON"
    }

    DIS触发器数据说明如表6所示。

    表6 DIS触发器数据说明

    字段名称

    字段说明

    stream_name

    通道名称,必填。

    polling_interval

    拉取周期,取值1 ~ 60,选填(不填会取默认值30)。

    batch_size

    每次拉取的记录数量,取值1 ~ 10000,选填(不填时,取默认值100)。

    sharditerator_type

    取值TRIM_HORIZON(从头开始拉取)/LATEST(从当前位置开始拉取),必填。

  • APIG触发器数据如下。
    { 
        "group_id":"string", 
        "env_id":"string", 
        "auth":"string", 
        "protocol":"string", 
        "name":"string", 
        "path":"string", 
        "match_mode":"string",  
        "req_method":"string" , 
        "backend_type":"string" , 
        "type": int , 
        "sl_domain":"string" , 
        "instance_id":"string" 
    }

    APIG触发器数据说明如表7所示。

    表7 APIG触发器数据说明

    字段名称

    字段说明

    group_id

    API分组,必填。

    env_id

    API发布环境,必填。

    auth

    API认证方式,三种可选模式: NONE/IAM/APP,必填。

    protocol

    访问协议,HTTP或HTTPS,必填。

    name

    API名称,必填。

    path

    API访问地址,需要服从URL规范,如/a/b,必填。

    match_mode

    匹配模式,当前只支持前缀匹配模式(SWA),必填。

    req_method

    API请求方式,枚举如:GET、POST、PUT,必填。

    backend_type

    后端类型:FUNCTION,必填。

    type

    API类型,当前只支持开放API类型(1),必填。

    sl_domain

    子域名,必填。

    instance_id

    实例ID,触发器类型"trigger_type_code"取值为“DEDICATEDGATEWAY”或者“APIC”必填

  • TIMER触发器数据如下。
    {
    	"name": "string",
    	"schedule_type": "string",
    	"schedule": "string",
    	"user_event": "string"
    }

    TIMER触发器数据说明如表8所示。

    表8 TIMER触发器数据说明

    字段名称

    字段说明

    name

    触发器名称,必填。

    schedule_type

    调度类型,两种可选模式:Rate/Cron,必填。

    schedule

    调度配置,分别根据不同的调度类型填写,必填。

    当选择Rate模式时,格式为数字加上m(分钟),h(小时),d(天),如3分钟为3m。

    user_event

    调用附加信息,作为调用函数时的参数,可选。

  • LTS触发器数据如下。
    {
    	"trigger_type_code": "LTS",
    	"event_type_code": "MessageCreated",
    	"trigger_status": "ACTIVE",
    	"event_data": {
    		"log_group_id": "3e4d3bf7-7bad-11e9-92c5-fa163e6216be",
    		"log_topic_id": "41d90375-7bad-11e9-8bcf-fa163ea23ac3",
    		"log_group_name": "lts-group-5b42",
    		"log_topic_name": "lts-topic-5f3e"
    	}
    }

    LTS数据说明如所表9示。

    表9 LTS触发器数据说明

    字段名称

    字段说明

    trigger_type_code

    触发器类型。

    event_type_code

    事件类型。

    trigger_status

    触发器状态。

    event_data

    触发器相关定义数据,以JSON结构形式出现。

    log_group_id

    LTS日志组,创建时必选。

    log_topic_id

    LTS日志主题,创建时必选。

    log_group_name

    LTS日志组名称。

    log_topic_name

    LTS日志主题名称。

  • CTS触发器数据如下。
    {
    	"name": "eqwrwe",
    	"operations": ["AAD:addprotocolrule:addProtocolRule", "BCS:baas-apiserver:scalePeers", "ARS:ars:setConfigArs"]
    }

    CTS触发器数据说明如表10所示。

    表10 CTS触发器数据说明

    字段名称

    字段说明

    name

    关键通知名称。

    operations

    操作列表。

    格式为:服务类型:资源类型A;资源类型B:操作名称1;操作名称2,例如:["ECS:ecs;server:restartServer;deleteServer",...]。

  • DDS触发器数据如下。
    {
    	"instance_id": "string",
            "collection_name": "string",
            "db_name": "string",
    	"db_password": string,
            "batch_size": int,
    }
    表11 DDS触发器数据说明

    字段名称

    字段说明

    instance_id

    文档数据库实例ID

    collection_name

    集合名称

    db_name

    文档数据库名称

    db_password

    文档数据库用户密码

    batch_size

    批次大小

  • Kafka触发器数据如下。
    {
            "instance_id": "string",
    	"topic_id": "[]string",
            "kafka_user": "string",
            "kafka_password": "string",
    	"kafka_ssl_enable": string,
            "batch_size": int,
    }
    表12 Kafka触发器数据说明

    字段名称

    字段说明

    instance_id

    Kafka实例ID

    topic_id

    主题ID

    kafka_user

    用户名

    kafka_password

    用户密码

    kafka_ssl_enable

    是否开启ssl验证(若开启则用户名和密码字段是为必选)

    batch_size

    批次大小

分享:

    相关文档

    相关产品

close