GetConsumerGroup - 查询消费者组-API 网关(API Gateway)-阿里云帮助中心

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /v1/consumer-groups/{consumerGroupId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
consumerGroupId	string	否	消费者组 ID。	csg-8c13d2b4f8a1

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
code	string	响应状态码。请求成功时返回 Ok。	Ok
message	string	响应消息。	success
data	object	响应数据。
consumerGroupId	string	消费者组 ID。	csg-8c13d2b4f8a1
name	string	消费者组名称。	api-consumer-group
description	string	消费者组描述。	用于线上 API 调用方分组
gatewayType	string	网关类型，取值为 API 或 AI。枚举值： AI : AI API : API	API
consumerCount	integer	消费者组内的消费者数量。	3
createTimestamp	integer	消费者组创建时间，Unix 毫秒时间戳。	1715769600000
updateTimestamp	integer	消费者组更新时间，Unix 毫秒时间戳。	1715769600000

示例

正常返回示例

JSON格式

{
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "code": "Ok",
  "message": "success",
  "data": {
    "consumerGroupId": "csg-8c13d2b4f8a1",
    "name": "api-consumer-group",
    "description": "用于线上 API 调用方分组",
    "gatewayType": "API",
    "consumerCount": 3,
    "createTimestamp": 1715769600000,
    "updateTimestamp": 1715769600000
  }
}

错误码

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

变更历史

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