ListInstanceConsumerGroups
Função
Essa API é usada para consultar todos os grupos de consumidores.
URI
GET /v2/{project_id}/instances/{instance_id}/groups
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
project_id |
Sim |
String |
ID do projeto. |
instance_id |
Sim |
String |
ID da instância. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
offset |
Não |
String |
Deslocamento, que é a posição onde a consulta começa. O valor deve ser superior ou igual a 0. |
limit |
Não |
String |
Número máximo dos ID de grupo de consumidores retornados na consulta atual. O valor padrão é 10. O valor varia de 1 a 50. |
group |
Não |
String |
Filtrar nomes de grupos de consumidores que contêm palavras-chave específicas. |
Parâmetros de solicitação
Nenhum
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
|---|---|---|
group_ids |
Array of strings |
Todos os ID de grupo de consumidores. |
total |
Integer |
Número total de grupos de consumidores. |
next_offset |
Integer |
Número de sequência do próximo grupo de consumidores. |
previous_offset |
Integer |
Número de seqüência do grupo de consumidores anterior. |
Exemplos de solicitações
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?offest={offest}&limit={limit}&group={group}
Exemplo de respostas
Código de estado: 200
Todos os grupos de consumidores são consultados com êxito.
{ "group_ids" : [ "groupId_1", "groupId_2", "groupId_3" ], "total" : 5, "next_offset" : 4, "previous_offset" : 0 }
Códigos de status
Código de status |
Descrição |
|---|---|
200 |
Todos os grupos de consumidores são consultados com êxito. |
Códigos de erro
Consulte Códigos de erro.
