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

文档中心

立即注册

导航

GetRocketMQTrigger

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

查询 RocketMQ 触发器详情。

请求说明

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	GetRocketMQTrigger	接口名称。当前 API 的名称为 `GetRocketMQTrigger`。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 `2024-06-06`。
Id	String	是	khq1moat	RocketMQ 触发器 ID。
FunctionId	String	是	ajqns826	函数 ID。

请求示例

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

返回参数

参数	类型	示例值	描述
FunctionId	String	ajqns826	函数 ID。
Name	String	rmq1	RocketMQ 触发器名称。
Description	String	轻量级官网	RocketMQ 触发器的描述。
Enabled	Boolean	true	触发器是否启用： true：启用 false：未启用
MqInstanceId	String	rocketmq-cnoeaf70cd8b1234	RocketMQ 实例 ID。
TopicName	String	test	消费的 RocketMQ Topic。
StartingPosition	String	Latest	初始起始位置（最新或最早）。
MaximumRetryAttempts	Integer	100	最大重试次数。
Id	String	khq1moat	RocketMQ 触发器 ID。
ConsumerGroup	String	GID_test	RocketMQ 消费者组名称。
Status	String	ready	RocketMQ 触发器状态： pending：挂起 ready：就绪 failed：失败
Orderly	Boolean	false	RocketMQ 消费者是否按顺序消费： true：顺序 false：无序。
QPSLimit	Integer	0	所有 RocketMQ 消费者实例发送到函数的最大 QPS。
CreationTime	String	2024-02-13 02:36:23.033 +0000 UTC	RocketMQ 触发器创建时间。
LastUpdateTime	String	2024-02-13 02:36:23.033 +0000 UTC	RocketMQ 触发器最后更新时间。
Endpoint	String	http://rocketmq-cnoeaf70cd8b1234.rocketmq.ivolces.com:9876	RocketMQ 访问端点。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetRocketMQTrigger",
        "Version": "2024-06-06",
        "Service": "vefaas",
        "Region": "cn-beijing"
    },
    "Result": {
        "FunctionId": "ajqns826",
        "Name": "rmq1",
        "Description": "轻量级官网",
        "Enabled": true,
        "MqInstanceId": "rocketmq-cnoeaf70cd8b1234",
        "TopicName": "test",
        "StartingPosition": "Latest",
        "MaximumRetryAttempts": 100,
        "Id": "khq1moat",
        "ConsumerGroup": "GID_test",
        "Status": "ready",
        "Orderly": true,
        "QPSLimit": 0,
        "CreationTime": "2024-02-13 02:36:23.033 +0000 UTC",
        "LastUpdateTime": "2024-02-13 02:36:23.033 +0000 UTC",
        "Endpoint": "http://rocketmq-cnoeaf70cd8b1234.rocketmq.ivolces.com:9876"
    }
}

错误码

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