> ## 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 las instancias de un balanceador de carga

> Lista instancias completas de compute pertenecientes a este balanceador, con los mismos filtros, orden y paginación que un pool de instancias. Cada instancia incluye ResourceRefs y campos del ciclo de vida, además de la salud del balanceador (`status`, `proxy_ok`, `last_seen`, `agent_version`) y detalles opcionales de retirada. El número de secuencia estable está en `metadata["basalt:pool:sequence_num"]`. `status` describe la salud del proxy; `current_state` describe el ciclo de vida de la instancia.


<Info>
  Requiere la acción de IAM **`loadbalancer:GetLoadBalancer`**. Consulta [permisos de balanceadores de carga](/loadbalancer/permissions) para obtener la lista completa, lo que cubre cada una y un ejemplo de directiva.
</Info>


## OpenAPI

````yaml /es/api-reference/specs/loadbalancer.yaml get /v1/load-balancers/{id}/instances
openapi: 3.0.3
info:
  title: API de equilibrador de carga basaltico
  version: 1.0.0
  description: >
    Las relaciones de solicitud aceptan referencias clasificadas por sintaxis
    resueltas dentro de la cuenta y región del llamador. Las referencias IP
    flotantes solo aceptan UUID o CRN; los destinos IP permanecen literales.
    Balanceadores de carga administrados: escuchas, grupos de destino,
    comprobaciones de estado y los certificados TLS que termina una escucha.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://loadbalancer.{region}.basaltic.sh
    description: Punto final de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de región
security:
  - BearerAuth: []
paths:
  /v1/load-balancers/{id}/instances:
    get:
      tags:
        - Load Balancers
      summary: Listar las instancias de un balanceador de carga
      description: >
        Lista instancias completas de compute pertenecientes a este balanceador,
        con los mismos filtros, orden y paginación que un pool de instancias.
        Cada instancia incluye ResourceRefs y campos del ciclo de vida, además
        de la salud del balanceador (`status`, `proxy_ok`, `last_seen`,
        `agent_version`) y detalles opcionales de retirada. El número de
        secuencia estable está en `metadata["basalt:pool:sequence_num"]`.
        `status` describe la salud del proxy; `current_state` describe el ciclo
        de vida de la instancia.
      operationId: listLoadBalancerInstances
      parameters:
        - $ref: '#/components/parameters/ComputeCRNFilter'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Marker'
        - $ref: '#/components/parameters/ComputeNameFilter'
        - name: current_state
          in: query
          description: Filtrar por dónde están las instancias.
          schema:
            $ref: '#/components/schemas/CurrentState'
        - name: flavor
          in: query
          description: >-
            Filtrar por referencia de tipo de instancia regional (UUID, CRN o
            nombre exacto).
          schema:
            type: string
            example: a1b2c3d4-e5f6-4789-9abc-def012345678
        - name: image
          in: query
          description: >-
            Filtrar por referencia de imagen (UUID, CRN o nombre; las imágenes
            también aceptan nombre:versión).
          schema:
            type: string
            example: 550e8400-e29b-41d4-a716-446655440001
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: 4e1f8c2a-9b3d-4f6e-8a1c-2d5e7f9a0b3c
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadBalancerInstancesResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    ComputeCRNFilter:
      name: crn
      in: query
      description: >-
        CRN exacto del recurso, intersecado con todos los demás filtros antes de
        la paginación. Un CRN extranjero o no coincidente devuelve una página
        vacía; los CRN mal formados o vacíos devuelven 400. Las listas de
        archivos adjuntos anidados filtran el recurso representado, no el
        enlace.
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: >-
        Número máximo de artículos a devolver. Un valor por encima del máximo se
        le aplica en lugar de rechazarlo, por lo que una página más corta que la
        que solicitaste es normal — page until `meta.has_more` es falso, no
        hasta que una página se vea corta.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
    Marker:
      name: marker
      in: query
      description: >-
        Cursor de paginación opaco. Hacer eco del valor `meta.marker` de la
        página anterior para buscar la siguiente; no construirlo ni analizarlo.
        La forma interna del token varía según el punto final (un ID de recurso,
        una marca de tiempo, etc.) y no se garantiza su estabilidad entre
        versiones.
      required: false
      schema:
        type: string
      example: 550e8400-e29b-41d4-a716-446655440000
    ComputeNameFilter:
      name: name
      in: query
      description: >-
        Nombre exacto, que distinga entre mayúsculas y minúsculas. Los valores
        vacíos no coinciden con recursos con nombre. Las listas de NIC de
        instancia coinciden con los nombres de interfaz dentro de las
        vinculaciones de instancia; pueden coincidir varias interfaces con el
        mismo nombre. Las IP flotantes no tienen identidad de nombre y devuelven
        una lista vacía para este filtro.
      schema:
        type: string
  schemas:
    CurrentState:
      type: string
      description: >
        Donde se encuentra una instancia. Los estados de transición viven aquí,
        no en desired_state — nadie pide `stopping`.
      enum:
        - pending
        - building
        - running
        - stopping
        - stopped
        - rebooting
        - migrating
        - deleting
        - deleted
        - error
        - crashed
        - paused
        - suspended
    LoadBalancerInstancesResponse:
      type: object
      required:
        - instances
        - meta
      properties:
        instances:
          type: array
          items:
            $ref: '#/components/schemas/LoadBalancerInstance'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    LoadBalancerInstance:
      description: >
        Una instancia de compute que sirve al balanceador de carga, con salud
        del proxy y detalles de retirada. Durante un redimensionamiento, compara
        flavor.id de cada instancia con flavor.id del balanceador. Puede
        aparecer una instancia adicional mientras la sustituta comienza a servir
        y la antigua drena.
      allOf:
        - $ref: '#/components/schemas/Instance'
        - type: object
          required:
            - proxy_ok
            - status
          properties:
            retirement:
              $ref: '#/components/schemas/Retirement'
            status:
              type: string
              enum:
                - initializing
                - healthy
                - unhealthy
                - draining
              example: healthy
              description: >-
                Salud del proxy: initializing antes del primer informe, healthy
                cuando el último informe indica que el proxy está sirviendo,
                unhealthy cuando está caído y draining cuando la instancia se
                está retirando. Consulta last_seen para la antigüedad de la
                última observación.
            proxy_ok:
              type: boolean
              description: >-
                Si el proxy informó que estaba listo en el último informe de
                estado
              example: true
            agent_version:
              type: string
              example: 1.4.2
            last_seen:
              type: string
              format: date-time
              description: Se omite cuando esta instancia aún no ha enviado un informe
              example: '2026-01-15T09:31:00Z'
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Número total de artículos
          example: 150
        limit:
          type: integer
          description: Número de artículos por página
          example: 20
        marker:
          type: string
          description: >-
            Cursor opaco para la página siguiente. Pasalo de vuelta como el
            parámetro de consulta `marker`; trátalo como un token, no como un
            valor para analizar.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Si hay más artículos
          example: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de error que identifica el tipo de error
              example: INVALID_INPUT
            message:
              type: string
              description: Mensaje de error legible por el ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores no sensibles opcionales para la interpolación de errores
                localizados, codificados por código de error. Nunca presente por
                errores del servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuración
              example: 550e8400-e29b-41d4-a716-446655440000
    Instance:
      type: object
      required:
        - faults
        - id
        - crn
        - name
        - flavor
        - image
        - iam_role
        - desired_state
        - current_state
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 550e8400-e29b-41d4-a716-446655440000
        crn:
          type: string
          readOnly: true
          description: Nombre de recurso de la nube
          example: crn:compute:sa-saopaulo-1:my-account:instance/web-01
        name:
          description: >-
            Los nombres de los recursos no deben comenzar con el prefijo literal
            crn: ni ser UUID (en cualquier caso, en las formas canónica,
            compacta, entre corchetes o urn:uuid:).
          type: string
          example: web-server-01
        description:
          type: string
          example: Primary web server
        task_state:
          type: string
          nullable: true
          description: Transición en curso, si la hubiera; nula cuando se haya resuelto.
          example: null
        flavor:
          allOf:
            - $ref: '#/components/schemas/ResourceRef'
          description: >-
            Identidad del flavor. Toda instancia tiene un flavor; consulta el
            recurso flavor para obtener CPU y RAM.
          example:
            id: 550e8400-e29b-41d4-a716-446655440003
            crn: crn:compute:sa-saopaulo-1:platform:flavor/s1.small
            name: s1.small
        image:
          anyOf:
            - $ref: '#/components/schemas/ResourceRef'
            - type: object
              nullable: true
              enum:
                - null
          description: >-
            Identidad fijada de la imagen de origen, o null para arranque solo
            desde volumen.
          example:
            id: 550e8400-e29b-41d4-a716-446655440004
            crn: >-
              crn:compute:sa-saopaulo-1:platform:image/ubuntu/architecture/amd64/version/24.04
            name: ubuntu
        user_data:
          type: string
          description: >-
            Datos de usuario de cloud-init codificados en Base64 suministrados
            en el lanzamiento.
        iam_role:
          anyOf:
            - $ref: '#/components/schemas/ResourceRef'
            - type: object
              nullable: true
              enum:
                - null
          description: >-
            Identidad del rol de IAM vinculado, o null cuando no hay ningún rol
            vinculado. Los roles eliminados conservan su identidad sin name.
          example:
            id: 550e8400-e29b-41d4-a716-446655440005
            crn: crn:iam:::role/550e8400-e29b-41d4-a716-446655440005
            name: instance-role
        metadata:
          $ref: '#/components/schemas/Metadata'
        tags:
          $ref: '#/components/schemas/Tags'
        faults:
          type: array
          description: >-
            Fallos activos ordenados por last_at descendiente, luego id de
            historial interno descendiente para un desempate estable. Los
            recursos sanos regresan [].
          items:
            $ref: '#/components/schemas/Fault'
        created_at:
          type: string
          format: date-time
          readOnly: true
          example: '2024-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          example: '2024-01-15T10:30:00Z'
        launched_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          example: '2026-01-15T09:31:12Z'
        terminated_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
          example: null
        desired_state:
          type: string
          enum:
            - running
            - stopped
            - deleted
          example: running
          description: >
            Lo que se pidió. Solo tres valores, porque solo hay tres cosas que
            se pueden pedir a una instancia que sea: Create/Start/Reboot para
            ejecutar, Stop para detener, Delete para eliminar.
        current_state:
          $ref: '#/components/schemas/CurrentState'
          example: running
          description: >
            Lee esto para responder "es arriba" — los estados de transición
            viven aquí, no en desired\_state, porque nadie pide que sea aquí
            donde se encuentra la instancia. `stopping`.


            desired_state=running con current_state=stopped es una instancia que
            se pidió que se iniciara y que aún no ha aparecido.
    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: >-
            Hora de eliminación más temprana; ausente mientras la retirada está
            pendiente.
    ResourceRef:
      type: object
      required:
        - id
        - crn
      properties:
        id:
          type: string
          format: uuid
          example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        crn:
          type: string
          example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        name:
          type: string
          description: >-
            Etiqueta en el momento de la respuesta: el nombre del recurso, si lo
            tiene, o su etiqueta legible (número de factura, nombre de
            visualización de la cuenta). Ausente cuando el destino ya no existe.
            No es una clave de búsqueda.
          example: Brazil
    Metadata:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    Fault:
      type: object
      required:
        - code
        - severity
        - message
        - details
        - first_at
        - last_at
        - occurrences
      properties:
        code:
          type: string
          description: >-
            Código legible por máquina estable propiedad de la operación de
            informes.
          example: BACKUP_FAILED
        severity:
          type: string
          enum:
            - error
            - warning
        message:
          type: string
          example: Backup upload failed.
        details:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Contexto estructurado; las cadenas heredadas se conservan en
            legacy_text.
        first_at:
          type: string
          format: date-time
          description: Primera observación en esta serie de ocurrencias activas.
        last_at:
          type: string
          format: date-time
          description: Última observación en esta serie de ocurrencias activas.
        occurrences:
          type: integer
          minimum: 1
          example: 1
  responses:
    BadRequest:
      description: Parámetros de solicitud no válidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Se requiere autenticación o el token no es vá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: Permisos 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: No se encontró el recurso
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Error interno del servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Un token bearer de OAuth 2.0, enviado como `Authorization: Bearer
        <token>`. Esta es la forma recomendada de autenticación.


        Obtén el token intercambiando el par de claves de acceso de una cuenta
        de servicio en `POST /v1/oauth/token` con
        `grant_type=client_credentials`. Es el flujo estándar de credenciales de
        cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar
        el token por ti.


        ```

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


        Los tokens duran una hora por defecto. El mismo par de claves de acceso
        también sirve como credencial AWS SigV4 para el endpoint de objetos
        compatible con S3, que solo acepta ese método de autenticación.


````

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