本文介绍您在使用开源 Python SDK 接入阿里云 RocketMQ 时,需要配置的参数。

通用参数

参数名 说明
NameServer 设置 TCP 协议接入点,从阿里云 RocketMQ 控制台的实例详情页面获取
GroupID 您在阿里云 RocketMQ 控制台上创建的 Group ID,详情请参见名词解释
AccessKey 您在阿里云账号管理控制台中创建的 AccessKeyId,用于身份认证
SecretKey 您在阿里云账号管理控制台中创建的 AccessKeySecret,用于身份认证
Channel 用户渠道,默认值为 ALIYUN

Producer 类参数

参数名 说明
TransactionStatus 执行本地事务和事务回查的状态,取值说明如下:
  • COMMIT:表示提交事务
  • ROLLBACK:表示回滚事务
  • UNKNOWN:表示事务状态未知

Consumer 类参数

参数名 说明
MessageModel 设置 Consumer 实例的消费模式,取值说明如下:
  • ClUSTERING:表示集群消费
  • BROADCASTING:表示广播消费
ConsumerStatus 业务处理结果返回,取值说明如下:
  • CONSUME_SUCCESS:表示本次消费成功
  • RECONSUME_LATER:表示本次消费失败

特殊参数和接口说明

由于阿里云 RocketMQ 对一些参数使用了优化后的默认值,故有些自定义参数在连接阿里云 RocketMQ 的时候将会关闭,设置这些参数时不会报错,但不会生效。同时某些消息的系统属性没有返回给业务,因此某些特殊的属性被设置成 0 或者一个非法值。具体参数设置、API、以及消息属性的对比,请参见以下表格。

  • Producer
    • 属性设置 阿里云 RocketMQ 是否支持
      set_timeout 支持
      set_compress_level 未开放
      set_max_message_size 未开放
    • SendResult 阿里云 RocketMQ 是否支持
      status 不开放,失败情况通过 error 返回值判断
      msg_id 支持
      offset 不开放,默认为 0
  • Consumer
    属性设置 阿里云 RocketMQ 是否支持
    set_thread_count 支持
    set_message_batch_max_size 不开放
    set_message_model 支持
  • 公共参数
    通用参数设置 阿里云 RocketMQ 是否支持
    group_id 必填项
    set_name_server_address 必填项,参考接入点介绍
    set_namesrv_domain 不开放,请设置接入点
    set_instance_name 支持,仅对Consumer生效
    set_session_credentials 必填项