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

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eventbridge:GetEventStreamingget
  • EventStreaming
    acs:eventbridge:{#regionId}:{#accountId}:eventstreaming/{#EventStreamingName}

请求参数

名称类型必填描述示例值
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) 参数。

RegionIdstring

地域 ID。

cn-hangzhou
QueueNamestring

轻量消息队列(原 MNS)的 Queue 的名称。

demo
IsBase64Decodeboolean

是否开启 Base64 编码。

true
SourceRabbitMQParametersobject

Source RabbitMQ 源。

RegionIdstring

地域 ID。

cn-hangzhou
InstanceIdstring

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

i-f8z9a9mcgwri1c1i****
VirtualHostNamestring

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

eb-connect
QueueNamestring

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

comp
SourceRocketMQParametersobject

Source RocketMQ 源。

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
InstanceTypestring

实例类型。取值说明如下:

  • Cloud_4:阿里云 RocketMQ 4.0 版本实例(默认选项)
  • Cloud_5:阿里云 RocketMQ 5.0 版本实例
  • SelfBuilt:自建 Apache RocketMQ 集群
Cloud_4
InstanceEndpointstring

实例接入点。

reg****-vpc.cn-zhangjiakou.aliyuncs.com
AuthTypestring

鉴权类型。

ACL
InstanceUsernamestring

实例用户名。

xxxa
InstancePasswordstring

实例密码。

xxxa
InstanceVpcIdstring

实例 VPC 信息。

vpc-m5e3sv4b12345****
InstanceVSwitchIdsstring

实例交换机信息。

vsw-m5ev8asdc6h12****
InstanceSecurityGroupIdstring

实例安全组信息。

sg-m5edtu24f12345****
InstanceNetworkstring

实例网络信息:

  • PublicNetwork
  • PrivateNetwork
PublicNetwork
BodyDataTypestring

消息编码格式:

  • JSON
  • Text
  • Binary
JSON
FilterTypestring

消息过滤类型。

Tag
FilterSqlstring

sql 过滤语句。

index > 10
VpcIdstring

VPC 的 ID。

vpc-m5e3sv4b12345****
VSwitchIdsstring

交换机 ID。

vsw-m5ev8asdc6h12345****
SecurityGroupIdstring

安全组 ID。

sg-m5edtu24f12345****
Networkstring

网络类型。

  • PublicNetwork
  • PrivateNetwork
PublicNetwork
SourceKafkaParametersobject

Source Kafka 源。

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****
ValueDataTypestring

编解码参数枚举值,有 3 个枚举值,命名如下

  1. JSON:现有逻辑,bytes 按 utf8 解码成字符串,解析为 JSON。
  2. Text:bytes 按 utf8 解码成字符串,直接放入 payload。
  3. Binary:bytes 按 base64 编码成字符串,放入 payload。
Text
SourceMQTTParametersobject

Source MQTT 源

RegionIdstring

地域 ID。

cn-shanghai
InstanceIdstring

实例 id。

i-2ze06wqdwk0uq14k****
Topicstring

Topic 名称。

TOPIC-cainiao-pcs-wms-instock-noPrealertPrintLabel
BodyDataTypestring

消息编码格式:

  • JSON
  • Text
  • Binary
JSON
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
SourcePrometheusParametersobject

Source Prometheus 事件源。

RegionIdstring

地域 id。

cn-hangzhou
ClusterIdstring

集群 id。

c83555068b6******ad213f565f209
DataTypestring

数据类型。

JSON
Labelsstring

标签。

__name__=.*
SourceCustomizedKafkaParametersobject

自定义 Kafka 事件源。

InstanceIdstring

消息队列 Kafka 版的实例 ID。

r-8vb64581862c****
SourceCustomizedKafkaConnectorParametersobject

自定义连接器 Apache Kafka 事件源。

ConnectorPackageUrlstring

OSS 资源 ZIP 包下载链接。

"https://examplebucket.oss-cn-hangzhou.aliyuncs.com/testDoc/Old_Homebrew/2024-06-26%2022%3A34%3A08/opt/homebrew/homebrew/Library/Homebrew/test/support/fixtures/cask/AppWithBinary.zip?OSSAccessKeyId=ri&Expires=1725539627&Signature=rb8q3OpV2i3gZJ"
ConnectorParametersobject

连接器参数。

Namestring

连接器名称。

test-name
Configobject

连接器配置。

{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParametersobject

实例配置。

{ "group.id": "connect-eb-cluster-KAFKA_CONNECTORC", "offset.storage.topic": "connect-eb-offset-KAFKA_CONNECTOR_yjqC8K5ewC", "config.storage.topic": "connect-eb-config-KAFKA_CONNECTOR_yjqC8K5ewC", "status.storage.topic": "connect-eb-status-KAFKA_CONNECTOR_yjqC8K5ewC", "consumer.group.id": "connector-eb-cluster-KAFKA_CONNECTOR_yjqC8K5ewC-mongo-sink", "bootstrap.servers": "alikafka-post:9092" }
SourceOSSParametersobject

Source OSS 事件源。

RoleNamestring

授权事件总线 EventBridge 读取 OSS 文件的角色名称,要求该角色至少具有 OSS 的只读权限。

eventbridge_oss_role
BucketNamestring

对象存储 OSS 中的存储空间名称。

bucket_abc
Prefixstring

文件路径前缀。

fun/document/
LoadModestring

数据加载模式,single 表示单文档加载,element 表示分块加载。 取值:single/element 默认为 single。

single
LoadFormatstring

文档加载器。

TextLoader
Delimiterstring

分隔符,在分块加载模式下,以该分隔符作为文本的分块标识符,默认以换行符\n 作为分隔符。

\n
FilterPatternstring

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

Transformsarray<object>

Transform 相关配置。

Transformsobject

云产品的 ARN,比如函数计算中函数的 ARN。

Arnstring

云产品的 ARN,比如函数计算中函数的 ARN。

acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func
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

模板样式。

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

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

Valuestring

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

rabbit-host
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

TargetTypeobject

目标类型。

Valuestring

目标类型。取值说明如下:

  • Exchange:Exchange 模式。
  • Queue:Queue 模式。
Exchange/Queue
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

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

Valuestring