> ## 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 os volumes anexados da instância

> Retorna os vínculos de volume da instância ordenados pelo índice de inicialização (disco de inicialização primeiro), cada um resolvido com o nome/tipo/tamanho/status atual do volume.


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


## OpenAPI

````yaml /pt/api-reference/specs/compute.yaml get /v1/instances/{instance_id}/volumes
openapi: 3.0.3
info:
  title: API de Basaltic Compute
  version: 1.0.0
  description: >
    Instâncias de máquina virtual e as imagens, os tipos e os pools de
    instâncias a partir dos quais elas são criadas. Abrange todo o ciclo de vida
    da instância: iniciar, parar, reiniciar, redimensionar e reinstalar.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://compute.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/instances/{instance_id}/volumes:
    get:
      tags:
        - Compute
      summary: Listar os volumes anexados da instância
      description: >
        Retorna os vínculos de volume da instância ordenados pelo índice de
        inicialização (disco de inicialização primeiro), cada um resolvido com o
        nome/tipo/tamanho/status atual do volume.
      operationId: listInstanceVolumes
      parameters:
        - $ref: '#/components/parameters/ComputeNameFilter'
        - $ref: '#/components/parameters/ComputeCRNFilter'
        - $ref: '#/components/parameters/InstanceId'
      responses:
        '200':
          description: Lista de volumes anexados
          content:
            application/json:
              schema:
                type: object
                properties:
                  attachments:
                    type: array
                    items:
                      type: object
                      properties:
                        volume_id:
                          type: string
                          format: uuid
                          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
                        device:
                          type: string
                          example: vdb
                        boot_index:
                          type: integer
                          example: 1
                        delete_on_termination:
                          type: boolean
                          example: false
                        mount_path:
                          type: string
                          example: /data
                        fstype:
                          type: string
                          enum:
                            - ext4
                            - xfs
                          description: >-
                            O sistema de arquivos com o qual o agente convidado
                            formatou o volume, ou ausente quando o anexo não
                            nomeou um e o agente usou o padrão ext4. Cada
                            caminho de gravação — instância criar, pool template
                            e anexar — recusa qualquer outra coisa, então este é
                            o conjunto inteiro que o campo pode conter.
                        name:
                          type: string
                          example: web-1-data
                        volume_type:
                          type: string
                          example: ssd
                        size_gb:
                          type: integer
                          example: 100
                        status:
                          type: string
                          example: in_use
                        bootable:
                          type: boolean
                          example: false
                        mount:
                          $ref: '#/components/schemas/VolumeMount'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - BearerAuth: []
components:
  parameters:
    ComputeNameFilter:
      name: name
      in: query
      description: >-
        Exato, nome sensível a maiúsculas. Valores vazios não correspondem a
        nenhum recurso nomeado. As listas de NICs de instância correspondem aos
        nomes de interface dentro das ligações de instância; várias interfaces
        com o mesmo nome podem corresponder. Os IPs flutuantes não têm
        identidade de nome e retornam uma lista vazia para esse filtro.
      schema:
        type: string
    ComputeCRNFilter:
      name: crn
      in: query
      description: >-
        CRN exato do recurso, intersetado com todos os outros filtros antes da
        paginação. Um CRN estrangeiro ou não correspondido retorna uma página
        vazia; CRNs malformados ou vazios retornam 400. As listas de anexos
        aninhadas filtram o recurso representado, não a vinculação.
      schema:
        type: string
    InstanceId:
      name: instance_id
      in: path
      description: ID da instância
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    VolumeMount:
      type: object
      description: >
        O que o agente convidado relatou sobre este anexo.


        Apresentar apenas em um anexo que carrega um `mount_path`. Um volume sem
        um é anexado como um dispositivo de bloco nu que o locatário possui:
        nada o reconcilia, então nada relata sobre ele e um estado para ele
        seria uma reivindicação sobre algo que ninguém está observando.


        O agente é instalado na primeira inicialização e nada o atualiza depois,
        então uma instância mais antiga que esse recurso não relata nada e cada
        um de seus volumes lê `unknown`. Trate o `unknown` como "nenhuma
        informação", nunca como saudável.
      required:
        - state
      properties:
        state:
          type: string
          enum:
            - unknown
            - pending
            - mounted
            - failed
          description: >
            - `unknown` — nenhum agente convidado já relatou sobre este volume.
            O agente pode ser anterior a esse recurso, pode ter sido removido (o
            que é suportado) ou o convidado pode nunca ter inicializado.

            - `pending` — o agente não pode montá-lo ainda e espera que isso
            mude. O estado comum para os primeiros segundos após um anexo,
            enquanto o disco hot-plugged aparece no convidado.

            - `mounted` — montado em `mount_path`. Pode ainda carregar um
            `code`.

            - `failed` — ele não será montado até que algo mude. Ou o agente
            relatou uma recusa que a espera não pode corrigir, ou não conseguiu
            fazer progresso por tempo suficiente para que a espera não seja mais
            a explicação. `code` diz qual.
        code:
          type: string
          enum:
            - unsafe_serial
            - device_absent
            - probe_failed
            - signatures_no_filesystem
            - unsupported_fstype
            - mkfs_failed
            - unsafe_mount_path
            - mkdir_failed
            - mount_failed
            - fstab_write_failed
            - unknown_error
          description: >
            Por que o volume está neste estado. Ausente quando não há nada a
            dizer.


            Independente de `state` em vez de algo que apenas uma falha carrega:
            `fstab_write_failed` acompanha um volume **montado** cuja entrada
            fstab não pôde ser escrita, que funciona agora e desaparecerá após a
            próxima reinicialização.


            O mais comum para agir é `signatures_no_filesystem` — o disco
            carrega uma tabela de partição ou outras assinaturas, mas nenhum
            sistema de arquivos montável, então o agente não o formatará, porque
            a formatação destruiria o que está lá. Um volume clonado de um disco
            de inicialização e anexado com um `mount_path` cai aqui. Particione
            e formate-o dentro do guest, ou anexe-o sem um `mount_path` e
            monte-o você mesmo.


            `unknown_error` é um código que esta plataforma não reconhece,
            relatado por um agente convidado mais recente que a região.
        message:
          type: string
          maxLength: 256
          description: >
            Detalhe legível por humanos de dentro do guest — a saída do comando
            que falhou, o tipo de tabela de partição que ele encontrou. Texto
            livre originário da própria VM do cliente: higienizado e limitado,
            mas exibido como texto, nunca como marcação.
          example: >-
            /dev/disk/by-id/virtio-9f2c has a gpt partition table but no
            mountable filesystem, so this agent will not format it; formatting
            would destroy what is there
        since:
          type: string
          format: date-time
          description: >-
            Quando o volume entrou nesta condição. Ausente quando `state` é
            `unknown`.
        reported_at:
          type: string
          format: date-time
          description: >-
            Quando o agente convidado relatou pela última vez, se algo mudou ou
            não. Um `reported_at` muito no passado significa que o agente parou
            de falar conosco, e o estado ao lado dele é o que ele disse pela
            última vez, em vez do que é verdade agora. Ausente quando `state` é
            `unknown`.
    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
  responses:
    BadRequest:
      description: Parâmetros de solicitação invá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: 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.