You need to enable JavaScript to run this app.
文档中心
消息队列 Kafka版

消息队列 Kafka版

请输入
  • 文档首页
    • 消息队列 Kafka版API 参考V2（2022-05-01）Group 管理ModifyGroup - 更新消费组
复制全文
下载 pdf
我的收藏
Group 管理
ModifyGroup - 更新消费组
复制全文
下载 pdf
我的收藏
ModifyGroup - 更新消费组
调用 ModifyGroup 修改消费组描述信息。​
使用说明​
创建消费组后，可以调用该接口调整消费组的描述信息。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
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​
The specified parameter is not valid.​
参数值无效。​
404​
InvalidGroupId.NotFound​
The specified consumer group does not exist.​
Group 不存在。​
500​
InternalError​
The request failed due to some unknown error, exception or failure.​
内部错误，请稍后重试。​
​
​
最近更新时间：2025.08.08 17:47:28
这个页面对您有帮助吗？
有用
有用
无用
无用