获取 Kafka 触发器的详细信息。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetKafkaTrigger | 接口名称。当前 API 的名称为 GetKafkaTrigger 。 |
Version | String | 是 | 2024-06-06 | 接口版本。当前 API 的版本为 2024-06-06 。 |
Id | String | 是 | nw****** | Kafka 触发器 ID。 |
FunctionId | String | 是 | wrw****** | 函数 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 触发器。参数值说明:
|
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 触发器的最近一次更新时间。 |
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" } }
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。