获取一个事件流的详细信息。
接口说明
获取一个事件流的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
eventbridge:GetEventStreaming | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
EventStreamingName | string | 是 | 要获取信息的事件流的名称。 | myeventstreaming |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | 返回信息。 | ||
Message | string | 错误信息。 | The event streaming [xxxx] not existed! |
RequestId | string | 阿里云为该请求生成的唯一标识符。 | 7892F480-58C9-5067-AB35-8A7BEF**** |
Data | object | 返回数据。 | |
EventStreamingName | string | 获取到的事件流的名称。 | rocketmq-sync |
Description | string | 获取到的事件流的描述。 | RocketMQ-to-RocketMQ |
Source | object | 事件提供方。 | |
SourceMNSParameters | object | Source 轻量消息队列(原 MNS) 参数。 | |
RegionId | string | 地域 ID。 | cn-hangzhou |
QueueName | string | 轻量消息队列(原 MNS)的 Queue 的名称。 | demo |
IsBase64Decode | boolean | 是否开启 Base64 编码。 | true |
SourceRabbitMQParameters | object | Source RabbitMQ 源。 | |
RegionId | string | 地域 ID。 | cn-hangzhou |
InstanceId | string | 消息队列 RabbitMQ 版的实例的 ID。 | i-f8z9a9mcgwri1c1i**** |
VirtualHostName | string | 消息队列 RabbitMQ 版实例的 Vhost 的名称。 | eb-connect |
QueueName | string | 消息队列 RabbitMQ 版实例的 Queue 的名称。 | comp |
SourceRocketMQParameters | object | Source RocketMQ 源。 | |
RegionId | string | 消息队列 RocketMQ 版的地域 ID。 | cn-hangzhou |
InstanceId | string | 消息队列 RocketMQ 版的实例 ID。 | i-f8zbher64dlm58pl**** |
Topic | string | 消息的 Topic。 | topic_add_anima |
Tag | string | 消息的过滤标签 | v1 |
Offset | string | 消息的消费位点。取值说明如下: CONSUME_FROM_LAST_OFFSET:从最新位点开始消费。 CONSUME_FROM_FIRST_OFFSET:从最早位点开始消费。 CONSUME_FROM_TIMESTAMP:从指定时间点的位点开始消费。 | CONSUMEFROMLASTOFFSET |
GroupID | string | 消息队列 RocketMQ 版的 Group ID。 | GID_group1 |
Timestamp | long | 时间戳。仅当参数 Offset 取值为 CONSUME_FROM_TIMESTAMP 时,该参数有效。 | 1636597951964 |
InstanceType | string | 实例类型。取值说明如下:
| Cloud_4 |
InstanceEndpoint | string | 实例接入点。 | reg****-vpc.cn-zhangjiakou.aliyuncs.com |
AuthType | string | 鉴权类型。 | ACL |
InstanceUsername | string | 实例用户名。 | xxxa |
InstancePassword | string | 实例密码。 | xxxa |
InstanceVpcId | string | 实例 VPC 信息。 | vpc-m5e3sv4b12345**** |
InstanceVSwitchIds | string | 实例交换机信息。 | vsw-m5ev8asdc6h12**** |
InstanceSecurityGroupId | string | 实例安全组信息。 | sg-m5edtu24f12345**** |
InstanceNetwork | string | 实例网络信息:
| PublicNetwork |
BodyDataType | string | 消息编码格式:
| JSON |
FilterType | string | 消息过滤类型。 | Tag |
FilterSql | string | sql 过滤语句。 | index > 10 |
VpcId | string | VPC 的 ID。 | vpc-m5e3sv4b12345**** |
VSwitchIds | string | 交换机 ID。 | vsw-m5ev8asdc6h12345**** |
SecurityGroupId | string | 安全组 ID。 | sg-m5edtu24f12345**** |
Network | string | 网络类型。
| PublicNetwork |
SourceKafkaParameters | object | Source Kafka 源。 | |
RegionId | string | 实例所在地域 id。 | cn-hangzhou |
InstanceId | string | 实例 id。 | i-bp1fbtrnqmjvgq66**** |
Topic | string | Topic 名称。 | topic_empower_1642473600414 |
ConsumerGroup | string | 订阅该 Topic 的消费者所对应的 Group ID。 | GID_TEST |
OffsetReset | string | 偏移量。 | latest |
Network | string | 网络配置 :默认值 Default,vpc 网络是 PublicNetwork | Default |
VpcId | string | VPC ID | vpc-2zehizpoendb3**** |
VSwitchIds | string | 虚拟交换机 ID。 | vsw-wz9qqeovkwjxlu9uc**** |
SecurityGroupId | string | 安全组 ID。 | sg-2vcgdxz7o1n9zapp**** |
ValueDataType | string | 编解码参数枚举值,有 3 个枚举值,命名如下
| Text |
SourceMQTTParameters | object | Source MQTT 源 | |
RegionId | string | 地域 ID。 | cn-shanghai |
InstanceId | string | 实例 id。 | i-2ze06wqdwk0uq14k**** |
Topic | string | Topic 名称。 | TOPIC-cainiao-pcs-wms-instock-noPrealertPrintLabel |
BodyDataType | string | 消息编码格式:
| JSON |
SourceDTSParameters | object | Source DTS 源。 | |
TaskId | string | 任务 ID。 | f86e5814-b223-482c-b768-3b873297**** |
BrokerUrl | string | 数据订阅通道的网络地址及端口号信息。 | 无 |
Topic | string | 数据订阅通道的订阅 Topic。 | TP_TEST_UNDERWRITE_ISSUE |
Sid | string | 消费组 ID。 | HD1 |
Username | string | 消费组的账号。 | admin |
Password | string | 消费组的账号密码。 | admin**** |
InitCheckPoint | string | 消费位点,即 SDK 客户端消费第一条数据的时间戳,格式为 Unix 时间戳。 | 1620962769 |
SourceSLSParameters | object | Source SLS 源。 | |
Project | string | 日志服务 SLS 的日志项目。 | dmmzk |
LogStore | string | 日志服务 SLS 的日志库。 | waf-logstore |
ConsumerGroup | string | 消费组。 | 无 |
ConsumePosition | string | 起始消费位点,可以选择最早或最新位点,分别对应“begin”,“end”,也可以从指定时间开始消费,以秒为单位。 | begin |
RoleName | string | 授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。 | testRole |
SourcePrometheusParameters | object | Source Prometheus 事件源。 | |
RegionId | string | 地域 id。 | cn-hangzhou |
ClusterId | string | 集群 id。 | c83555068b6******ad213f565f209 |
DataType | string | 数据类型。 | JSON |
Labels | string | 标签。 | __name__=.* |
SourceCustomizedKafkaParameters | object | 自定义 Kafka 事件源。 | |
InstanceId | string | 消息队列 Kafka 版的实例 ID。 | r-8vb64581862c**** |
SourceCustomizedKafkaConnectorParameters | object | 自定义连接器 Apache Kafka 事件源。 | |
ConnectorPackageUrl | string | 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" |
ConnectorParameters | object | 连接器参数。 | |
Name | string | 连接器名称。 | test-name |
Config | object | 连接器配置。 | { "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" } |
WorkerParameters | object | 实例配置。 | { "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" } |
SourceOSSParameters | object | Source OSS 事件源。 | |
RoleName | string | 授权事件总线 EventBridge 读取 OSS 文件的角色名称,要求该角色至少具有 OSS 的只读权限。 | eventbridge_oss_role |
BucketName | string | 对象存储 OSS 中的存储空间名称。 | bucket_abc |
Prefix | string | 文件路径前缀。 | fun/document/ |
LoadMode | string | 数据加载模式,single 表示单文档加载,element 表示分块加载。 取值:single/element 默认为 single。 | single |
LoadFormat | string | 文档加载器。 | TextLoader |
Delimiter | string | 分隔符,在分块加载模式下,以该分隔符作为文本的分块标识符,默认以换行符\n 作为分隔符。 | \n |
FilterPattern | string | 事件过滤规则,如果不指定表示匹配全部事件。 | 无 |
Transforms | array<object> | Transform 相关配置。 | |
Transforms | object | 云产品的 ARN,比如函数计算中函数的 ARN。 | |
Arn | string | 云产品的 ARN,比如函数计算中函数的 ARN。 | acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func |
Sink | object | 事件目标。 | |
SinkMNSParameters | object | 轻量消息队列(原 MNS)事件目标。 | |
QueueName | object | 目标服务类型为轻量消息队列(原 MNS)。 | |
Value | string | 轻量消息队列(原 MNS)的 Queue 的名称。 | MyQueue |
Form | string | 转换的格式。默认为 CONSTANT。 | CONSTANT |
Template | string | 模板样式。 | 无 |
Body | object | 消息内容。 | |
Value | string | 转换前的值。 | { "key": "value" } |
Form | string | 转换的格式。 | TEMPLATE |
Template | string | 模板样式。 | The value of ${key} is ${value}! |
IsBase64Encode | object | 是否开启 Base64 编码。 | |
Value | string | 开启 Base64 编码。 | true |
Form | string | 事件转换的格式。默认为 CONSTANT。 | CONSTANT |
Template | string | 模板样式。 | 无 |
SinkRabbitMQParameters | object | Sink Rabbitmq 的参数。 | |
InstanceId | object | 目标服务类型为消息队列 RabbitMQ 版。 | |
Value | string | 消息队列 RabbitMQ 版的实例 ID。 | e5c9b727-e06c-4d7e-84d5-f8ce644e**** |
Form | string | 转换的格式。默认为 CONSTANT。 | CONSTANT |
Template | string | 模板样式。 | The value of ${key} is ${value}! |
VirtualHostName | object | 消息队列 RabbitMQ 版实例的 Vhost 的名称。 | |
Value | string | 消息队列 RabbitMQ 版实例的 Vhost 的名称。 | rabbit-host |
Form | string | 转换的格式。默认为 CONSTANT。 | CONSTANT |
Template | string | 模板样式。 | 无 |
TargetType | object | 目标类型。 | |
Value | string | 目标类型。取值说明如下:
| Exchange/Queue |
Form | string | 转换的格式。默认为 CONSTANT。 | CONSTANT |
Template | string | 模板样式。 | The value of ${key} is ${value}! |
Exchange | object | Exchange 模式。 仅当参数 TargetType 配置为 Exchange 时,需配置此参数。 | |
Value | string |