调用ListEventStreamings接口查询已创建的所有事件流的信息。

URL

/eventstreaming/listEventStreamings

注意事项

  • 在同一事件流中,参数SourceMNSParametersSourceRocketMQParametersSourceRabbitMQParameters同时只能返回一个。
  • 在同一事件流中,参数SinkMNSParametersSinkRocketMQParametersSinkRabbitMQParameters同时只能返回一个。

请求参数

无。

返回参数

名称 类型 示例值 描述
EventStreamingName String rocketmq-sync 获取到的事件流的名称。
Description String RocketMQ-to-RocketMQ 获取到的事件流的描述。
Status String RUNNING 获取到的事件流的状态。
Source Object SourceRocketMQParameters 事件提供方。
SourceMNSParameters Object 事件提供方为消息服务MNS
SourceRocketMQParameters Object 事件提供方为消息队列RocketMQ版
SourceRabbitMQParameters Object 事件提供方为消息队列RabbitMQ版
FilterPattern Map 事件过滤规则,如果不指定表示匹配全部事件。
Sink Object SinkRocketMQParameters 事件目标。
SinkMNSParameters Object 事件目标为消息服务MNS
SinkRocketMQParameters Object 事件目标为消息队列RocketMQ版
SinkRabbitMQParameters Object 事件目标为消息队列RabbitMQ版
RunOptions Map 运行环境参数。
RetryStrategy String BACKOFF_RETRY 事件推送失败时的重试策略。取值说明如下:
  • BACKOFF_RETRY:退避重试策略。重试3次,每次重试的间隔时间是10秒到20秒之间的随机值。
  • EXPONENTIAL_DECAY_RETRY:指数衰减重试。重试176次,每次重试的间隔时间指数递增至512秒,总计重试时间为1天;每次重试的具体间隔为:1,2,4,8,16,32,64,128,256,512,512...512秒(共167个512)。
ErrorsTolerance String ALL 容错策略,即发生错误时是否选择容错。取值说明如下:
  • ALL:允许容错。
  • NONE:禁止容错。

返回参数SourceMNSParameters

名称 类型 示例值 描述
QueueName String demo 消息服务MNS的Queue的名称。
IsBase64Decode String true 是否开启Base64编码。

返回参数SourceRocketMQParameters

名称 类型 示例值 描述
RegionId String cn-hangzhou 消息队列RocketMQ版的实例所属地域。
InstanceId String MQ_INST_164901546557****_BAAN**** 消息队列RocketMQ版的实例ID。更多信息,请参见使用限制
Topic String mytopic 消息队列RocketMQ版实例的Topic名称。更多信息,请参见使用限制
Tag String test 消息的过滤标签。
Offset String CONSUME_FROM_TIMESTAMP 消息的消费位点。取值说明如下:
  • CONSUME_FROM_LAST_OFFSET:从最新位点开始消费。
  • CONSUME_FROM_FIRST_OFFSET:从最早位点开始消费。
  • CONSUME_FROM_TIMESTAMP:从指定时间点的位点开始消费。
Timestamp Long 1636597951964 时间戳。仅当参数Offset取值为CONSUME_FROM_TIMESTAMP时,该参数有效。
GroupID String GID_group1 消息队列RocketMQ版的Group ID。

返回参数SourceRabbitMQParameters

名称 类型 示例值 描述
InstanceId String amqp-cn-nif22u74**** 消息队列RabbitMQ版的实例的ID。更多信息,请参见使用限制
VirtualHostName String eb-connect 消息队列RabbitMQ版实例的Vhost的名称。更多信息,请参见使用限制
QueueName String demo 消息队列RabbitMQ版实例的Queue的名称。更多信息,请参见使用限制

返回参数SinkMNSParameters

名称 类型 示例值 描述
QueueName TargetParameter 目标服务类型为消息服务MNS
Form String CONSTANT 转换的格式。
Value String MyQueue 消息服务MNS的Queue的名称。
IsBase64Encode TargetParameter 是否开启Base64编码。
Value String true 开启Base64编码。
Form String CONSTANT 转换的格式。
Body TargetParameter 消息内容。
Form String TEMPLATE 转换的格式。
Value String
{
  "key": "value"
}
转换前的值。

返回参数SinkRocketMQParameters

名称 类型 示例值 描述
InstanceId TargetParameter 目标服务类型为消息队列RocketMQ版
Value String MQ_INST_164901546557****_BAAN**** 消息队列RocketMQ版的实例ID。更多信息,请参见使用限制
Form String CONSTANT 转换的格式。
Topic TargetParameter 消息队列RocketMQ版实例的Topic。
Value String Mytopic 消息队列RocketMQ版实例的Topic名称。更多信息,请参见使用限制
Form String CONSTANT 转换的格式。
Body TargetParameter 消息内容。
Form String TEMPLATE
Value String
{
  "key": "value"
}
转换前的值。
Template String The value of ${key} is ${value}! 模板样式。
Properties TargetParameter 过滤属性。
Value String
{
  "key": "value"
}
转换前的值。
Form String TEMPLATE 转换的格式。
Template String The value of ${key} is ${value}! 模板样式。
Keys TargetParameter 过滤属性。
Value String
{
  "key": "value"
}
转换前的值。
Form String TEMPLATE 转换的格式。
Template String The value of ${key} is ${value}! 模板样式。
Tags TargetParameter 过滤属性。
Value String
{
  "key": "value"
}
转换前的值。
Form String TEMPLATE 转换的格式。
Template String The value of ${key} is ${value}! 模板样式。

返回参数SinkRabbitMQParameters

名称 类型 示例值 描述
InstanceId TargetParameter 目标服务类型为消息队列RabbitMQ版
Value String amqp-cn-2r42e73o**** 消息队列RabbitMQ版的实例ID。更多信息,请参见使用限制
Form String CONSTANT 转换的格式。
VirtualHostName TargetParameter 消息队列RabbitMQ版实例的Vhost的名称。
Value String rabbit-host 消息队列RabbitMQ版实例的Vhost的名称。更多信息,请参见使用限制
Form String CONSTANT 转换的格式。
TargetType TargetParameter 目标类型。
Value String Exchange/Queue 目标类型。取值说明如下:
  • Exchange:Exchange模式。
  • Queue:Queue模式。
Form String CONSTANT 转换的格式。
Exchange TargetParameter Exchange模式。

仅当参数TargetType配置为Exchange时,需配置此参数。

Value String a_exchange 消息队列RabbitMQ版实例的Exchange的名称。更多信息,请参见使用限制
Form String CONSTANT 转换的格式。
RoutingKey TargetParameter 消息的路由规则。

仅当参数TargetType配置为Exchange时,需配置此参数。

Value String housekeeping 消息的路由规则。
Form String CONSTANT 转换的格式。
QueueName TargetParameter Queue模式。

仅当参数TargetType配置为Queue时,需配置此参数。

Value String MyQueue 实例的Queue的名称。更多信息,请参见使用限制
Form String CONSTANT 转换的格式。
Body TargetParameter 消息内容。
Form String TEMPLATE 转换的格式。
Value String
{
  "key": "value"
}
转换前的值。
Template String The value of ${key} is ${value}! 模板样式。
MessageId TargetParameter 消息ID。
Value String
{
  "key": "value"
}
转换前的值。
Form String TEMPLATE 转换的格式。
Template String The value of ${key} is ${value}! 模板样式。
Properties TargetParameter 过滤属性。
Value String
{
  "key": "value"
}
转换前的值。
Form String TEMPLATE 转换的格式。
Template String The value of ${key} is ${value}! 模板样式。

示例

请求示例

POST /eventstreaming/listEventStreaming HTTP/1.1
Host: 164901546557****.eventbridge.cn-hangzhou.aliyuncs.com
Date: Sat, 18 Apr 2020 05:30:41 GMT
x-eventbridge-version: 2020-04-01
Authorization: acs vZ3VL0SuJdHi****:Jo2PbT******azYAYoYslKLvWzg=
Content-Type: application/json;charset=UTF-8
Content-Length: 26
            

返回示例

{
    "code":"200",
    "data":{
        "RequestId":"0BC5C278-5ADC-1F46-B2E5-3699C207****",
        "Data":{
            "EventStreamings":[
                {
                    "Status":"READY",
                    "FilterPattern":"{}",
                    "Description":"RocketMQ-to-RocketMQ",
                    "Sink":{
                        "SinkRocketMQParameters":{
                            "InstanceId":{
                                "Form":"CONSTANT",
                                "Value":"MQ_INST_164901546557****_BAAN5UF8"
                            },
                            "Keys":{
                                "Form":"JSONPATH",
                                "Value":"systemProperties.KEYS"
                            },
                            "Topic":{
                                "Form":"CONSTANT",
                                "Value":"mytopic"
                            },
                            "Properties":{
                                "Form":"JSONPATH",
                                "Value":"systemProperties"
                            },
                            "Body":{
                                "Form":"TEMPLATE",
                                "Value":"{\n  \"key\": \"value\"\n}",
                                "Template":"The value of ${key} is ${value}!"
                            },
                            "Tags":{
                                "Form":"JSONPATH",
                                "Value":"systemProperties.TAGS"
                            }
                        }
                    },
                    "EventStreamingName":"rocketmq-sync",
                    "Source":{
                        "SourceRocketMQParameters":{
                            "InstanceId":"MQ_INST_164901546557****_BAAN5UF8",
                            "RegionId":"cn-hangzhou",
                            "Tag":"test",
                            "Topic":"mytopic",
                            "Offset":"CONSUME_FROM_LAST_OFFSET",
                            "GroupID":"GID_group1"
                        }
                    },
                    "RunOptions":{
                        "ErrorsTolerance":"ALL",
                        "DeadLetterQueue":{

                        },
                        "MaximumTasks":0,
                        "RetryStrategy":{
                            "PushRetryStrategy":"BACKOFF_RETRY",
                            "MaximumRetryAttempts":0,
                            "MaximumEventAgeInSeconds":0
                        }
                    }
                },
                {
                    "Status":"READY",
                    "FilterPattern":"{}",
                    "Description":"rocketmq-2-mns",
                    "Sink":{
                        "SinkMNSParameters":{
                            "IsBase64Encode":{
                                "Form":"CONSTANT",
                                "Value":"true"
                            },
                            "QueueName":{
                                "Form":"CONSTANT",
                                "Value":"MyQueue"
                            },
                            "Body":{
                                "Form":"TEMPLATE",
                                "Value":"{\n  \"key\": \"value\"\n}",
                                "Template":"The value of ${key} is ${value}!"
                            }
                        }
                    },
                    "EventStreamingName":"my-streaming",
                    "Source":{
                        "SourceRocketMQParameters":{
                            "InstanceId":"MQ_INST_164901546557****_BAAN5UF8",
                            "RegionId":"cn-hangzhou",
                            "Tag":"",
                            "Topic":"my-topic",
                            "Timestamp":1636597951964,
                            "Offset":"CONSUME_FROM_TIMESTAMP",
                            "GroupID":"GID-pz-order"
                        }
                    },
                    "RunOptions":{
                        "ErrorsTolerance":"ALL",
                        "DeadLetterQueue":{

                        },
                        "MaximumTasks":0,
                        "RetryStrategy":{
                            "PushRetryStrategy":"BACKOFF_RETRY",
                            "MaximumRetryAttempts":0,
                            "MaximumEventAgeInSeconds":0
                        }
                    }
                }
            ],
            "NextToken":"2",
            "Total":2
        },
        "Code":"Success",
        "Success":true
    },
    "httpStatusCode":"200",
    "requestId":"0BC5C278-5ADC-1F46-B2E5-3699C207****",
    "successResponse":true
}