全部产品
Search

搜索本产品

    日志服务：UpdateConsumerGroup - 更新消费者组

    文档中心

    日志服务：UpdateConsumerGroup - 更新消费者组

    更新时间：Aug 27, 2026

    修改指定消费组属性。

    接口说明

    接口说明

    • 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:UpdateConsumerGroupacs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    log:UpdateConsumerGroup

    update

    *LogStore

    acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}
    • log:TLSVersion
    		 无

    请求语法

    PUT /logstores/{logstore}/consumergroups/{consumerGroup} HTTP/1.1

    路径参数

    名称

    类型

    必填

    描述

    示例值
    logstore

    string

    是

    Logstore 名称。

    logstore-test
    consumerGroup

    string

    是

    消费组名称。

    consumer-group-1

    请求参数

    名称

    类型

    必填

    描述

    示例值
    project

    string

    是

    Project 名称。

    ali-test-project
    body

    object

    是

    请求体参数。order 和 timeout 至少一个有值。

    order

    boolean

    否

    是否按顺序消费。

    • true：在 Shard 中按顺序消费。Shard 分裂后，先消费原 Shard 数据，然后同时消费由该 Shard 分裂的 Shard 数据。Shard 合并后，先消费原 Shard 数据，然后消费由原 Shard 合并后的新 Shard 数据。

    • false：不按顺序消费。即所有同时开始消费，Shard 分裂或者合并后产生的新 Shard，也会立即消费。

    true
    timeout

    integer

    否

    超时时间。在超时时间段内没有收到心跳，消费者将被删除。单位：秒。

    300

    返回参数

    名称

    类型

    描述

    示例值

    当前API暂无返回参数

    示例

    正常返回示例

    JSON格式

    {}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。