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

文档中心

立即注册

导航

GetKafkaTrigger

最近更新时间：2025.04.01 16:33:37首次发布时间：2025.03.14 16:37:23

获取 Kafka 触发器的详细信息。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	GetKafkaTrigger	接口名称。当前 API 的名称为 `GetKafkaTrigger`。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 `2024-06-06`。
Id	String	是	nw******	Kafka 触发器 ID。可以调用 ListTriggers 接口，获取触发器 ID。
FunctionId	String	是	wrw******	函数 ID。可以调用 ListFunctions 接口，获取函数 ID（`Items.Id`）。

请求示例

POST http://open.volcengineapi.com/?Action=GetKafkaTrigger&Version=2024-06-06 HTTP/1.1
Content-Type: application/json
{
    "Id": "nw******",
    "FunctionId": "wrw******"
}

返回参数

参数	类型	示例值	描述
FunctionId	String	wrw******	函数 ID。
Name	String	reviews-consumer	Kafka 触发器名字。
Description	String	示例 kafka 触发器	Kafka 触发器描述。
Enabled	Boolean	true	是否启用 Kafka 触发器。参数值说明： true：启用 false：关闭
MqInstanceId	String	kafka-cnngl4if******	消息队列 Kafka 实例 ID。
TopicName	String	reviews-topic	消息队列 Kafka 实例的 Topic 名称。
StartingPosition	String	Latest	开始消费 Topic 中消息的位置。参数值说明： Latest：只消费订阅 Topic 后产生的消息。 Earliest：从 Topic 中生产的第一条消息开始消费。
MaximumRetryAttempts	Integer	100	函数发生运行错误时的最大重试次数。
Id	String	18lt****	Kafka 触发器 ID。
ConsumerGroup	String	reviews-topic_18lt****	消息队列 Kafka 实例的消费组名字。
Status	String	pending	Kafka 触发器状态。参数值说明： ready：运行 failed：失败 pending：启动中
CreationTime	String	2025-02-03 06:47:41.423691239 +0000 UTC	Kafka 触发器的创建时间。标准 RFC3339 格式的 UTC+0 时间。
LastUpdateTime	String	2025-02-03 06:47:41.423691239 +0000 UTC	Kafka 触发器的最近一次更新时间。标准 RFC3339 格式的 UTC+0 时间。
BatchSize	Integer	10	触发器批量消费的每批次消息数。
BatchFlushDurationMilliseconds	Integer	1000	触发器批量消费的最长等待时间。单位为毫秒。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetKafkaTrigger",
        "Version": "2024-06-06",
        "Service": "vefaas",
        "Region": "cn-beijing"
    },
    "Result": {
        "FunctionId": "wrw******",
        "Name": "reviews-consumer",
        "Description": "示例 kafka 触发器",
        "Enabled": true,
        "MqInstanceId": "kafka-cnngl4if******",
        "TopicName": "reviews-topic",
        "StartingPosition": "Latest",
        "MaximumRetryAttempts": 100,
        "Id": "18lt****",
        "ConsumerGroup": "reviews-topic_18lt****",
        "Status": "pending",
        "CreationTime": "2025-02-03 06:47:41.423691239 +0000 UTC",
        "LastUpdateTime": "2025-02-03 06:47:41.423691239 +0000 UTC"
    }
}

错误码

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