# 获取触发器列表 - ListActiveTrigger #### 功能介绍 获取触发器列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0200.html#functiongraph_06_0200)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-functiongraph/functiongraph_06_1100.html#functiongraph_06_1100)。 #### URI GET /v2/{project_id}/fgs/triggers 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 租户项目 ID，获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-functiongraph/functiongraph_06_0260.html#functiongraph_06_0260)。 **约束限制**: 不涉及 **取值范围**: 只能由英文字母、数字组成，且长度为32个字符 **默认值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 | 触发器总数 | 表5ListTriggerResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 表6TriggerEventDataResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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触发器参数）。 **取值范围**： 不涉及。 | 表7ApigTriggerFuncInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 服务内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-functiongraph/ErrorCode.html)。