修改指定消费组属性。
接口说明
- Host 由 Project 名称和日志服务 Endpoint 构成，您需要在 Host 中指定 Project。
- 已创建并获取 AccessKey。更多信息，请参见访问密钥。
阿里云账号 AccessKey 拥有所有 API 的访问权限，风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维。RAM 用户需具备操作日志服务资源的权限。具体操作，请参见创建 RAM 用户及授权。
- 已明确您查询日志所属的 Project 名称、所属地域、Logstore 名称等。如何查询，请参见管理 Project和管理 Logstore。
鉴权资源
下表列出了 API 对应的授权信息。您可以在 RAM 权限策略语句的 Action 元素中添加该信息，用于为 RAM 用户或 RAM 角色授予调用此 API 的权限。
| 动作（Action） | 授权策略中的资源描述方式（Resource） |
|---|---|
log:UpdateConsumerGroup | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup} |
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
PUT /logstores/{logstore}/consumergroups/{consumerGroup}
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| project | string | 是 | Project 名称。 | ali-test-project |
| logstore | string | 是 | Logstore 名称。 | logstore-test |
| consumerGroup | string | 是 | 消费组名称。 | consumer-group-1 |
| body | object | 是 | 请求体参数。 | |
| order | boolean | 否 | 是否按顺序消费。
| true |
| timeout | integer | 否 | 超时时间。在超时时间段内没有收到心跳，消费者将被删除。单位：秒。 | 300 |
返回参数
示例
正常返回示例
JSON格式
{}错误码
访问错误中心查看更多错误码。
| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |
|---|---|---|---|
| 400 | JsonInfoInvalid | timeout is of error value type. | 参数 timeout 类型错误。 |
| 400 | ConsumerGroupNotExist | consumer group not exist. | 消费组不存在。 |
| 404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
| 404 | LogStoreNotExist | Logstore does not exist. | Logstore 不存在。 |
| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |
更多信息，请参见通用错误码。