ListTriggers--函数服务-火山引擎

文档中心

立即注册

导航

ListTriggers

最近更新时间：2024.08.07 11:48:17首次发布时间：2024.08.07 11:48:17

批量获取所有触发器。

请求说明

请求方式：POST
请求地址：http://open.volcengineapi.com/?Action=ListTriggers&Version=2024-06-06 HTTP/1.1

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListTriggers	接口名称。当前 API 的名称为 `ListTriggers`。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 `2024-06-06`。
FunctionId	String	是	pqyqo9qa	函数 ID。

请求示例

POST http://open.volcengineapi.com/?Action=ListTriggers&Version=2024-06-06 HTTP/1.1
Content-Type: application/json
{
    "FunctionId": "pqyqo9qa"
}

返回参数

参数	类型	示例值	描述
Items	Array of Trigger	[{"Id": "558ycnuu", "Type": "tls", "Name": "TLSTrigger3", "Description": "", "CreationTime": "2024-07-22 07:15:54.522 +0000 UTC", "LastUpdateTime": "2024-07-22 07:27:17.739 +0000 UTC", "DetailedConfig": "", "Enabled": false}]	触发器列表。
Total	Integer	1	触发器总数。

Trigger

参数	类型	示例值	描述
Id	String	khq1moat	触发器 ID。
Name	String	apig-sales	触发器名称。
Type	String	timer	触发器类别: timer: 定时触发器 kafka: 消费 Kafka 消息队列 bmq: 消费 BMQ 消息队列 rocketmq: 消费 RocketMQ 消息队列 apig: 通过 APIG 网关触发函数 tos: 通过 TOS 事件触发函数 tls: 消费 TLS 日志并触发函数
Enabled	Boolean	true	触发器是否启用： true：启用 false：未启用
AccountID	String	2100222152	火山引擎账号 ID。
FunctionID	String	wrwskdhbd	函数 ID。
Description	String	apig sales 触发器	描述。
CreationTime	String	2024-02-13 02:36:23.033 +0000 UTC	创建时间。
ImageVersion	String	master_613da8e949e60491ec31be8d0e7e3f5d3d1785b1_20230327163215	触发器镜像版本。
DetailedConfig	String	{"UpstreamId":"uci4qt01aqt740c03bn80", "GatewayId":"gci4qsbefednv1ec32t5g"	触发器配置详情。目前只有 apig 和 tos 触发器类型含有配置详情。
LastUpdateTime	String	2024-02-13 02:36:23.033 +0000 UTC	更新时间。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListTriggers",
        "Version": "2024-06-06",
        "Service": "vefaas",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "558ycnuu",
                "Type": "tls",
                "Name": "TLSTrigger3",
                "Description": "",
                "CreationTime": "2024-07-22 07:15:54.522 +0000 UTC",
                "LastUpdateTime": "2024-07-22 07:27:17.739 +0000 UTC",
                "DetailedConfig": "",
                "Enabled": false
            }
        ],
        "Total": 1
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。