调用 ModifyGroup 修改消费组描述信息。
创建消费组后,可以调用该接口调整消费组的描述信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyGroup | 要执行的操作,取值:ModifyGroup。 |
Version | String | 是 | 2022-05-01 | API的版本,取值:2022-05-01。 |
InstanceId | String | 是 | kafka-cnngbnntswg1**** | 实例 ID。 |
GroupId | String | 是 | my_group | 待修改描述的消费组 ID。 |
Description | String | 是 | 修改测试 | 修改消费组的描述,长度不超过 128 个字符。 |
本接口无特有的返回参数。更多信息请见返回结构。
POST /?Action=ModifyGroup&Version=2022-05-01 HTTP/1.1 Content-Type: application/json Host: kafka.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=******** { "InstanceId": "kafka-cnngbnntswg1****", "GroupId": "my_group", "Description": "修改测试" }
{ "ResponseMetadata": { "RequestId": "2023022719194098F0DF73611FD95FA1A2", "Action": "ModifyGroup", "Version": "2022-05-01", "Service": "Kafka", "Region": "cn-beijing" }, "Result": null }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | InvalidParameter | 参数值无效。 |
404 | InvalidGroupId.NotFound | Group 不存在。 |
500 | InternalError | 内部错误,请稍后重试。 |