Consulta de todos los grupos de consumidores
Función
Esta API se utiliza para consultar todos los grupos de consumidores.
URI
GET /v2/{project_id}/instances/{instance_id}/groups
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. |
|
instance_id |
Sí |
String |
ID de instancia. |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
offset |
No |
String |
Desplazamiento, que es la posición en la que comienza la consulta. El valor debe ser superior o igual a 0. |
|
limit |
No |
String |
Número máximo de ID de grupo de consumidores devueltos en la consulta actual. El valor predeterminado es 10. El valor oscila entre 1 y 50. |
|
group |
No |
String |
Filtrar nombres de grupos de consumidores que contienen palabras clave específicas. |
Parámetros de solicitud
Ninguno
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
group_ids |
Matriz de strings |
Todos los ID de grupo de consumidores. |
|
total |
Integer |
Número total de grupos de consumidores. |
|
next_offset |
Integer |
Número de secuencia del siguiente grupo de consumidores. |
|
previous_offset |
Integer |
Número de secuencia del grupo de consumidores anterior. |
Solicitudes de ejemplo
GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?offest={offest}&limit={limit}&group={group}
Respuestas de ejemplo
Código de estado: 200
Todos los grupos de consumidores se consultan correctamente.
{
"group_ids" : [ "groupId_1", "groupId_2", "groupId_3" ],
"total" : 5,
"next_offset" : 4,
"previous_offset" : 0
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
Todos los grupos de consumidores se consultan correctamente. |
Códigos de error
Consulte Códigos de error.
