首页 事件总线EventBridge 开发参考 API参考指南 API目录 事件流 GetEventStreaming - 获取一个事件流的详细信息

GetEventStreaming - 获取一个事件流的详细信息

更新时间: 2023-10-09 11:32:01

获取一个事件流的详细信息。

接口说明

获取一个事件流的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
EventStreamingNamestring

要获取信息的事件流的名称。

myeventstreaming

返回参数

名称类型描述示例值
object
Messagestring

错误信息。

The event streaming [xxxx] not existed!
RequestIdstring

阿里云为该请求生成的唯一标识符。

7892F480-58C9-5067-AB35-8A7BEF****
Dataobject

返回数据。

EventStreamingNamestring

获取到的事件流的名称。

rocketmq-sync
Descriptionstring

获取到的事件流的描述。

RocketMQ-to-RocketMQ
Sourceobject

事件提供方。

SourceMNSParametersobject

Source MNS Parameters

RegionIdstring

地域ID。

cn-hangzhou
QueueNamestring

消息服务MNS的Queue的名称。

demo
IsBase64Decodeboolean

是否开启Base64编码。

true
SourceRabbitMQParametersobject

Source RabbitMQ Parameters

RegionIdstring

地域ID。

cn-hangzhou
InstanceIdstring

消息队列RabbitMQ版的实例的ID。

i-f8z9a9mcgwri1c1i****
VirtualHostNamestring

消息队列RabbitMQ版实例的Vhost的名称。

eb-connect
QueueNamestring

消息队列RabbitMQ版实例的Queue的名称。

comp
SourceRocketMQParametersobject

Source RocketMQ Parameters

RegionIdstring

消息队列RocketMQ版的地域ID。

cn-hangzhou
InstanceIdstring

消息队列RocketMQ版的实例ID。

i-f8zbher64dlm58pl****
Topicstring

消息的Topic。

topic_add_anima
Tagstring

消息的过滤标签

v1
Offsetstring

消息的消费位点。取值说明如下: CONSUME_FROM_LAST_OFFSET:从最新位点开始消费。 CONSUME_FROM_FIRST_OFFSET:从最早位点开始消费。 CONSUME_FROM_TIMESTAMP:从指定时间点的位点开始消费。

CONSUMEFROMLASTOFFSET
GroupIDstring

消息队列RocketMQ版的Group ID。

GID_group1
Timestamplong

时间戳。仅当参数Offset取值为CONSUME_FROM_TIMESTAMP时,该参数有效。

1636597951964
SourceKafkaParametersobject

Source Kafka Parameters

RegionIdstring

实例所在地域id。

cn-hangzhou
InstanceIdstring

实例id。

i-bp1fbtrnqmjvgq66****
Topicstring

Topic名称。

topic_empower_1642473600414
ConsumerGroupstring

订阅该Topic的消费者所对应的Group ID。

GID_TEST
OffsetResetstring

偏移量

latest
Networkstring

网络配置 :默认值Default,vpc网络是PublicNetwork

Default
VpcIdstring

VPC ID。

vpc-2zehizpoendb3****
VSwitchIdsstring

虚拟交换机ID。

vsw-wz9qqeovkwjxlu9uc****
SecurityGroupIdstring

安全组ID。

sg-2vcgdxz7o1n9zapp****
SourceMQTTParametersobject

Source MQTT源

RegionIdstring

地域ID。

cn-shanghai
InstanceIdstring

实例id

i-2ze06wqdwk0uq14k****
Topicstring

Topic 名称

TOPIC-cainiao-pcs-wms-instock-noPrealertPrintLabel
SourceDTSParametersobject

Source DTS源

TaskIdstring

任务id。

f86e5814-b223-482c-b768-3b873297****
BrokerUrlstring

数据订阅通道的网络地址及端口号信息。

Topicstring

数据订阅通道的订阅Topic。

TP_TEST_UNDERWRITE_ISSUE
Sidstring

消费组ID。

HD1
Usernamestring

消费组的账号。

admin
Passwordstring

消费组的账号密码

admin
InitCheckPointstring

消费位点,即SDK客户端消费第一条数据的时间戳,格式为Unix时间戳

1620962769
SourceSLSParametersobject

Source SLS源

Projectstring

日志服务SLS的日志项目。

dmmzk
LogStorestring

日志服务SLS的日志库。

waf-logstore
ConsumerGroupstring

消费组

ConsumePositionstring

起始消费位点,可以选择最早或最新位点,分别对应“begin”,“end”,也可以从指定时间开始消费,以秒为单位。

begin
RoleNamestring

授权事件总线EventBridge使用此角色读取SLS日志内容时,需满足条件:在RAM控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

testRole
FilterPatternstring

事件过滤规则,如果不指定表示匹配全部事件。

Sinkobject

事件目标

SinkMNSParametersobject

MNS事件目标

QueueNameobject

目标服务类型为消息服务MNS。

Valuestring

消息服务MNS的Queue的名称。

MyQueue
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
IsBase64Encodeobject

是否开启Base64编码。

Valuestring

开启Base64编码。

true
Formstring

事件转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

SinkRabbitMQParametersobject

Sink Rabbitmq的参数

InstanceIdobject

目标服务类型为消息队列RabbitMQ版。

Valuestring

消息队列RabbitMQ版的实例ID。

e5c9b727-e06c-4d7e-84d5-f8ce644e****
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

VirtualHostNameobject

消息队列RabbitMQ版实例的Vhost的名称。

Valuestring

消息队列RabbitMQ版实例的Vhost的名称。

rabbit-host
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

TargetTypeobject

目标类型。

Valuestring

目标类型。取值说明如下: Exchange:Exchange模式。 Queue:Queue模式。

Exchange/Queue
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Exchangeobject

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

Valuestring

消息队列RabbitMQ版实例的Exchange的名称。

a_exchange
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

RoutingKeyobject

消息的路由规则。 仅当参数TargetType配置为Exchange时,需配置此参数。

Valuestring

消息的路由规则。

housekeeping
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

QueueNameobject

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

Valuestring

实例的Queue的名称。

MyQueue
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
MessageIdobject

消息ID。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Propertiesobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkFcParametersobject

函数目标

ServiceNameobject

服务的名称

Valuestring

服务的名称

myService
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

FunctionNameobject

函数名称

Valuestring

函数名称

mFunction
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Concurrencyobject

投递并发度,最小1

Valuestring

投递并发度,最小1

1
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Qualifierobject

函数所属服务的别名

Valuestring

函数所属服务的别名

LATEST
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

InvocationTypeobject

同步或则异步。 Sync:同步。 Async:异步。

Valuestring

调用类型

Async
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Bodyobject

发送给函数的内容体

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkKafkaParametersobject

Sink kafak 参数

InstanceIdobject

目标服务类型为消息队列Kafka版。

Valuestring

实例ID。

Defaut_1283278472_s****
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Topicobject

主题名称

Valuestring

主题名称

topic-test
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Acksobject

确认信息

Valuestring

确认信息

1
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Keyobject

消息的标识

Valuestring

消息的标识

key
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Valueobject

消息内容

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkRocketMQParametersobject

Sink RocketMQ Parameters

InstanceIdobject

目标服务类型为消息队列RocketMQ版。

Valuestring

消息队列RocketMQ版的实例ID。

MQ_INST_164901546557****_BAAN****
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Topicobject

消息队列RocketMQ版实例的Topic。

Valuestring

消息队列RocketMQ版实例的Topic名称。

Mytopic
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Propertiesobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Keysobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Tagsobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkSLSParametersobject

Sink SLS Parameters

Projectobject

日志服务SLS的日志项目。

Valuestring

日志服务SLS的日志项目。

test-project
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

LogStoreobject

日志服务SLS的日志库。

Valuestring

日志服务SLS的日志库。

test-logstore
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Topicobject

日志所在的topic,对应SLS 保留字段“topic”。

Valuestring

日志所在的topic,对应SLS 保留字段“topic”。

testTopic
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
RoleNameobject

授权事件总线EventBridge使用此角色读取SLS日志内容时,需满足条件:在RAM控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

Valuestring

授权事件总线EventBridge使用此角色读取SLS日志内容时,需满足条件:在RAM控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

testRole
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

SinkFnfParametersobject

Sink Fnf 参数

FlowNameobject

流程名称

Valuestring

流程名称

test-streaming-fnf
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

ExecutionNameobject

执行名称

Valuestring

执行名称

123
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

Inputobject

执行输入信息

Valuestring

执行输入信息

123
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

RoleNameobject

角色配置

Valuestring

角色配置

Al****FNF-x****
Formstring

转换的格式。默认为CONSTANT。

CONSTANT
Templatestring

模板样式。

RunOptionsobject

运行环境参数。

MaximumTasksinteger

并发数

2
RetryStrategyobject

事件推送失败时的重试策略。

PushRetryStrategystring

重试策略:BACKOFFRETRY(退避重试)和EXPONENTIALDECAY_RETRY(指数衰减重试)

BACKOFFRETRY
MaximumEventAgeInSecondsfloat

最大重试时间

512
MaximumRetryAttemptsfloat

最大重试次数

2
ErrorsTolerancestring

异常容忍策略:NONE(不容忍异常)、ALL(容忍所有异常)

ALL
DeadLetterQueueobject

是否启用死信队列。默认不启用死信队列,超过重试策略后的消息将被丢弃。

Arnstring

死信队列ARN

acs:ram::155020394332****:role/edskmstoecs
BatchWindowobject

攒批窗口。

CountBasedWindowinteger

窗口中最大可容纳的事件数量。当达到此阈值,会触发窗口内的数据往下游推送。当存在多个窗口时,有一个窗口满足即触发。

100
TimeBasedWindowinteger

窗口中最大可容纳的时间范围内的事件(单位秒)。当达到此阈值,会触发窗口内的数据往下游推送。当存在多个窗口时,有一个窗口满足即触发。

10
Statusstring

获取到的事件流的状态。

RUNNING
Codestring

接口返回码:Success:表示成功。 其它:表示错误码。错误码详情,请参见错误码。

Success
Successboolean

操作成功返回true。

true

示例

正常返回示例

JSON格式

{
  "Message": "The event streaming [xxxx] not existed!",
  "RequestId": "7892F480-58C9-5067-AB35-8A7BEF****",
  "Data": {
    "EventStreamingName": "rocketmq-sync",
    "Description": "RocketMQ-to-RocketMQ",
    "Source": {
      "SourceMNSParameters": {
        "RegionId": "cn-hangzhou",
        "QueueName": "demo",
        "IsBase64Decode": true
      },
      "SourceRabbitMQParameters": {
        "RegionId": "cn-hangzhou",
        "InstanceId": "i-f8z9a9mcgwri1c1i****",
        "VirtualHostName": "eb-connect",
        "QueueName": "comp"
      },
      "SourceRocketMQParameters": {
        "RegionId": "cn-hangzhou",
        "InstanceId": "i-f8zbher64dlm58pl****",
        "Topic": "topic_add_anima",
        "Tag": "v1",
        "Offset": "CONSUMEFROMLASTOFFSET",
        "GroupID": "GID_group1",
        "Timestamp": 1636597951964
      },
      "SourceKafkaParameters": {
        "RegionId": "cn-hangzhou",
        "InstanceId": "i-bp1fbtrnqmjvgq66****",
        "Topic": "topic_empower_1642473600414",
        "ConsumerGroup": "GID_TEST",
        "OffsetReset": "latest",
        "Network": "Default",
        "VpcId": "vpc-2zehizpoendb3****",
        "VSwitchIds": "vsw-wz9qqeovkwjxlu9uc****",
        "SecurityGroupId": "sg-2vcgdxz7o1n9zapp****"
      },
      "SourceMQTTParameters": {
        "RegionId": "cn-shanghai",
        "InstanceId": "i-2ze06wqdwk0uq14k****",
        "Topic": "TOPIC-cainiao-pcs-wms-instock-noPrealertPrintLabel"
      },
      "SourceDTSParameters": {
        "TaskId": "f86e5814-b223-482c-b768-3b873297****",
        "BrokerUrl": "无",
        "Topic": "TP_TEST_UNDERWRITE_ISSUE",
        "Sid": "HD1",
        "Username": "admin",
        "Password": "admin",
        "InitCheckPoint": "1620962769"
      },
      "SourceSLSParameters": {
        "Project": "dmmzk",
        "LogStore": "waf-logstore",
        "ConsumerGroup": "无",
        "ConsumePosition": "begin",
        "RoleName": "testRole"
      }
    },
    "FilterPattern": "无",
    "Sink": {
      "SinkMNSParameters": {
        "QueueName": {
          "Value": "MyQueue",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Body": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!"
        },
        "IsBase64Encode": {
          "Value": "true",
          "Form": "CONSTANT",
          "Template": "无"
        }
      },
      "SinkRabbitMQParameters": {
        "InstanceId": {
          "Value": "e5c9b727-e06c-4d7e-84d5-f8ce644e****",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "VirtualHostName": {
          "Value": "rabbit-host\n",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "TargetType": {
          "Value": "Exchange/Queue",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Exchange": {
          "Value": "a_exchange",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "RoutingKey": {
          "Value": "housekeeping",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "QueueName": {
          "Value": "MyQueue",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Body": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!"
        },
        "MessageId": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!"
        },
        "Properties": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!\n"
        }
      },
      "SinkFcParameters": {
        "ServiceName": {
          "Value": "myService",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "FunctionName": {
          "Value": "mFunction",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Concurrency": {
          "Value": "1",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Qualifier": {
          "Value": "LATEST",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "InvocationType": {
          "Value": "Async",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Body": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!\n"
        }
      },
      "SinkKafkaParameters": {
        "InstanceId": {
          "Value": "Defaut_1283278472_s****",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Topic": {
          "Value": "topic-test",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Acks": {
          "Value": "1",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Key": {
          "Value": "key",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Value": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!\n"
        }
      },
      "SinkRocketMQParameters": {
        "InstanceId": {
          "Value": "MQ_INST_164901546557****_BAAN****",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Topic": {
          "Value": "Mytopic",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Body": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!\n"
        },
        "Properties": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!\n"
        },
        "Keys": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!"
        },
        "Tags": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!"
        }
      },
      "SinkSLSParameters": {
        "Project": {
          "Value": "test-project\n",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "LogStore": {
          "Value": "test-logstore",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Topic": {
          "Value": "testTopic",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Body": {
          "Value": "{\n      \"key\": \"value\"\n}",
          "Form": "TEMPLATE",
          "Template": "The value of ${key} is ${value}!\n"
        },
        "RoleName": {
          "Value": "testRole",
          "Form": "CONSTANT",
          "Template": "无"
        }
      },
      "SinkFnfParameters": {
        "FlowName": {
          "Value": "test-streaming-fnf",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "ExecutionName": {
          "Value": "123",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "Input": {
          "Value": "123",
          "Form": "CONSTANT",
          "Template": "无"
        },
        "RoleName": {
          "Value": "Al****FNF-x****",
          "Form": "CONSTANT",
          "Template": "无"
        }
      }
    },
    "RunOptions": {
      "MaximumTasks": 2,
      "RetryStrategy": {
        "PushRetryStrategy": "BACKOFFRETRY",
        "MaximumEventAgeInSeconds": 512,
        "MaximumRetryAttempts": 2
      },
      "ErrorsTolerance": "ALL",
      "DeadLetterQueue": {
        "Arn": "acs:ram::155020394332****:role/edskmstoecs"
      },
      "BatchWindow": {
        "CountBasedWindow": 100,
        "TimeBasedWindow": 10
      }
    },
    "Status": "RUNNING"
  },
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code错误码错误信息
403ServiceNotEnableService not enable

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-13OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
出参OpenAPI 返回结构发生变更
2023-04-21OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
出参OpenAPI 返回结构发生变更
2023-04-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
阿里云首页 事件总线EventBridge 相关技术圈