You need to enable JavaScript to run this app.
导航
ModifyConsumerGroup
最近更新时间:2024.04.19 13:54:15首次发布时间:2023.09.27 12:24:24

调用 ModifyConsumerGroup 接口修改日志服务消费组的配置。

使用说明

本接口用于修改日志服务消费组订阅的日志主题 ID 列表、心跳过期时间等配置,不支持修改消费组名称。调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

请求说明

  • 请求方式:PUT
  • 请求地址:https://tls-{Region}.ivolces.com/ModifyConsumerGroup

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Body

参数类型是否必选示例值描述
ConsumerGroupNameStringmy-consumer-group待修改配置的消费组名称。
HeartbeatTTLInteger60心跳过期时间,单位为秒,取值范围为 1~300。

OrderedConsume

Boolean

false

是否按顺序消费。

  • true:在 Shard 中按顺序消费。Shard 分裂后,先消费完原 Shard 数据,然后并行消费由该 Shard 分裂出的 Shard 数据;Shard 合并后,先消费完原 Shard 数据,然后消费由原 Shard 合并后的新 Shard 数据。
  • false:不按顺序消费。即所有 Shard 同时消费,Shard 分裂或者合并后产生的新 Shard,也会立即消费。
ProjectIDStringc7******消费组所属的日志项目 ID。
TopicIDListArray of String["a1******", "b2******"]消费组待消费的日志主题 ID 列表。

返回参数

本接口无特有的返回参数。更多信息请见返回结构

请求示例

PUT https://tls-{Region}.ivolces.com/ModifyConsumerGroup HTTP/1.1
Content-Type: application/json
{
    "ProjectID": "c7************",
    "ConsumerGroupName": "my-consumer-group",
    "TopicIDList": [
        "a1******"
    ],
    "HeartbeatTTL": 60,
    "OrderedConsume": false
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
400InvalidArgumentInvalid argument key %s, value %s, acceptable value: %s please check argument.参数不合法。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。