GetEventStreaming - EventBridge - Alibaba Cloud Documentation Center

Queries the details of an event stream.

Operation description

You can call this API operation to query the details of an event stream.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eventbridge:GetEventStreaming	get	*EventStreaming `acs:eventbridge:{#regionId}:{#accountId}:eventstreaming/{#EventStreamingName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
EventStreamingName	string	Yes	The name of the event stream whose details you want to query.	myeventstreaming

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The error message that is returned if the request failed.	The event streaming [xxxx] not existed!
RequestId	string	The request ID.	7892F480-58C9-5067-AB35-8A7BEF0F726A
Data	object	The returned data.
EventStreamingName	string	The name of the event stream that is returned.	rocketmq-sync
Description	string	The description of the event stream that is returned.	RocketMQ-to-RocketMQ
Source	object	The event provider, which is also known as the event source.
SourceMNSParameters	object	Source MNS Parameters
RegionId	string	The region ID of the MNS queue.	cn-hangzhou
QueueName	string	The name of the MNS queue.	demo
IsBase64Decode	boolean	Indicates whether Base64 encoding is enabled.	true
SourceRabbitMQParameters	object	Source RabbitMQ Parameters
RegionId	string	The region ID of the Message Queue for RabbitMQ instance.	cn-hangzhou
InstanceId	string	The ID of the Message Queue for RabbitMQ instance.	i-f8z9a9mcgwri1c1idd0z
VirtualHostName	string	The vhost name of the Message Queue for RabbitMQ instance.	eb-connect
QueueName	string	The name of the queue in the Message Queue for RabbitMQ instance.	comp
SourceRocketMQParameters	object	The parameters that are returned if ApsaraMQ for RocketMQ is specified as the event source.
RegionId	string	The region ID of the Message Queue for Apache RocketMQ instance.	cn-hangzhou
InstanceId	string	The ID of the Message Queue for Apache RocketMQ instance.	i-f8zbher64dlm58plyfte
Topic	string	The topic to which the message belongs.	topic_add_anima
Tag	string	The tags that are used to filter messages.	v1
Offset	string	The consumer offset of messages. Valid values: CONSUME_FROM_LAST_OFFSET: Start consumption from the latest offset. CONSUME_FROM_FIRST_OFFSET: Start consumption from the earliest offset. CONSUME_FROM_TIMESTAMP: Start consumption from the offset at the specified point in time.	CONSUMEFROMLASTOFFSET
GroupID	string	The ID of the consumer group in the Message Queue for Apache RocketMQ instance.	GID_group1
Timestamp	long	The timestamp of the offset from which consumption starts. This parameter is valid only if you set the Offset parameter to CONSUME_FROM_TIMESTAMP.	1636597951964
SourceKafkaParameters	object	The parameters that are returned if ApsaraMQ for Kafka is specified as the event source.
RegionId	string	The region ID of the Message Queue for Apache Kafka instance.	cn-hangzhou
InstanceId	string	The instance ID.	i-bp1fbtrnqmjvgq66ajdw
Topic	string	The name of the topic.	topic_empower_1642473600414
ConsumerGroup	string	The ID of the consumer group that subscribes to the topic.	GID_TEST
OffsetReset	string	The offset.	latest
Network	string	The network. Default value: Default. The value PublicNetwork specifies a virtual private cloud (VPC).	Default
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-2zehizpoendb3nwwu9w5o
VSwitchIds	string	The vSwitch ID.	vsw-wz9qqeovkwjxlu9uc8rst
SecurityGroupId	string	The security group ID.	sg-2vcgdxz7o1n9zappuimt
ValueDataType	string	The encoding or decoding format. Valid values: Json, Text, and Binary. The value Json indicates that bytes are decoded into UTF-8 strings and then parsed into JSON format. The value Text indicates that bytes are decoded into UTF-8 strings and then put into the payload. The value Binary indicates that bytes are encoded into Base64 strings and put into the payload.	Text
SourceMQTTParameters	object	The parameters that are returned if ApsaraMQ for MQTT is specified as the event source.
RegionId	string	The region ID of the Message Queue for MQTT instance.	cn-shanghai
InstanceId	string	The instance ID.	i-2ze06wqdwk0uq14krrzv
Topic	string	The name of the topic in the Message Queue for MQTT instance.	TOPIC-cainiao-pcs-wms-instock-noPrealertPrintLabel
SourceDTSParameters	object	The parameters that are returned if the event source is Data Transmission Service (DTS).
TaskId	string	The task ID.	f86e5814-b223-482c-b768-3b873297dade
BrokerUrl	string	The URL and port number of the data subscription channel.
Topic	string	The topic to which you want to subscribe by using the data subscription channel.	TP_TEST_UNDERWRITE_ISSUE
Sid	string	The ID of the consumer group.	HD1
Username	string	The account of the consumer group.	admin
Password	string	The password of the consumer group.	admin
InitCheckPoint	string	The consumer offset. A consumer offset is a timestamp that indicates when the SDK client consumes the first data record. The value is a UNIX timestamp.	1620962769
SourceSLSParameters	object	The parameters that are returned if the event provider is Simple Log Service.
Project	string	The Log Service project.	dmmzk
LogStore	string	The Log Service Logstore.	waf-logstore
ConsumerGroup	string	The consumer group.
ConsumePosition	string	The starting consumer offset. The value begin indicates the earliest offset, and the value end indicates the latest offset. You can also specify a time in seconds to start consumption.	begin
RoleName	string	The role name. If you want to authorize EventBridge to use this role to read logs in Log Service, you must select Alibaba Cloud Service for Selected Trusted Entity and EventBridge for Select Trusted Service when you create the role in the RAM console.	testRole
FilterPattern	string	The rule that is used to filter events. If you leave this parameter empty, all events are matched.
Transforms	array<object>
Transforms	object
Arn	string	The Alibaba Cloud Resource Name (ARN) of the cloud service, such as the ARN of a Function Compute function.	acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func
Sink	object	The event target.
SinkMNSParameters	object	The parameters that are returned if the event target is Message Service (MNS).
QueueName	object	The target service type is MNS.
Value	string	The name of the MNS queue.	MyQueue
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Body	object	The message content.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
IsBase64Encode	object	Indicates whether Base64 encoding is enabled.
Value	string	Specifies that Base64 encoding is enabled.	true
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
SinkRabbitMQParameters	object	The parameters that are returned if the event target is Message Queue for RabbitMQ.
InstanceId	object	The target service type is Message Queue for RabbitMQ instance.
Value	string	The ID of the Message Queue for RabbitMQ instance.	e5c9b727-e06c-4d7e-84d5-f8ce644e00bf
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
VirtualHostName	object	The name of the vhost of the Message Queue for RabbitMQ instance.
Value	string	The vhost name of the Message Queue for RabbitMQ instance.	rabbit-host
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
TargetType	object	The target type.
Value	string	The type of the resource to which the event is delivered. Valid values: Exchange: exchanges. Queue: queues.	Exchange/Queue
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Exchange	object	The exchange mode. This parameter is available only if TargetType is set to Exchange.
Value	string	The name of the exchange in the Message Queue for RabbitMQ instance.	a_exchange
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
RoutingKey	object	The routing rule for the message. This parameter is available only if TargetType is set to Exchange.
Value	string	The routing rule for the message.	housekeeping
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
QueueName	object	The queue mode. This parameter is available only if TargetType is set to Queue.
Value	string	The name of the queue in the Message Queue for RabbitMQ instance.	MyQueue
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Body	object	The message content.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
MessageId	object	The message ID.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
Properties	object	The tags that are used to filter messages.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
SinkFcParameters	object	The parameters that are returned if the event target is Function Compute.
ServiceName	object	The service name.
Value	string	The name of the service.	myService
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
FunctionName	object	The function name.
Value	string	The function name.	mFunction
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Concurrency	object	The delivery concurrency. Minimum value: 1.
Value	string	The delivery concurrency. Minimum value: 1.	1
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	None
Qualifier	object	The alias of the service to which the function belongs.
Value	string	The alias of the service to which the function belongs.	LATEST
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
InvocationType	object	The invocation type. Valid values: Sync: synchronous Async: asynchronous
Value	string	The invocation type.	Async
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Body	object	The message body that is sent to the function.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
SinkKafkaParameters	object	The parameters that are returned if the event target is Message Queue for Apache Kafka.
InstanceId	object	The target service type is Message Queue for Apache Kafka.
Value	string	The instance ID.	Defaut_1283278472_sadkj
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Topic	object	The topic name.
Value	string	The topic name.	topic-test
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Acks	object	The acknowledgment information.
Value	string	The acknowledgment information.	1
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Key	object	The message key.
Value	string	The message key.	key
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Value	object	The message content.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
SinkRocketMQParameters	object	The parameters that are returned if ApsaraMQ for RocketMQ is specified as the event target.
InstanceId	object	The target service type is Message Queue for Apache RocketMQ.
Value	string	The ID of the Message Queue for Apache RocketMQ instance.	MQ_INST_164901546557**_BAAN**
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Topic	object	The name of the topic in the Message Queue for Apache RocketMQ instance.
Value	string	The name of the topic in the Message Queue for Apache RocketMQ instance.	Mytopic
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Body	object	The message content.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
Properties	object	The tags that are used to filter messages.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
Keys	object	The tags that are used to filter messages.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
Tags	object	The tags that are used to filter messages.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
SinkSLSParameters	object	The parameters that are returned if Simple Log Service is specified as the event target.
Project	object	The Simple Log Service project.
Value	string	The Log Service project.	test-project
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
LogStore	object	The Simple Log Service Logstore.
Value	string	The Log Service Logstore.	test-logstore
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Topic	object	The name of the topic in which logs are stored. The topic corresponds to the topic reserved field in Simple Log Service.
Value	string	The name of the topic in which logs are stored. The topic corresponds to the topic reserved field in Log Service.	testTopic
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Body	object	The message content.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The method that is used to transform the event.	TEMPLATE
Template	string	The template based on which the event is transformed.	The value of ${key} is ${value}!
RoleName	object	The role name. If you want to authorize EventBridge to use this role to read logs in Simple Log Service, you must select Alibaba Cloud Service for Selected Trusted Entity and EventBridge for Select Trusted Service when you create the role in the Resource Access Management (RAM) console.
Value	string	The role name. If you want to authorize EventBridge to use this role to read logs in Log Service, you must select Alibaba Cloud Service for Selected Trusted Entity and EventBridge for Select Trusted Service when you create the role in the RAM console.	testRole
Form	string	The method that is used to transform the event. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
SinkFnfParameters	object	The Sink Fnf parameters.
FlowName	object	The flow name.
Value	string	The flow name.	test-streaming-fnf
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	None
ExecutionName	object	The execution name.
Value	string	The execution name.	123
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	None
Input	object	The execution input information.
Value	string	The execution input information.	123
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	None
RoleName	object	The role name.
Value	string	The role configuration.	Al**FNF-x**
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	None
RunOptions	object	The runtime environment-related configurations.
MaximumTasks	integer	The concurrency level.	2
RetryStrategy	object	The information about the retry policy that is used if the event fails to be pushed.
PushRetryStrategy	string	The retry policy. Valid values: BACKOFFRETRY and EXPONENTIALDECAY_RETRY.	BACKOFFRETRY
MaximumEventAgeInSeconds	float	The maximum period of time during which retries are performed.	512
MaximumRetryAttempts	float	The maximum number of retries.	2
ErrorsTolerance	string	The fault tolerance policy. The value NONE specifies that faults are not tolerated, and the value All specifies that all faults are tolerated.	ALL
DeadLetterQueue	object	Indicates whether dead-letter queues are enabled. By default, dead-letter queues are disabled. Messages that fail to be pushed after allowed retries as specified by the retry policy are discarded.
Arn	string	The Alibaba Cloud Resource Name (ARN) of the dead-letter queue.	acs:ram::1550203943326350:role/edskmstoecs
BatchWindow	object	The batch window.
CountBasedWindow	integer	The maximum number of events that are allowed in the batch window. If this threshold is reached, data in the window is pushed downstream. When multiple batch windows exist, data is pushed if triggering conditions are met in one of the windows.	100
TimeBasedWindow	integer	The maximum period of time during which events are allowed in the batch window. Unit: seconds. If this threshold is reached, data in the window is pushed downstream. When multiple batch windows exist, data is pushed if triggering conditions are met in one of the windows.	10
Status	string	The status of the event stream that is returned.	RUNNING
Code	string	The response code. The value Success indicates that the request is successful. Other values indicate that the request failed. For a list of error codes, see Error codes.	Success
Success	boolean	Indicates whether the operation is successful. The value true indicates that the operation is successful.	true

Examples

Sample success responses

JSONformat

{
  "Message": "The event streaming [xxxx] not existed!",
  "RequestId": "7892F480-58C9-5067-AB35-8A7BEF0F726A",
  "Data": {
    "EventStreamingName": "rocketmq-sync",
    "Description": "RocketMQ-to-RocketMQ",
    "Source": {
      "SourceMNSParameters": {
        "RegionId": "cn-hangzhou",
        "QueueName": "demo",
        "IsBase64Decode": true
      },
      "SourceRabbitMQParameters": {
        "RegionId": "cn-hangzhou",
        "InstanceId": "i-f8z9a9mcgwri1c1idd0z",
        "VirtualHostName": "eb-connect",
        "QueueName": "comp"
      },
      "SourceRocketMQParameters": {
        "RegionId": "cn-hangzhou",
        "InstanceId": "i-f8zbher64dlm58plyfte",
        "Topic": "topic_add_anima",
        "Tag": "v1",
        "Offset": "CONSUMEFROMLASTOFFSET",
        "GroupID": "GID_group1",
        "Timestamp": 1636597951964,
        "InstanceType": "2",
        "InstanceEndpoint": "reg****-vpc.cn-zhangjiakou.aliyuncs.com\n",
        "AuthType": "ACL",
        "InstanceUsername": "xxxa",
        "InstancePassword": "xxxa",
        "InstanceVpcId": "vpc-m5e3sv4b12345****\n",
        "InstanceVSwitchIds": "vsw-m5ev8asdc6h12****\n",
        "InstanceSecurityGroupId": "sg-m5edtu24f12345****\n",
        "InstanceNetwork": "PublicNetwork",
        "BodyDataType": "",
        "FilterType": "",
        "FilterSql": "",
        "VpcId": "",
        "VSwitchIds": "",
        "SecurityGroupId": "",
        "Network": ""
      },
      "SourceKafkaParameters": {
        "RegionId": "cn-hangzhou",
        "InstanceId": "i-bp1fbtrnqmjvgq66ajdw",
        "Topic": "topic_empower_1642473600414",
        "ConsumerGroup": "GID_TEST",
        "OffsetReset": "latest",
        "Network": "Default",
        "VpcId": "vpc-2zehizpoendb3nwwu9w5o",
        "VSwitchIds": "vsw-wz9qqeovkwjxlu9uc8rst",
        "SecurityGroupId": "sg-2vcgdxz7o1n9zappuimt",
        "ValueDataType": "Text"
      },
      "SourceMQTTParameters": {
        "RegionId": "cn-shanghai",
        "InstanceId": "i-2ze06wqdwk0uq14krrzv",
        "Topic": "TOPIC-cainiao-pcs-wms-instock-noPrealertPrintLabel",
        "BodyDataType": ""
      },
      "SourceDTSParameters": {
        "TaskId": "f86e5814-b223-482c-b768-3b873297dade",
        "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"
      },
      "SourcePrometheusParameters": {
        "RegionId": "",
        "ClusterId": "c83555068b6******ad213f565f209\n",
        "DataType": "json",
        "Labels": "__name__=.*\n"
      },
      "SourceCustomizedKafkaParameters": {
        "InstanceId": ""
      },
      "SourceCustomizedKafkaConnectorParameters": {
        "ConnectorPackageUrl": "",
        "ConnectorParameters": {
          "Name": "",
          "Config": {
            "test": "test",
            "test2": 1
          }
        },
        "WorkerParameters": {
          "test": "test",
          "test2": 1
        }
      },
      "SourceApacheKafkaParameters": {
        "Bootstraps": "",
        "Topic": "",
        "ConsumerGroup": "",
        "OffsetReset": "",
        "ValueDataType": "",
        "VpcId": "",
        "VSwitchIds": "",
        "SecurityGroupId": "",
        "NetworkType": "",
        "SecurityProtocol": "",
        "SaslMechanism": "",
        "SaslUser": "",
        "SaslPassword": ""
      }
    },
    "FilterPattern": "",
    "Transforms": [
      {
        "Arn": "acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func\n"
      }
    ],
    "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-f8ce644e00bf",
          "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": "None\n"
        },
        "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_sadkj",
          "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}!"
        },
        "InstanceType": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "InstanceEndpoint": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "InstanceUsername": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "InstancePassword": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "VpcId": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "VSwitchIds": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "SecurityGroupId": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "Network": {
          "Value": "",
          "Form": "",
          "Template": ""
        }
      },
      "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": ""
        },
        "ContentType": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "ContentSchema": {
          "Value": "",
          "Form": "",
          "Template": ""
        }
      },
      "SinkFnfParameters": {
        "FlowName": {
          "Value": "test-streaming-fnf",
          "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****",
          "Form": "CONSTANT",
          "Template": "None\n"
        }
      },
      "SinkDataHubParameters": {
        "Project": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "Topic": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "TopicType": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "TopicSchema": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "Body": {
          "Value": "",
          "Form": "",
          "Template": ""
        },
        "RoleName": {
          "Value": "",
          "Form": "",
          "Template": ""
        }
      },
      "SinkCustomizedKafkaParameters": {
        "InstanceId": ""
      },
      "SinkCustomizedKafkaConnectorParameters": {
        "ConnectorPackageUrl": "",
        "ConnectorParameters": {
          "Name": "",
          "Config": {
            "test": "test",
            "test2": 1
          }
        },
        "WorkerParameters": {
          "test": "test",
          "test2": 1
        }
      },
      "SinkDashVectorParameters": {
        "InstanceId": "",
        "Collection": "",
        "ApiKey": "",
        "Operation": "",
        "Network": "",
        "PrimaryKeyId": {
          "Form": "",
          "Value": "",
          "Template": ""
        },
        "Partition": {
          "Form": "",
          "Value": "",
          "Template": ""
        },
        "Vector": {
          "Form": "",
          "Value": "",
          "Template": ""
        },
        "DashVectorSchemaParameters": {
          "Form": "",
          "Value": "",
          "Template": ""
        }
      }
    },
    "RunOptions": {
      "MaximumTasks": 2,
      "RetryStrategy": {
        "PushRetryStrategy": "BACKOFFRETRY",
        "MaximumEventAgeInSeconds": 512,
        "MaximumRetryAttempts": 2
      },
      "ErrorsTolerance": "ALL",
      "DeadLetterQueue": {
        "Arn": "acs:ram::1550203943326350:role/edskmstoecs"
      },
      "BatchWindow": {
        "CountBasedWindow": 100,
        "TimeBasedWindow": 10
      },
      "LogDelivery": {
        "SLSLogParameters": [
          {
            "ProjectName": "",
            "LogstoreName": ""
          }
        ],
        "KafkaLogParameters": [
          {
            "Endpoint": "",
            "InstanceId": "",
            "Topic": ""
          }
        ]
      },
      "ScaledObject": {
        "MinReplicaCount": 0,
        "MaxReplicaCount": 0,
        "Triggers": [
          {
            "Type": "",
            "Metadata": {
              "Type": "",
              "Value": 0
            }
          }
        ]
      },
      "RoleName": "",
      "Network": {
        "VpcId": "",
        "VSwitchIds": [
          ""
        ],
        "SecurityGroupId": ""
      },
      "ResourceSpec": {
        "Resources": [
          {
            "Type": "",
            "Value": 0
          }
        ]
      }
    },
    "Status": "RUNNING",
    "DetailedStatus": {
      "TPS": 0,
      "DelayTime": 0,
      "DiffOffset": 0,
      "Extensions": {
        "test": "test",
        "test2": 1
      }
    }
  },
  "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
2024-09-10	The Error code has changed. The response structure of the API has changed	View Change Details
2024-08-19	The Error code has changed. The response structure of the API has changed	View Change Details
2024-07-12	The Error code has changed. The response structure of the API has changed	View Change Details
2024-05-31	The Error code has changed. The response structure of the API has changed	View Change Details
2024-04-09	The Error code has changed. The response structure of the API has changed	View Change Details
2024-02-21	The Error code has changed. The response structure of the API has changed	View Change Details
2023-12-28	The Error code has changed. The response structure of the API has changed	View Change Details
2023-11-22	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-11	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-13	The Error code has changed. The response structure of the API has changed	View Change Details
2023-04-21	The Error code has changed. The response structure of the API has changed	View Change Details
2023-04-06	The Error code has changed	View Change Details