创建 Kafka 触发器。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateKafkaTrigger | 接口名称。当前 API 的名称为 CreateKafkaTrigger。 |
| Version | String | 是 | 2024-06-06 | 接口版本。当前 API 的版本为 2024-06-06。 |
FunctionId | String | 是 | wrw****** | 函数 ID。 |
Name | String | 是 | reviews-consumer | Kafka 触发器名字。
|
| Description | String | 否 | 示例 kafka 触发器 | Kafka 触发器描述。长度限制为 200 个字符以内。 |
MqInstanceId | String | 是 | kafka-cnngl4ifv****** | 消息队列 Kafka 实例 ID。 |
TopicName | String | 是 | reviews-topic | 消息队列 Kafka 实例的 Topic 名称。 |
Enabled | Boolean | 否 | true | 是否在创建触发器的同时启用触发器。取值：
说明 只有处于启用状态的触发器才能够正常工作。 |
StartingPosition | String | 否 | Latest | 指定开始消费 Topic 中消息的位置。取值：
|
| MaximumRetryAttempts | Integer | 否 | 100 | 函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。 |
| KafkaCredentials | Object of KafkaCredentials | 是 | {"Mechanism":"PLAIN","Username":"demo-name","Password":"xxxxxxxxxx"} | Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。 |
| BatchSize | Integer | 否 | 10 | 触发器批量消费的每批次消息数。建议取值不超过 1000。 |
BatchFlushDurationMilliseconds | Integer | 否 | 1000 | 触发器批量消费的最长等待时间。单位为毫秒（ms），取值范围为 1000 ~ 60000 ms，默认值为 1000 ms。 注意 该参数仅在已配置 BatchSize 参数时生效。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Password | String | 是 | xxxxxxxxxx | 创建 Kafka 实例时设置的 SASL/PLAIN 用户密码。 |
Username | String | 是 | demo-name | 创建 Kafka 实例时设置的 SASL/PLAIN 用户名称。 |
Mechanism | String | 是 | PLAIN | Kafka 认证机制。取值：
|
POST http://open.volcengineapi.com/?Action=CreateKafkaTrigger&Version=2024-06-06 HTTP/1.1 Content-Type: application/json { "FunctionId": "wrw******", "Name": "reviews-consumer", "Description": "示例 kafka 触发器", "MqInstanceId": "kafka-cnngl4ifv******", "TopicName": "reviews-topic", "Enabled": true, "StartingPosition": "Latest", "MaximumRetryAttempts": 100, "KafkaCredentials": { "Mechanism": "PLAIN", "Username": "demo-name", "Password": "xxxxxxxxxx" } }
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| FunctionId | String | wrw****** | 函数 ID。 |
| Name | String | reviews-consumer | Kafka 触发器名字。 |
| Description | String | 示例 kafka 触发器 | Kafka 触发器描述。 |
Enabled | Boolean | true | 是否启用 Kafka 触发器。参数值说明：
|
| MqInstanceId | String | kafka-cnngl4if****** | 消息队列 Kafka 实例 ID。 |
| TopicName | String | reviews-topic | 消息队列 Kafka 实例的 Topic 名称。 |
StartingPosition | String | Latest | 开始消费 Topic 中消息的位置。参数值说明：
|
| MaximumRetryAttempts | Integer | 100 | 函数发生运行错误时的最大重试次数。 |
| Id | String | 18lt**** | Kafka 触发器 ID。 |
| ConsumerGroup | String | reviews-topic_18lt**** | 消息队列 Kafka 实例的消费组名字。 |
Status | String | pending | Kafka 触发器状态。参数值说明：
|
CreationTime | String | 2025-02-03 06:47:41.423691239 +0000 UTC | Kafka 触发器的创建时间。 |
LastUpdateTime | String | 2025-02-03 06:47:41.423691239 +0000 UTC | Kafka 触发器的最近一次更新时间。 |
| BatchSize | Integer | 10 | 触发器批量消费的每批次消息数。 |
| BatchFlushDurationMilliseconds | Integer | 1000 | 触发器批量消费的最长等待时间。单位为毫秒。 |
HTTP/1.1 200 OK Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "CreateKafkaTrigger", "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" } }
当前接口暂无独立错误码，若接口调用返回异常，可参考 公共错误码 进行故障排查。