> ## Documentation Index
> Fetch the complete documentation index at: https://docs.basaltic.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar réplicas de instâncias do balanceador com estado de integridade atual

> Retorna uma entrada por instância de computação que suporta o LB. A sobreposição por réplica `proxy_ok` + `last_seen` é atualizada em cada relatório de integridade da réplica (tipicamente a cada 15s) e está ausente quando uma réplica ainda não foi relatada (boot ainda em andamento).


<Info>
  Requer a ação do IAM **`loadbalancer:GetLoadBalancer`**. Consulte [permissões de balanceadores de carga](/loadbalancer/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/loadbalancer.yaml get /v1/load-balancers/{id}/replicas
openapi: 3.0.3
info:
  title: API do Basaltic Load Balancer
  version: 1.0.0
  description: >
    Relações de solicitação aceitam referências classificadas por sintaxe
    resolvidas dentro da conta e região do chamador. Referências IP flutuantes
    aceitam somente UUID ou CRN; os alvos IP permanecem literais. Balanceadores
    de carga gerenciados: ouvintes, pools de destino, verificações de
    integridade e os certificados TLS que um ouvinte encerra.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://loadbalancer.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/load-balancers/{id}/replicas:
    get:
      tags:
        - Load Balancers
      summary: >-
        Listar réplicas de instâncias do balanceador com estado de integridade
        atual
      description: >
        Retorna uma entrada por instância de computação que suporta o LB. A
        sobreposição por réplica `proxy_ok` + `last_seen` é atualizada em cada
        relatório de integridade da réplica (tipicamente a cada 15s) e está
        ausente quando uma réplica ainda não foi relatada (boot ainda em
        andamento).
      operationId: listLoadBalancerReplicas
      parameters:
        - name: name
          in: query
          description: >-
            Nome exato imutável. Um valor vazio ou um recurso sem um nome não
            seleciona nenhuma linha.
          schema:
            type: string
        - name: crn
          in: query
          description: >-
            Exato CRN de escopo. CRNs estrangeiros ou incompatíveis não
            selecionam linhas; CRNs malformados ou vazios retornam 400.
          schema:
            type: string
        - name: id
          in: path
          required: true
          schema:
            type: string
            example: 4e1f8c2a-9b3d-4f6e-8a1c-2d5e7f9a0b3c
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadBalancerReplicasResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    LoadBalancerReplicasResponse:
      type: object
      properties:
        replicas:
          type: array
          items:
            $ref: '#/components/schemas/LoadBalancerReplica'
    LoadBalancerReplica:
      type: object
      description: >
        Uma instância de computação que sustenta o balanceador de carga. Os
        campos de identificação e registro (instance_id, replica_index,
        created_at, flavor_id) são persistidos; os dados de atividade
        (last_seen, proxy_ok, agent_version) são atualizados a cada informe de
        integridade da réplica.


        As réplicas são instâncias gerenciadas e não aparecem nos endpoints de
        instâncias de computação. Consulte-as aqui. Durante um
        redimensionamento, elas são substituídas uma por vez: a mudança de
        instance_id indica que uma réplica foi substituída, e o processo termina
        quando todos os valores de flavor_id correspondem ao do balanceador.
        Durante a troca, a lista pode conter uma réplica a mais que
        replica_count para manter a capacidade. A réplica excedente desaparece
        quando a última réplica antiga é removida.
      required:
        - instance_id
        - replica_index
        - created_at
        - flavor_id
        - proxy_ok
        - status
      properties:
        retirement:
          $ref: '#/components/schemas/Retirement'
        instance_id:
          type: string
          format: uuid
          example: a7b8c9d0-e1f2-4345-a6b7-c8d9e0f1a2b3
        replica_index:
          type: integer
          example: 0
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        flavor_id:
          type: string
          format: uuid
          example: e5f6a7b8-c9d0-4123-e4f5-a6b7c8d9e0f1
          description: >-
            O tamanho desta réplica realmente inicializou. Corresponde ao
            flavor_id do balanceador de carga, exceto mid-resize, quando as
            réplicas ainda não substituídas ainda relatam a antiga.
        status:
          type: string
          enum:
            - initializing
            - healthy
            - unhealthy
            - draining
          example: healthy
          description: >-
            Estado de atividade resumido: 'initializing' (o agente ainda não
            enviou nenhum informe; a inicialização está em andamento), 'healthy'
            (há sinais de atividade e o proxy está atendendo) ou 'unhealthy' (há
            sinais de atividade, mas o proxy está indisponível).
        proxy_ok:
          type: boolean
          description: Se o proxy foi relatado pronto no último relatório de integridade
          example: true
        agent_version:
          type: string
          example: 1.4.2
        last_seen:
          type: string
          format: date-time
          description: Omitida quando esta réplica ainda não foi reportada
          example: '2026-01-15T09:31:00Z'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
    Retirement:
      type: object
      readOnly: true
      required:
        - requested_at
        - drain_seconds
      properties:
        requested_at:
          type: string
          format: date-time
        drain_seconds:
          type: integer
          minimum: 30
          maximum: 3600
        agent_acknowledged_at:
          type: string
          format: date-time
        drain_until:
          type: string
          format: date-time
          description: >-
            Tempo de exclusão mais cedo; ausente enquanto a retirada está
            pendente.
  responses:
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: Página não encontrada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.