Queries the details of an EventStreaming.

URL

/eventstreaming/getEventStreaming

Request parameters

Parameter Type Required Example Description
EventStreamingName String Yes myeventstreaming The name of the EventStreaming whose details you want to query.

Response parameters

Parameter Type Example Description
EventStreamingName String rocketmq-sync The name of the EventStreaming that is returned.
Description String RocketMQ-to-RocketMQ The description of the EventStreaming that is returned.
Status String RUNNING The status of the EventStreaming that is returned.
Source Object SourceRocketMQParameters The information about the event provider.
SourceMNSParameters Object The resource information configured when the event provider is MNS.
SourceRocketMQParameters Object The resource information configured when the event provider is Message Queue for Apache RocketMQ.
SourceRabbitMQParameters Object The resource information configured when the event provider is Message Queue for RabbitMQ.
FilterPattern Map N/A The event rule. If this parameter is left empty, all events are matched.
Sink Object SinkRocketMQParameters The information about the event target.
SinkMNSParameters Object The resource information configured when the event target is MNS.
SinkRocketMQParameters Object The resource information configured when the event target is Message Queue for Apache RocketMQ.
SinkRabbitMQParameters Object The resource information configured when the event target is Message Queue for RabbitMQ.
RunOptions Map The runtime environment.
RetryStrategy String BACKOFF_RETRY The retry policy that is used when an event fails to be pushed. Valid values:
  • BACKOFF_RETRY: backoff retry. The request can be retried up to three times. The interval between two consecutive retries is a random value between 10 and 20 seconds.
  • EXPONENTIAL_DECAY_RETRY: exponential decay retry. The request can be retried up to 176 times. The interval between two consecutive retries exponentially increases to 512 seconds, and the total retry time is one day. The specific retry intervals are 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 512, ..., and 512 seconds, including a maximum of one hundred and sixty-seven 512 seconds in total.
ErrorsTolerance String ALL The fault tolerance policy, which specifies whether an error is ignored when it occurs. Valid values:
  • ALL: The error is ignored.
  • NONE: The error is not ignored.

Response parameter SourceMNSParameters

Parameter Type Example Description
QueueName String demo The name of the queue in the MNS instance.
IsBase64Decode String true Indicates whether Base64 encoding is enabled.

Response parameter SourceRocketMQParameters

Parameter Type Example Description
RegionId String cn-hangzhou The ID of the region where the Message Queue for Apache RocketMQ instance resides.
InstanceId String MQ_INST_164901546557****_BAAN**** The ID of the Message Queue for Apache RocketMQ instance. For more information, see Limits.
Topic String mytopic The name of the topic in the Message Queue for Apache RocketMQ instance. For more information, see Limits.
Tag String test The tags for filtering.
Offset String CONSUME_FROM_TIMESTAMP The consumer offset of the message. Valid values:
  • CONSUME_FROM_LAST_OFFSET: Consumption starts from the latest offset.
  • CONSUME_FROM_FIRST_OFFSET: Consumption starts from the earliest offset.
  • CONSUME_FROM_TIMESTAMP: Consumption starts from the offset at the specified point in time.
Timestamp Long 1636597951964 The timestamp of the offset from which the consumption starts. This parameter is valid only when the Offset parameter is set to CONSUME_FROM_TIMESTAMP.
GroupID String GID_group1 The group ID of the Message Queue for Apache RocketMQ instance.

Response parameter SourceRabbitMQParameters

Parameter Type Example Description
InstanceId String amqp-cn-nif22u74**** The ID of the Message Queue for RabbitMQ instance. For more information, see Limits.
VirtualHostName String eb-connect The name of the vhost in the Message Queue for RabbitMQ instance. For more information, see Limits.
QueueName String demo The name of the queue in the Message Queue for RabbitMQ instance. For more information, see Limits.

Response parameter SinkMNSParameters

Parameter Type Example Description
QueueName TargetParameter The name of the queue specified when the event target is MNS.
Form String CONSTANT The transformation method.
Value String MyQueue The name of the queue in the MNS instance.
IsBase64Encode TargetParameter Indicates whether Base64 encoding is enabled.
Value String true Indicates whether Base64 encoding is enabled.
Form String CONSTANT The transformation method.
Body TargetParameter The content of the message.
Form String TEMPLATE The transformation method.
Value String 
{
  "key": "value"
}
 The value before the transformation.

Response parameter SinkRocketMQParameters

Parameter Type Example Description
InstanceId TargetParameter The ID of the Message Queue for Apache RocketMQ instance specified when the event target is Message Queue for Apache RocketMQ.
Value String MQ_INST_164901546557****_BAAN**** The ID of the Message Queue for Apache RocketMQ instance. For more information, see Limits.
Form String CONSTANT The transformation method.
Topic TargetParameter The topic in the Message Queue for Apache RocketMQ instance.
Value String Mytopic The name of the topic in the Message Queue for Apache RocketMQ instance. For more information, see Limits.
Form String CONSTANT The transformation method.
Body TargetParameter The content of the message.
Form String No TEMPLATE
Value String 
{
  "key": "value"
}
 The value before the transformation.
Template String The value of ${key} is ${value}! The template based on which events are transformed.
Properties TargetParameter The properties for filtering.
Value String 
{
  "key": "value"
}
 The value before the transformation.
Form String TEMPLATE The transformation method.
Template String The value of ${key} is ${value}! The template based on which events are transformed.
Keys TargetParameter The keys for filtering.
Value String 
{
  "key": "value"
}
 The value before the transformation.
Form String TEMPLATE The transformation method.
Template String The value of ${key} is ${value}! The template based on which events are transformed.
Tags TargetParameter The tags for filtering.
Value String 
{
  "key": "value"
}
 The value before the transformation.
Form String TEMPLATE The transformation method.
Template String The value of ${key} is ${value}! The template based on which events are transformed.

Response parameter SinkRabbitMQParameters

Parameter Type Example Description
InstanceId TargetParameter The ID of the Message Queue for RabbitMQ instance specified when the event target is Message Queue for RabbitMQ.
Value String amqp-cn-2r42e73o**** The ID of the Message Queue for RabbitMQ instance. For more information, see Limits.
Form String CONSTANT The transformation method.
VirtualHostName TargetParameter The name of the vhost in the Message Queue for RabbitMQ instance.
Value String rabbit-host The name of the vhost in the Message Queue for RabbitMQ instance. For more information, see Limits.
Form String CONSTANT The transformation method.
TargetType TargetParameter The type of the resource to which events are pushed.
Value String Exchange/Queue The type of the resource to which events are pushed. Valid values:
  • Exchange
  • Queue
Form String CONSTANT The transformation method.
Exchange TargetParameter The name of the exchange to which events are pushed in the destination instance.

This parameter is valid only when the TargetType parameter is set to Exchange.

Value String a_exchange The name of the exchange in the Message Queue for RabbitMQ instance. For more information, see Limits.
Form String CONSTANT The transformation method.
RoutingKey TargetParameter The routing rule of the message.

This parameter is valid only when the TargetType parameter is set to Exchange.

Value String housekeeping The routing rule of the message.
Form String CONSTANT The transformation method.
QueueName TargetParameter The name of the queue to which events are pushed in the destination instance.

This parameter is valid only when the TargetType parameter is set to Queue.

Value String MyQueue The name of the queue in the Message Queue for RabbitMQ instance. For more information, see Limits.
Form String CONSTANT The transformation method.
Body TargetParameter The content of the message.
Form String TEMPLATE The transformation method.
Value String 
{
  "key": "value"
}
 The value before the transformation.
Template String The value of ${key} is ${value}! The template based on which events are transformed.
MessageId TargetParameter The ID of the message.
Value String 
{
  "key": "value"
}
 The value before the transformation.
Form String TEMPLATE The transformation method.
Template String The value of ${key} is ${value}! The template based on which events are transformed.
Properties TargetParameter The properties for filtering.
Value String 
{
  "key": "value"
}
 The value before the transformation.
Form String TEMPLATE The transformation method.
Template String The value of ${key} is ${value}! The template based on which events are transformed.

Examples

Sample requests

POST /eventstreaming/getEventStreaming 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

{
    "EventStreamingName":"myeventstreaming"
}

Sample responses

HTTP/1.1 200 OK
Server: AliyunEventBridge
Connection: keep-alive
Content-Type: application/json;charset=utf-8
Content-Length: 79
x-eventbridge-request-id: 61027584-9E35-15F0-B9A7-9CC463D1****
Date: Sat, 18 Apr 2020 05:30:41 GMT

{
    "code":"200",
    "data":{
        "RequestId":"61027584-9E35-15F0-B9A7-9CC463D1****",
        "Data":{
            "Status":"STARTING",
            "FilterPattern":"{}",
            "Description":"rocketmq2rabbitmq",
            "Sink":{
                "SinkRabbitMQParameters":{
                    "Exchange":{
                        "Form":"CONSTANT",
                        "Value":"a_exchange"
                    },
                    "RoutingKey":{
                        "Form":"JSONPATH",
                        "Value":"housekeeping"
                    },
                    "VirtualHostName":{
                        "Form":"CONSTANT",
                        "Value":"dlq"
                    },
                    "InstanceId":{
                        "Form":"CONSTANT",
                        "Value":"amqp-cn-2r42e73o****"
                    },
                    "TargetType":{
                        "Form":"CONSTANT",
                        "Value":"Exchange"
                    },
                    "Properties":{
                        "Form":"JSONPATH",
                        "Value":"systemProperties"
                    },
                    "Body":{
                        "Form":"TEMPLATE",
                        "Value":"{"key": "value"}",
                        "Template":"The value of ${key} is ${value}."
                    },
                    "MessageId":{
                        "Form":"JSONPATH",
                        "Value":"message_001"
                    }
                }
            },
            "EventStreamingName":"myeventstreaming",
            "Source":{
                "SourceRocketMQParameters":{
                    "InstanceId":"MQ_INST_164901546557****_BAAN5UF8",
                    "RegionId":"cn-hangzhou",
                    "Tag":"",
                    "Topic":"mytopic",
                    "Offset":"CONSUME_FROM_TIMESTAMP",
                    "GroupID":"GID_group1",
                    "Timestamp":1636597951964
                }
            },
            "RunOptions":{
                "ErrorsTolerance":"ALL",
                "MaximumTasks":0,
                "RetryStrategy":{
                    "PushRetryStrategy":"BACKOFF_RETRY",
                }
            }
        },
        "Code":"Success",
        "Success":true
    },
    "httpStatusCode":"200",
    "requestId":"61027584-9E35-15F0-B9A7-9CC463D1****",
    "successResponse":true
}