调用ListConsumerGroup接口查询指定Logstore的所有消费组。
接口说明
- Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
-
已创建并获取AccessKey。更多信息,请参见访问密钥。
阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权。
- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询,请参见管理Project和管理Logstore。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /logstores/{logstore}/consumergroups HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
project | String | Host | 是 | ali-test-project | Project名称。 |
logstore | String | Path | 是 | ali-test-logstore | Logstore名称。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Array of ConsumerGroup | 消费组列表。 |
示例
请求示例
GET /logstores/logstoreName/consumergroups HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
公共请求参数
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
[ {
"name" : "test-consumer-group",
"timeout" : 30,
"order" : false
} ]
错误码
访问错误中心查看更多错误码。
HttpStatusCode |
ErrorCode |
ErrorMessage |
错误码描述 |
---|---|---|---|
404 |
ProjectNotExist |
Project does not exist. |
Project不存在。 |
404 |
LogStoreNotExist |
Logstore does not exist. |
Logstore不存在。 |
500 |
InternalServerError |
Specified Server Error Message. |
内部服务调用错误。 |
更多信息,请参见通用错误码。