全部产品
Search
文档中心

日志服务:ListConsumerGroup - 查询消费组

更新时间:Nov 06, 2024

查询指定Logstore的所有消费组。

接口说明

  • 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:ListConsumerGroupacs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
log:ListConsumerGroupget
  • LogStore
    acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*
  • log:TLSVersion

请求语法

GET /logstores/{logstore}/consumergroups HTTP/1.1

请求参数

名称类型必填描述示例值
projectstring

Project 名称。

ali-test-project
logstorestring

Logstore 名称。

ali-test-logstore

返回参数

名称类型描述示例值
array

消费组列表。

ConsumerGroup

消费组结构体。

test-consumer-group

示例

正常返回示例

JSON格式

[
  {
    "name": "test-consumer-group",
    "timeout": 300,
    "order": false
  }
]

错误码

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

HttpStatusCodeErrorCodeErrorMessage错误码描述
404ProjectNotExistProject does not exist.Project 不存在。
404LogStoreNotExistLogstore does not exist.Logstore 不存在。
500InternalServerErrorSpecified Server Error Message.内部服务调用错误。

更多信息,请参见通用错误码