Obtém uma lista de grupos de consumidores.
Experimente agora
Testar
Autorização RAM
Sintaxe da solicitação
POST HTTP/1.1Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| GwClusterId |
string |
Sim |
O ID da instância de gateway. |
pg-xxxxxxx |
| ConsumerGroupId |
string |
Não |
O ID do grupo de consumidores. |
cg-xxxxxxxx |
| PageSize |
integer |
Não |
O número de registros a serem retornados por página. Valores válidos:
Valor padrão: 30. |
30 |
| PageNumber |
integer |
Não |
O número da página a ser retornada. Valor padrão: 1. |
1 |
| RegionId |
string |
Não |
O ID da região. |
cn-beijing |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
O objeto de resposta. |
||
| RequestId |
string |
O ID da solicitação. |
24A1990B-4F6E-482B-B8CB-75C612****** |
| TotalRecordCount |
integer |
O número total de registros. |
1 |
| PageRecordCount |
integer |
O número de registros na página atual. |
30 |
| PageNumber |
integer |
O número da página. |
1 |
| PageSize |
integer |
O número de registros retornados por página. Valores válidos: 30, 50 e 100. Valor padrão: 30. |
30 |
| Items |
array<object> |
Uma lista de grupos de consumidores. |
|
|
object |
Um objeto de grupo de consumidores. |
||
| IsDefault |
string |
Indica se o grupo de consumidores é o grupo padrão. Valores válidos:
|
0 |
| ConsumerGroupId |
string |
O ID do grupo de consumidores. |
cg-xxxxxxxx |
| ConsumerGroupName |
string |
O nome do grupo de consumidores. |
test |
| NickName |
string |
O apelido do grupo de consumidores. |
test |
| GmtCreated |
string |
A hora de criação. |
2026-01-28T09:56:03+08:00 |
| GmtModified |
string |
A hora de atualização. |
2026-01-04T16:09:29+08:00 |
| AllowedModels |
string |
A lista de modelos suportados. |
"[]" |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
"TotalRecordCount": 1,
"PageRecordCount": 30,
"PageNumber": 1,
"PageSize": 30,
"Items": [
{
"IsDefault": "0",
"ConsumerGroupId": "cg-xxxxxxxx",
"ConsumerGroupName": "test",
"NickName": "test",
"GmtCreated": "2026-01-28T09:56:03+08:00",
"GmtModified": "2026-01-04T16:09:29+08:00",
"AllowedModels": "\"[]\""
}
]
}Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.