On this page

Show all

Help Center/ EventGrid/ API Reference/ APIs/ Event Stream Management/ Obtaining Event Stream Details

Obtaining Event Stream Details

Updated on 2025-05-06 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to obtain the details of an event stream.

URI

GET /v1/{project_id}/eventstreamings/{eventstreaming_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.
eventstreaming_id	Yes	String	Event stream ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-Request-Id	String	This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

**Table 4** Response body parameters
Parameter	Type	Description
name	String	Event stream name. The value must be unique under a tenant. Only letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. It must start with a letter or digit.
description	String	Description of the event stream.
source	EventStreamingSource object	Event source. An event stream has only one source.
sink	EventStreamingSink object	Event target. An event stream has only one event target. Either sink_fg or sink_kafka can be selected.
rule_config	rule_config object	Event rules, including filter and transform rules.
option	RunOption object	Running configuration.
status	String	Event stream status.
id	String	Event stream ID.
created_time	String	Creation time.
updated_time	String	Update time.

**Table 5** EventStreamingSource
Parameter	Type	Description
source_kafka	SourceKafkaMQParameters object	Event source parameters.
source_mobile_rocketmq	SourceMobileMQParameters object	ECloud RocketMQ event source parameters
source_community_rocketmq	SourceCommunityMQParameters object	Open-Source RocketMQ event source parameters.
source_dms_rocketmq	SourceDMSMQParameters object	DMS event source parameters.
name	String	Event source type name.

**Table 6** SourceKafkaMQParameters
Parameter	Type	Description
addr	String	Kafka connection address.
group	String	Kafka consumer group.
instance_name	String	Kafka instance name.
security_protocol	String	Security protocol.
instance_id	String	Kafka instance ID.
topic	String	Kafka topic name.
seek_to	String	Consumption offset.
enable_sasl_ssl	Boolean	Whether to enable SASL_SSL.
sasl_mechanism	String	SASL authentication mechanism.
ssl_certificate_url	String	SASL certificate URL, which is a URL in OBS.
ssl_certificate_pwd	String	SASL certificate password.
user_name	String	Username.
password	String	Password.

**Table 7** SourceMobileMQParameters
Parameter	Type	Description
group_id	String	Consumer group ID.
instance_id	String	Instance ID.
topic	String	topic
tag	String	Tag.
authentication_required	Boolean	Indicates whether authentication is required.
msg_trace_switch	Boolean	Whether message tracing is required.
access_key	String	AccessKey
secret_key	String	SecretKey
message_model	String	Subscription mode.
addr_type	String	Access type.
addr	String	Address.
sdk_url	String	Client SDK.
consume_timeout	Integer	Consumption timeout.
message_type	String	Message type.
suspend_time	Integer	Retry waiting time.
max_reconsumer_times	Integer	Maximum retries.
consumer_thread_nums	Integer	Consumption threads.
consumer_batch_max_size	Integer	Maximum number of messages that can be consumed in a batch.
consumer_max_wait	Integer	Maximum waiting duration for batch consumption, in seconds.
vpc_id	String	VPC ID.
subnet_id	String	Subnet ID.

**Table 8** SourceCommunityMQParameters
Parameter	Type	Description
instance_name	String	Instance name. This parameter is required only for DMS for RocketMQ.
instance_id	String	Instance ID. This parameter is required only for DMS for RocketMQ.
addr	String	RocketMQ connection address.
group	String	Consumer group.
topic	String	Topic name.
tag	String	Tag.
vpc_id	String	VPC ID.
subnet_id	String	Subnet ID.
ssl_enable	Boolean	Whether to enable SSL.
enable_acl	Boolean	Indicates whether to enable ACL.
access_key	String	Username.
secret_key	String	Secret key.
message_type	String	Message type.
consume_timeout	Integer	Consumption timeout.
consumer_thread_nums	Integer	Number of consumption threads.
consumer_batch_max_size	Integer	Maximum number of messages that can be consumed in a batch.
max_reconsume_times	Integer	Maximum number of retries. The value -1 indicates that the retry is performed continuously.
suspend_current_queue_time_millis	Integer	Retry interval, in milliseconds.

**Table 9** SourceDMSMQParameters
Parameter	Type	Description
instance_name	String	Instance name. This parameter is required only for DMS for RocketMQ.
instance_id	String	Instance ID. This parameter is required only for DMS for RocketMQ.
group	String	Consumer group.
topic	String	Topic name.
tag	String	Tag.
ssl_enable	Boolean	Whether to enable SSL.
enable_acl	Boolean	Indicates whether to enable ACL.
access_key	String	Username.
secret_key	String	Secret key.
message_type	String	Consumption mode. The consumption mode varies according to the message production sequence. 1. Orderly production with orderly consumption: Messages are sent in order and consumed in the same order within a group. 2. Orderly production with concurrent consumption: Messages are sent in order and consumed concurrently, as close to order as possible. 3. Disorderly production with orderly consumption: Messages are sent out of order and consumed in queue order, not necessarily matching the send order. 4. Disorderly production with concurrent consumption: Messages are sent out of order and consumed concurrently, as close to order as possible.
engine_version	String	RocketMQ instance version.
consume_timeout	Integer	Consumption timeout.
consumer_thread_nums	Integer	Number of consumption threads.
consumer_batch_max_size	Integer	Maximum number of messages that can be consumed in a batch.
max_reconsume_times	Integer	Maximum number of retries. The value -1 indicates that the retry is performed continuously.
suspend_current_queue_time_millis	Integer	Retry interval, in milliseconds.

**Table 10** EventStreamingSink
Parameter	Type	Description
sink_fg	SinkFGParameters object	FunctionGraph event target parameters.
sink_kafka	SinkKafkaParameters object	Kafka event target parameters.
sink_obs	SinkObsParameters object	OBS event target parameters.
name	String	Event target name.

**Table 11** SinkFGParameters
Parameter	Type	Description
invoke_type	String	Function invocation mode, which can be asynchronous or synchronous.
urn	String	Function URN.
agency	String	Tenant agency.

**Table 12** SinkKafkaParameters
Parameter	Type	Description
topic	String	Topic name.
keyTransform	Array of TransForm objects	Key transform rule.
connectionId	String	Connection ID.

**Table 13** TransForm
Parameter	Type	Description
type	String	Type of the transform rule.
value	String	For a constant type rule, the field is the constant content definition. For a variable type rule, the field is a variable definition and the content must be a JSON object string. A maximum of 100 variables are supported, and nested structures are not supported. The variable name can contain a maximum of 64 characters. Only letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. It must start with a letter or digit and cannot start with HC.. The variable value expression can be a constant or JSONPath expression. The string length cannot exceed 1024 characters.
template	String	Template definition of the rule content when the rule is of the variable type. Defined variables can be referenced.

**Table 14** SinkObsParameters
Parameter	Type	Description
access_key	String	AK
secret_key	String	SK
obs_bucket	String	Bucket.
obs_path	String	Dump directory.
time_format	String	Time directory format.

**Table 15** rule_config
Parameter	Type	Description
transform	TransForm object	Transform rule of the event subscription target.
filter	Object	Filter rule.

**Table 16** RunOption
Parameter	Type	Description
thread_num	Integer	Concurrency.
batch_window	BatchWindow object	Batch push.

**Table 17** BatchWindow
Parameter	Type	Description
count	Integer	Number of messages to push in a batch. Range: 1–10,000.
time	Integer	Number of retries.
interval	Integer	Batch push interval. Range: 0s to 15s.

Example Requests

Obtain event stream details.

GET https://{eg_endpoint}/v1/{project_id}/eventstreamings/{eventstreaming_id}

Example Responses

Status code: 200

Details of an event stream.

{
  "name" : "test-eventstreaming",
  "description" : "this is a test eventstreaming",
  "source" : { },
  "sink" : { },
  "rule_config" : {
    "transform" : { },
    "filter" : { }
  },
  "option" : { },
  "status" : "running",
  "id" : "string",
  "created_time" : "string",
  "updated_time" : "string"
}