Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/Distributed Message Service for Kafka/Referencia de la API/APIs V2 (Recomendado)/Gestión de instancias/Consulta de los detalles del grupo de consumidores
Actualización más reciente 2022-11-07 GMT+08:00
Ver PDF
Compartir

Consulta de los detalles del grupo de consumidores

Función

Esta API se utiliza para consultar los detalles del grupo de consumidores.

URI

GET /v2/{project_id}/instances/{instance_id}/management/groups/{group}

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto.

instance_id

Sí

String

ID de instancia.

group

Sí

String

Nombre del grupo de consumidores.

Parámetros de solicitud

Ninguno

Parámetros de respuesta

Código de estado: 200

Tabla 2 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

group

objeto de groupo

Información del grupo de consumidores.

Tabla 3 group

Parámetro

Tipo

Descripción

group_id

String

Nombre del grupo de consumidores.

state

String

Estado del grupo de consumidores. El valor puede ser:

  • Dead: El grupo de consumidores no tiene miembros ni metadatos.
  • Empty: El grupo de consumidores tiene metadatos pero no tiene miembros.
  • PreparingRebalance: El grupo de consumidores debe ser reequilibrado.
  • CompletingRebalance: Todos los miembros se han unido al grupo.
  • Stable: Los miembros del grupo de consumidores pueden consumir mensajes normalmente.

coordinator_id

Integer

ID del coordinador.

members

Matriz de objetos miembros

Lista de consumidores.

group_message_offsets

Matriz de objetos group_message_offsets

Desplazamiento del consumidor.

assignment_strategy

String

Política de asignación de particiones.

Tabla 4 members

Parámetro

Tipo

Descripción

host

String

Dirección del consumidor.

assignment

Matriz de objetos de asignación

Detalles sobre la partición asignada al consumidor.

member_id

String

ID del consumidor.

client_id

String

ID de cliente.

Tabla 5 assignment

Parámetro

Tipo

Descripción

topic

String

Nombre del tema.

partitions

Matriz de integers

Lista de particiones.

Tabla 6 group_message_offsets

Parámetro

Tipo

Descripción

partition

Integer

Número de partición.

lag

Integer

Número de mensajes restantes que se pueden recuperar, es decir, el número de mensajes acumulados.

topic

String

Nombre del tema.

message_current_offset

Integer

Desplazamiento del consumidor.

message_log_end_offset

Integer

Desplazamiento final de registro (LEO).

Solicitudes de ejemplo

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/management/groups/{group}

Respuestas de ejemplo

Código de estado: 200

Los detalles del grupo de consumidores se consultan correctamente.

{
  "group" : {
    "members" : [ {
      "host" : "/172.31.1.102",
      "assignment" : [ {
        "topic" : "test",
        "partitions" : [ 0, 1, 2 ]
      } ],
      "member_id" : "consumer-1-6b8ee551-d499-47d4-9beb-ba1527496785",
      "client_id" : "consumer-1"
    } ],
    "state" : "STABLE",
    "group_id" : "test-consumer-group",
    "coordinator_id" : 2,
    "group_message_offsets" : [ {
      "partition" : 0,
      "lag" : 31396,
      "topic" : "test",
      "message_current_offset" : 935,
      "message_log_end_offset" : 32331
    }, {
      "partition" : 0,
      "lag" : 0,
      "topic" : "aaaa",
      "message_current_offset" : 0,
      "message_log_end_offset " : 0
    }, {
      "partition" : 1,
      "lag" : 31279,
      "topic" : "test",
      "message_current_offset" : 1058,
      "message_log_end_offset " : 32337
    }, {
      "partition" : 1,
      "lag" : 0,
      "topic" : "aaaa",
      "message_current_offset" : 0,
      "message_log_end_offset" : 0
    }, {
      "partition" : 2,
      "lag" : 31603,
      "topic" : "test",
      "message_current_offset" : 739,
      "message_log_end_offset" : 32342
    } ],
    "assignment_strategy" : "range"
  }
}

Códigos de estado

Código de estado

Descripción

200

Los detalles del grupo de consumidores se consultan correctamente.

Códigos de error

Consulte Códigos de error.

Tema principal:Gestión de instancias