调用 ModifyConsumerGroup 接口修改日志服务消费组的配置。
本接口用于修改日志服务消费组订阅的日志主题 ID 列表、心跳过期时间等配置,不支持修改消费组名称。调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ConsumerGroupName | String | 是 | my-consumer-group | 待修改配置的消费组名称。 |
HeartbeatTTL | Integer | 否 | 60 | 心跳过期时间,单位为秒,取值范围为 1~300。 |
OrderedConsume | Boolean | 否 |
| 是否按顺序消费。
|
ProjectID | String | 是 | c7****** | 消费组所属的日志项目 ID。 |
TopicIDList | Array 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 状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidArgument | Invalid argument key %s, value %s, please check argument. | 参数不合法。 |
400 | InvalidArgument | Invalid argument key %s, value %s, acceptable value: %s please check argument. | 参数不合法。 |
500 | InternalServerError | We encountered an unexpected server error, please try again later. | 服务器内部错误。 |