All Products
Search
Document Center

Function Compute:SourceRocketMQParameters

Last Updated:Sep 23, 2024
ParameterTypeDescriptionExample
object

The custom parameter configurations when the event source is ApsaraMQ for RocketMQ.

RegionIdstring

The region to which the ApsaraMQ for RocketMQ instance belongs.

cn-hangzhou
InstanceIdstring

The ID of the ApsaraMQ for RocketMQ instance. For more information, see Limits .

MQ_INST_164901546557****_BAAN****
Topicstring

The name of the topic in the ApsaraMQ for RocketMQ instance. For more information, see Limits .

mytopic
Tagstring

The tags that are used to filter messages.

test
Offsetstring

The consumer offset of messages. Valid values:

  • CONSUME_FROM_LAST_OFFSET: Messages are consumed from the latest offset.
  • CONSUME_FROM_FIRST_OFFSET: Messages are consumed from the earliest offset.
  • CONSUME_FROM_TIMESTAMP: Messages are consumed from the offset at the specified point in time.

Default value: CONSUME_FROM_LAST_OFFSET.

CONSUME_FROM_TIMESTAMP
Timestamplong

The timestamp of the offset from which the consumption starts. This parameter is valid only when you set Offset to CONSUME_FROM_TIMESTAMP.

1636597951964
GroupIDstring

The ID of the consumer group on the ApsaraMQ for RocketMQ instance.

GID_group1
InstanceTypestring

The instance type of the ApsaraMQ for RocketMQ instance.

Cloud_5
InstanceEndpointstring

The information about the endpoint of the ApsaraMQ for RocketMQ instance.

registry-vpc.cn-hangzhou.aliyuncs.com
InstanceUsernamestring

The username of the ApsaraMQ for RocketMQ instance. If you use the Internet, you must configure the username and password of the instance in the SDK code for authentication.

6W0xz2uPfiwp****
InstancePasswordstring

The password of the ApsaraMQ for RocketMQ instance.

****
FilterTypestring

The message filter type.

Tag
FilterSqlstring

This parameter is invalid. You do not need to configure the parameter.

AuthTypestring

The authentication type. Set the value to ACL or leave the value empty. The value ACL specifies that authentication is enabled. In this case, you must specify InstanceUsername and InstancePassword.

ACL
InstanceVpcIdstring

The ID of the virtual private cloud (VPC) associated with the instance.

vpc-uf6of9452b2pba82c****
InstanceVSwitchIdsstring

The ID of the vSwitch associated with the instance.

vsw-uf6gwtbn6etadpvz7****
InstanceSecurityGroupIdstring

The ID of the security group.

sg-hp35r2hc3a3sv8q2****
InstanceNetworkstring

The network type.

PrivateNetwork