Queries event streams.
Operation description
You can call this API operation to query event streams.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
NamePrefix | string | No | The name of the event stream that you want to query. | name |
Limit | long | No | The maximum number of entries to be returned in a call. You can use this parameter and NextToken to implement paging. A maximum of 100 entries can be returned in a call. | 10 |
NextToken | string | No | If you configure Limit and excess return values exist, this parameter is returned. | 10 |
SourceArn | string | No | The Alibaba Cloud Resource Name (ARN) of the event source. | acs:alikafka:cn-hangzhou:118609547428****:instance/alikafka_pre-cn-zxu36kvi****/topic/test-topic |
SinkArn | string | No | The ARN of the event target. | acs:fc:cn-hangzhou:118609547428****:services/fw1.LATEST/functions/log1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"Message": "The event streaming [xxxx] not existed!\n",
"RequestId": "283FF852-C4B8-58C9-9777-F88A5A16A79F",
"Data": {
"EventStreamings": [
{
"EventStreamingName": "name",
"Description": "demo",
"Source": {
"SourceMNSParameters": {
"RegionId": "cn-zhangjiakou",
"QueueName": "work4",
"IsBase64Decode": true
},
"SourceRabbitMQParameters": {
"RegionId": "cn-zhangjiakou",
"InstanceId": "dbaudit-cn-7mz2hqolc06",
"VirtualHostName": "eb-connect\n",
"QueueName": "liuyang"
},
"SourceRocketMQParameters": {
"RegionId": "cn-chengdu",
"InstanceId": "i-f8zbher64dlm58plyfte\n",
"Topic": "topic_add_anima",
"Tag": "v1",
"Offset": "CONSUMEFROMTIMESTAMP",
"GroupID": "GID_group1",
"Timestamp": 1670742074043,
"InstanceType": "2",
"InstanceEndpoint": "registry-vpc.cn-hangzhou.aliyuncs.com",
"AuthType": "ACL",
"InstanceUsername": "admin**",
"InstancePassword": "123",
"InstanceVpcId": "vpc-bp1a4gmlk31hy***l3ss",
"InstanceVSwitchIds": "vsw-m5ev8asdc6h123456****\n",
"InstanceSecurityGroupId": "sg-m5edtu24f12345****\n",
"InstanceNetwork": "PublicNetwork"
},
"SourceKafkaParameters": {
"RegionId": "cn-chengdu",
"InstanceId": "bastionhost-cn-i7m2gwt7z1n",
"Topic": "topic_empower_1642473600414\n",
"ConsumerGroup": "GID_TEST",
"OffsetReset": "latest",
"Network": "Default",
"VpcId": "vpc-wz9ki1qdlx3cx5cbbhowf",
"VSwitchIds": "vsw-bp1rmi8rind7eo50cbied",
"SecurityGroupId": "sg-5ud5f3p0rqqis69tpp8eho7cp"
},
"SourceMQTTParameters": {
"RegionId": "cn-qingdao",
"InstanceId": "bastionhost-cn-zvp27kcha1r",
"Topic": "migration_instance"
},
"SourceDTSParameters": {
"TaskId": "1611b337285f44e2936a2c4170bbbb7f",
"BrokerUrl": "",
"Topic": "TP_TEST_UNDERWRITE_ISSUE\n",
"Sid": "HG9",
"Username": "admin",
"Password": "123456",
"InitCheckPoint": "1620962769"
},
"SourceSLSParameters": {
"Project": "dmmzk",
"LogStore": "waf-logstore\n",
"ConsumerGroup": "go-dts-shelf-group",
"ConsumePosition": "begin",
"RoleName": "testRole"
}
},
"FilterPattern": "",
"Transforms": [
{
"Arn": ""
}
],
"Sink": {
"SinkMNSParameters": {
"QueueName": {
"Value": "MyQueue",
"Form": "CONSTANT",
"Template": ""
},
"Body": {
"Value": "{\n \"key\": \"value\"\n}",
"Form": "TEMPLATE",
"Template": "The value of ${key} is ${value}!\n"
},
"IsBase64Encode": {
"Value": "true",
"Form": "CONSTANT",
"Template": ""
}
},
"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"
}
},
"SinkRabbitMQParameters": {
"InstanceId": {
"Value": "si-296cd57939a1421b94ec",
"Form": "CONSTANT",
"Template": ""
},
"VirtualHostName": {
"Value": "rabbit-host\n",
"Form": "CONSTANT",
"Template": ""
},
"TargetType": {
"Value": "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}!\n"
},
"MessageId": {
"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"
}
},
"SinkKafkaParameters": {
"InstanceId": {
"Value": "Defaut_1283278472_sadkj",
"Form": "CONSTANT",
"Template": ""
},
"Topic": {
"Value": "topic",
"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****\n",
"Form": "CONSTANT",
"Template": ""
},
"Topic": {
"Value": "topic",
"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}!\n"
},
"Tags": {
"Value": "{\n \"key\": \"value\"\n}",
"Form": "TEMPLATE",
"Template": "The value of ${key} is ${value}!\n"
}
},
"SinkSLSParameters": {
"Project": {
"Value": "test-project\n",
"Form": "CONSTANT",
"Template": ""
},
"LogStore": {
"Value": "test-logstore\n",
"Form": "CONSTANT",
"Template": ""
},
"Topic": {
"Value": "topic",
"Form": "CONSTANT",
"Template": ""
},
"Body": {
"Value": "{\n \"key\": \"value\"\n}",
"Form": "TEMPLATE",
"Template": "The value of ${key} is ${value}!\n"
},
"RoleName": {
"Value": "test-role",
"Form": "CONSTANT",
"Template": ""
}
},
"SinkFnfParameters": {
"FlowName": {
"Value": "test-streaming-fnf\n",
"Form": "CONSTANT",
"Template": "None\n"
},
"ExecutionName": {
"Value": "123",
"Form": "CONSTANT",
"Template": "None\n"
},
"Input": {
"Value": "123",
"Form": "CONSTANT",
"Template": "None\n"
},
"RoleName": {
"Value": "Al****FNF-x****\n",
"Form": "CONSTANT",
"Template": "None\n"
}
}
},
"RunOptions": {
"MaximumTasks": 2,
"RetryStrategy": {
"PushRetryStrategy": "EXPONENTIALDECAY_RETRY",
"MaximumEventAgeInSeconds": 512,
"MaximumRetryAttempts": 2
},
"ErrorsTolerance": "ALL",
"DeadLetterQueue": {
"Arn": "acs:ram::1597871211794192:role/aliyunsaedefaultrole"
},
"BatchWindow": {
"CountBasedWindow": 100,
"TimeBasedWindow": 10
}
},
"Status": "RUNNING"
}
],
"NextToken": "177",
"Total": 10
},
"Code": "Success",
"Success": true
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
403 | ServiceNotEnable | Service not enable |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-11-22 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||||
| ||||||||||||
2023-10-11 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||||
| ||||||||||||
2023-09-13 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||||
| ||||||||||||
2023-06-09 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||
| ||||||||||||
2023-04-21 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||||
| ||||||||||||
2023-04-10 | The Error code has changed | see changesets | ||||||||||
|