You need to enable JavaScript to run this app.
导航
函数服务
  • 文档首页
    • /函数服务/API 参考/触发器/Kafka 触发器/CreateKafkaTrigger
CreateKafkaTrigger
最近更新时间：2025.03.14 16:37:23首次发布时间：2025.03.14 16:37:23
我的收藏
有用
有用
无用
无用

创建 Kafka 触发器。

请求说明

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

调试

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

请求参数

参数类型是否必选示例值描述
ActionString是CreateKafkaTrigger接口名称。当前 API 的名称为 CreateKafkaTrigger。
VersionString是2024-06-06接口版本。当前 API 的版本为 2024-06-06。

FunctionId

String

是

wrw******

函数 ID。
可以调用 ListFunctions 接口，获取函数 ID（Items.Id）。

Name

String

是

reviews-consumer

Kafka 触发器名字。

  • 同一函数下，触发器名称不可重复。
  • 只能包含大小写字母、数字、下划线，并且以字母开头，长度限制为 4~63 个字符。
DescriptionString否示例 kafka 触发器Kafka 触发器描述。长度限制为 200 个字符以内。

MqInstanceId

String

是

kafka-cnngl4ifv******

消息队列 Kafka 实例 ID。
可以调用 DescribeInstances 接口，获取 Kafka 实例 ID。

TopicName

String

是

reviews-topic

消息队列 Kafka 实例的 Topic 名称。
可以调用 DescribeTopics 接口，获取 Kafka 实例的 Topic 名称。

Enabled

Boolean

否

true

是否在创建触发器的同时启用触发器。取值：

  • true：启用。
  • false：关闭。

说明

只有处于启用状态的触发器才能够正常工作。

StartingPosition

String

否

Latest

指定开始消费 Topic 中消息的位置。取值：

  • Latest：只消费订阅 Topic 后产生的消息。
  • Earliest：从 Topic 中生产的第一条消息开始消费。
MaximumRetryAttemptsInteger否100函数发生运行错误（包括用户代码错误和 Runtime 错误）时的最大重试次数。取值范围为 0～100 的正整数。
KafkaCredentialsObject of KafkaCredentials是{"Mechanism":"PLAIN","Username":"demo-name","Password":"xxxxxxxxxx"}Kafka 身份认证。函数服务将通过 Kafka ACL 权限策略，对 PLAIN 和 SCRAM-SHA-256 两种类型的 SASL 用户进行消息消费鉴权。

KafkaCredentials

参数类型是否必选示例值描述

Password

String

是

xxxxxxxxxx

创建 Kafka 实例时设置的 SASL/PLAIN 用户密码。
可以调用 DescribeUsers 接口，获取 Kafka 实例 SASL/PLAIN 用户密码。

Username

String

是

demo-name

创建 Kafka 实例时设置的 SASL/PLAIN 用户名称。
可以调用 DescribeUsers 接口，获取 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"
    }
}

返回参数

参数类型示例值描述
FunctionIdStringwrw******函数 ID。
NameStringreviews-consumerKafka 触发器名字。
DescriptionString示例 kafka 触发器Kafka 触发器描述。

Enabled

Boolean

true

是否启用 Kafka 触发器。参数值说明：

  • true：启用
  • false：关闭
MqInstanceIdStringkafka-cnngl4if******消息队列 Kafka 实例 ID。
TopicNameStringreviews-topic消息队列 Kafka 实例的 Topic 名称。

StartingPosition

String

Latest

开始消费 Topic 中消息的位置。参数值说明：

  • Latest：只消费订阅 Topic 后产生的消息。
  • Earliest：从 Topic 中生产的第一条消息开始消费。
MaximumRetryAttemptsInteger100函数发生运行错误时的最大重试次数。
IdString18lt****Kafka 触发器 ID。
ConsumerGroupStringreviews-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 时间。

返回示例

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"
    }
}

错误码

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