You need to enable JavaScript to run this app.
导航

ModifyConsumerGroup

最近更新时间2023.11.13 16:31:41

首次发布时间2023.09.27 12:24:24

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

使用说明

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

URI

请求方法
PUT

URI

https://tls-{Region}.ivolces.com/ModifyConsumerGroup

传输协议

HTTPS

请求参数

参数
参数类型
是否必选
示例值
说明

ProjectID

String

c7******

消费组所属的日志项目 ID。

ConsumerGroupName

String

my-consumer-group

待修改配置的消费组名称。

TopicIDList

Array of String

["a1******", "b2******"]

消费组待消费的日志主题 ID 列表。

HeartbeatTTL

Integer

60

心跳过期时间,单位为秒,取值范围为 1~300。

OrderedConsume

Boolean

false

是否按顺序消费。

  • true:在 Shard 中按顺序消费。Shard 分裂后,先消费完原 Shard 数据,然后并行消费由该 Shard 分裂出的 Shard 数据;Shard 合并后,先消费完原 Shard 数据,然后消费由原 Shard 合并后的新 Shard 数据。
  • false:不按顺序消费。即所有 Shard 同时消费,Shard 分裂或者合并后产生的新 Shard,也会立即消费。

响应参数


示例

请求示例

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 
...
{}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

InvalidArgument

400

Invalid argument key %s, value %s, acceptable value: %s please check argument.

参数不合法。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。