j9九游会登录/ 函数工作流 functiongraph/ api参考/ / / 获取触发器列表 - listactivetrigger
更新时间:2025-10-31 gmt 08:00

获取触发器列表 -j9九游会登录

功能介绍

获取触发器列表

调用方法

请参见。

授权信息

账号具备所有api的调用权限,如果使用账号下的iam用户调用当前api,该iam用户需具备调用api所需的权限,具体权限要求请参见权限和授权项

uri

get /v2/{project_id}/fgs/triggers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

string

参数解释:

租户项目 id,获取方式请参见获取项目id

约束限制:

不涉及

取值范围:

只能由英文字母、数字组成,且长度为32个字符

默认值:

不涉及

表2 query参数

参数

是否必选

参数类型

描述

marker

string

偏移量

maxitems

string

最大查询条数

trigger_type

string

触发器类型

请求参数

表3 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

string

参数解释:

用户token。

通过调用iam服务获取用户token接口获取(响应消息头中x-subject-token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

content-type

string

参数解释:

消息体的类型(格式)

约束限制:

不涉及

取值范围:

只能为application/json

默认值:

application/json

响应参数

状态码:200

表4 响应body参数

参数

参数类型

描述

triggers

array of listtriggerresult objects

触发器列表。

next_marker

long

下一次查询位置

total_count

long

触发器总数

表5 listtriggerresult

参数

参数类型

描述

trigger_id

string

触发器id。

trigger_type_code

string

参数解释

触发器类型代码。

取值范围

  • timer: 定时触发器。

  • cts: 云审计服务触发器。

  • dds: 文档数据库服务触发器。

  • dms: 分布式服务触发器。

  • dis: 数据接入服务触发器。

  • lts: 云日志服务触发器。

  • obs: 对象存储触发器。

  • smn: 消息通知服务触发器。

  • kafka: 专享版消息通知服务触发器。

  • rabbitmq: 分布式消息服务 rabbitmq触发器。

  • dedicatedgateway:专享版apig触发器。

  • opensourcekafka: 开源kafka触发器。

  • apic: romaconnect触发器。

  • gaussmongo: gaussmongo触发器。

  • eventgrid: 事件总线触发器。

  • iotda: 设备接入触发器。

  • rocketmq: 分布式消息处理rocketmq触发器。

  • dynamodb: 云数据库触发器。

trigger_status

string

"触发器状态"

  • active: 启用状态。

  • disabled: 禁用状态。

event_data

triggereventdataresponsebody object

触发器源事件。

last_updated_time

string

最后更新时间。

created_time

string

触发器创建时间。

func_urn

string

函数urn

表6 triggereventdataresponsebody

参数

参数类型

描述

name

string

参数解释

触发器名称。

取值范围

不涉及。

schedule_type

string

参数解释

定时触发类型(timer触发器参数)。

取值范围

  • rate:指定固定频率(分钟、小时、天数)定期调用函数,单位为分钟时,输入值不能超过60;单位为小时时,输入值不能超过24;单位为天时,输入值不能超过30。

  • cron:指定cron表达式定期调用函数

schedule

string

参数解释

定时触发规则(timer触发器参数)。

取值范围

  • 触发类型为rate时对应定时规则

  • 触发类型为cron时对应cron表达式

user_event

string

参数解释

附加信息(timer触发器参数)。

当timer触发器触发函数执行时,执行事件(函数的event参数)为:

{"version": "v1.0",

"time": "2018-06-01t08:30:00 08:00",

"trigger_type": "timer",

"trigger_name": "timer_001",

"user_event": "您输入的附加信息"}

取值范围

不涉及。

triggerid

string

参数解释

apig触发器id。(apig触发器参数)

取值范围

不涉及。

type

integer

参数解释

api接口类型(apig触发器参数)。

取值范围

  • 1:公有api。

  • 2:私有api。

path

string

参数解释

apig接口path路径(apig触发器参数)。

取值范围

需要符合uri的命名规则。

protocol

string

参数解释

api的请求协议(apig触发器参数)。

取值范围

  • http: http协议。

  • https: https协议。

req_method

string

参数解释

api的请求方式(apig触发器参数)。

取值范围

  • get:通过http的get请求触发。

  • post: 通过http的post请求触发。

  • put: 通过http的put请求触发。

  • delete: 通过http的delete请求触发。

  • head: 通过http的head请求触发。

  • patch: 通过http的patch请求触发。

  • options: 通过http的options请求触发。

  • any: 通过http的任何请求方式都能触发。

group_id

string

参数解释

api所属的分组编号(apig触发器参数)。

取值范围

不涉及。

group_name

string

参数解释

api所属的分组名称(apig触发器参数)。

取值范围

不涉及。

match_mode

string

参数解释

api的匹配方式(apig触发器参数)。

取值范围

  • swa:前缀匹配

  • normal:正常匹配(绝对匹配)

env_name

string

参数解释

api的发布环境(apig触发器参数)。

取值范围

不涉及。

env_id

string

参数解释

api的发布环境id(apig触发器参数)。

取值范围

不涉及。

api_id

string

参数解释

api编号(apig触发器参数)。

取值范围

不涉及。

api_name

string

参数解释

api名称(apig触发器参数)。

取值范围

不涉及。

auth

string

参数解释

api的认证方式(apig触发器参数)。

取值范围

  • iam:iam认证,只允许iam用户能访问,安全级别中等。

  • app:采用appkey&appsecret认证,安全级别高,推荐使用。

  • none:无认证模式,所有用户均可访问,不推荐使用。

invoke_url

string

参数解释

api调用地址(apig触发器参数)。

取值范围

不涉及。

func_info

apigtriggerfuncinfo object

参数解释

apig触发器对应的函数后端信息。

取值范围

不涉及。

sl_domain

string

参数解释

apig系统默认分配的子域名(apig触发器参数)。

取值范围

不涉及。

backend_type

string

参数解释

api的后端类型(apig触发器参数)。

取值范围

目前固定为function。

instance_id

string

参数解释

实例id。dds、kafka、rabbitmq、rocketmq触发器此参数必填。

取值范围

  • apig触发器:apig实例id

  • dds触发器:文档数据库实例id

  • kafka触发器:kafka实例id

  • rabbitmq触发器:rabbitmq实例id

  • rocketmq触发器:rocketmq实例id

instance_ip

string

参数解释

数据库ip地址(dynamodb触发器参数)。

取值范围

不涉及。

table_name

string

参数解释

数据库表名(dynamodb触发器参数)。

取值范围

不涉及。

roma_app_id

string

参数解释

api归属的集成应用编号。(apig触发器参数)

取值范围

不涉及。

operations

array of strings

参数解释

自定义操作(cts触发器参数)。

cts云审计服务类型和操作订阅所需要的事件通知,当cts云审计服务获取已订阅的操作记录后,通过cts触发器将采集到的操作记录作为参数传递来调用functiongraph函数。

取值范围

不涉及。

collection_name

string

参数解释

集合名称(dds触发器参数)。

取值范围

不涉及。

db_name

string

参数解释

文档数据库名称(dds触发器参数)。

取值范围

不涉及。

db_password

string

参数解释

文档数据库密码(dds触发器参数)。

取值范围

不涉及。

db_user

string

参数解释

文档数据库用户名(dds触发器参数)。

取值范围

不涉及。

instance_addrs

array of strings

参数解释

文档数据库实例地址(dds触发器参数)。

取值范围

不涉及。

mode

string

参数解释

文档数据库实例类型(dds触发器参数)。

取值范围

  • sharding:集群实例。

  • replicaset:副本集实例。

  • single:单节点实例。

batch_size

integer

参数解释

批处理大小,单次函数执行处理的最大数据量。dis、dds、kafka、rabbitmq、rocketmq触发器此参数必填。

取值范围

  • dds触发器:批处理大小设置1-10,000的范围内

  • dis触发器:批处理大小设置1-10,000的范围内

  • kafka触发器:批处理大小设置1-1,000的范围内

  • rabbitmq触发器:批处理大小设置1-1,000的范围内

  • rocketmq触发器:批处理大小设置1-1,000的范围内

  • dynamodb触发器:批处理大小设置1-1,000的范围内

queue_id

string

参数解释

队列id(dms触发器参数)。

取值范围

不涉及。

consumer_group_id

string

参数解释

消费组id(dms触发器参数)。

取值范围

不涉及。

polling_interval

integer

参数解释

拉取周期。

取值范围

不涉及。

stream_name

string

参数解释

通道名称(dis触发器参数)。

取值范围

不涉及。

sharditerator_type

string

参数解释

起始位置(dis/dynamodb触发器参数)。

取值范围

  • trim_horizon:从最早被存储至分区的有效记录开始读取。

  • latest:从分区中的最新记录开始读取,此设置可以保证总是读到分区中最新记录。

polling_unit

string

参数解释

拉取周期单位(dis触发器参数)。

取值范围

  • s:秒。

  • ms:毫秒。

max_fetch_bytes

integer

参数解释

最大提取字节数(dis触发器参数)。

取值范围

不涉及。

is_serial

string

参数解释

串行处理数据(dis触发器参数)。

取值范围

  • true:取一次数据处理完之后才会取下一次数据。

  • false: 只要拉取周期到了就会取数据进行处理。

log_group_id

string

参数解释

日志组id(lts触发器参数)。

取值范围

不涉及。

log_topic_id

string

参数解释

日志流id(lts触发器参数)。

取值范围

不涉及。

bucket

string

参数解释

桶名称(obs触发器参数),用作事件源的obs存储桶,不能和本用户已有桶重名;不能和其他用户已有的桶重名;创建成功后不支持修改。

取值范围

不涉及。

prefix

string

参数解释

前缀(obs触发器参数),输入一个可选性前缀来限制对以此关键字开头的对象的通知。

取值范围

不涉及。

suffix

string

参数解释

后缀(obs触发器参数),输入一个可选性后缀来限制对以此关键字结尾的对象的通知。

取值范围

不涉及。

events

array of strings

参数解释

触发事件(obs触发器参数)。

取值范围

  • objectcreated:表示所有创建对象的操作,包含put、post、copy对象以及合并段

  • put:使用put方法上传对象

  • post:使用post方法上传对象

  • copy:使用copy方法复制对象

  • completemultipartupload:表示合并分段任务

  • objectremoved:表示删除对象

  • delete:指定对象版本号删除对象

  • deletemarkercreated:不指定对象版本号删除对象

topic_urn

string

参数解释

主题urn(smn触发器参数)。

取值范围

不涉及。

topic_ids

array of strings

参数解释

kafka主题id列表(kafka触发器参数)。

取值范围

不涉及。

kafka_user

string

参数解释

kafka账户名(kafka触发器参数)。

取值范围

不涉及。

kafka_password

string

参数解释

kafka账户密码(kafka触发器参数)。

取值范围

不涉及。

kafka_connect_address

string

参数解释

kafka实例连接ip地址(kafka触发器参数)。

取值范围

不涉及。

kafka_ssl_enable

boolean

参数解释

kafka连接是否开启安全认证(kafka触发器参数)。

取值范围

不涉及。

access_password

string

参数解释

rabbitmq账户密码(rabbitmq触发器参数)。

取值范围

不涉及。

access_user

string

参数解释

rabbitmq账户名(rabbitmq触发器参数)。

取值范围

不涉及。

connect_address

string

参数解释

实例连接ip地址(rabbitmq触发器参数)。

取值范围

不涉及。

exchange_name

string

参数解释

交换机名称(rabbitmq触发器参数)。

取值范围

不涉及。

vhost

string

参数解释

虚拟机名称(rabbitmq触发器参数)。

取值范围

不涉及。

ssl_enable

boolean

参数解释

rabbitmq连接是否开启安全认证(rabbitmq触发器参数)。

取值范围

  • true:开启。

  • false:不开启。

enable_acl

boolean

参数解释

rocketmq连接是否开启用户名密码认证(rocketmq触发器参数)。

取值范围

  • true:开启。

-false:不开启。

access_key

string

参数解释

连接用户名(rocketmq触发器参数),enable_acl为true时此参数必填。

取值范围

不涉及。

secret_key

string

参数解释

连接密码(rocketmq触发器参数),enable_acl为true时此参数必填。

取值范围

不涉及。

key_encode

boolean

参数解释

eg obs触发器是否对对象加密(eventgrid触发器参数)。

取值范围

  • true:开启。

  • false:不开启。

agency

string

参数解释

使用的代理(eventgrid触发器参数)。

取值范围

不涉及。

channel_name

string

参数解释

通道名称(eventgrid触发器参数)。

取值范围

不涉及。

channel_id

string

参数解释

通道id(eventgrid触发器参数)。

取值范围

不涉及。

source_name

string

参数解释

事件源名称(eventgrid触发器参数)。

取值范围

不涉及。

created_time

string

参数解释

创建时间(eventgrid触发器参数)。

取值范围

时间字符串。

status

string

参数解释

触发器状态(eventgrid触发器参数)。

取值范围

  • active: 触发器处于启用状态。

  • disable: 触发器处于禁用状态。

trigger_name

string

参数解释

触发器名称(eventgrid触发器参数)。

取值范围

不涉及。

event_types

array of strings

参数解释

事件类型(eventgrid触发器参数)。

取值范围

不涉及。

表7 apigtriggerfuncinfo

参数

参数类型

描述

function_urn

string

参数解释

函数的urn,详细解释见functiongraph函数模型的描述。

取值范围

不涉及。

invocation_type

string

参数解释

调用函数执行方式。

取值范围

  • sync:同步执行。

  • async:异步执行。

timeout

integer

参数解释

api网关请求函数服务的超时时间(毫秒)。apig触发器此参数必填。

取值范围

1~60000秒。

version

string

参数解释

函数版本信息。

取值范围

不涉及。

状态码:401

表8 响应body参数

参数

参数类型

描述

error_code

string

错误码

error_msg

string

错误信息

状态码:403

表9 响应body参数

参数

参数类型

描述

error_code

string

错误码

error_msg

string

错误信息

状态码:500

表10 响应body参数

参数

参数类型

描述

error_code

string

错误码

error_msg

string

错误信息

请求示例

获取触发器列表。

get /v2/{project_id}/fgs/triggers

响应示例

状态码:200

ok

{
  "triggers" : [ {
    "trigger_id" : "f8cf27db-86ae-4542-a3c2-f0c98905xxxx",
    "trigger_type_code" : "timer",
    "trigger_status" : "active",
    "event_data" : {
      "name" : "timer-54f1",
      "schedule" : "3m",
      "schedule_type" : "rate"
    },
    "last_updated_time" : "2022-11-09 16:37:24",
    "created_time" : "2022-11-09 16:37:24",
    "func_urn" : "urn:fss:{region}:09f7170b2c800f5a2fe2c00706fdxxxx:function:ldd:ecs-down:latest"
  } ]
}

状态码

状态码

描述

200

ok

401

unauthorized 鉴权失败。

403

forbidden 没有操作权限。

500

internal server error 服务内部错误。

错误码

请参见错误码

相关文档

网站地图