文档中心

消息队列 RocketMQ版

Group管理

UpdateGroup - 编辑 Group

调用 UpdateGroup 接口，编辑 Group。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Action string 必选示例值：UpdateGroup

要执行的操作，取值：UpdateGroup。

Version string 必选示例值：2023-01-01

API的版本，取值：2023-01-01。

InstanceId string 必选示例值：rocketmq-xxxxxx

实例 ID。

GroupId string 必选示例值：GID-consumer

消费组 ID。

Description string 可选示例值：这是一个待更新的消费组。

消费组的描述。

ConsumeMessageOrderly boolean 必选示例值：true

是否顺序消费。

RetryMaxTimes integer 必选示例值：16

消费失败后消息的最大重试消费次数。

返回参数

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

请求示例

POST /?Action=UpdateGroup&Version=2023-01-01 HTTP/1.1​
Host: rocketmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260313T023526Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260313/cn-beijing/RocketMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "InstanceId": "rocketmq-xxxxxx",​
  "GroupId": "GID-consumer",​
  "Description": "这是一个待更新的消费组。",​
  "ConsumeMessageOrderly": true,​
  "RetryMaxTimes": 16​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20260313103529137035193141E2****",​
    "Action": "UpdateGroup",​
    "Version": "2023-01-01",​
    "Service": "RocketMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {}​
}​

错误码

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

状态码	错误码	错误信息	说明
200	OK	OK	成功。
400	InvalidPara	The specified parameter is not valid.	参数值无效。
400	InvalidParameter	The specified parameter %s is not valid.	参数值%s无效，请检查后重试。
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	请求异常，请检查后重试。
403	OperationDenied.VersionUnsupported	The current instance version does not support this operation.Please upgrade the instance and try again.	当前实例版本不支持指定操作，请升级实例后再试。
404	InvalidGroup.NotFound	The specified group does not exist.	Group 不存在。
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	实例不存在。
500	ServerInternalError	The request failed due to some unknown error, exception or failure.	服务内部错误。
500	InternalError	The request failed due to some unknown error, exception or failure.	内部错误，请稍后再试。
503	ServiceUnavailable	The request failed due to a temporary failure of the server.	当前服务暂时不可用。

最近更新时间：2026.03.13 11:08:48

这个页面对您有帮助吗？

有用

无用