> ## 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 tipos de volume

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


## OpenAPI

````yaml /pt/api-reference/specs/storage.yaml get /v1/volume-types
openapi: 3.0.3
info:
  title: API de armazenamento Basaltic
  version: 1.0.0
  description: >
    As referências de armazenamento aceitam UUIDs, CRNs ou nomes de escopo em um
    campo. Os nomes de snapshot requerem um volume fixo; source_snapshot aceita
    somente UUID ou CRN aninhado. Bloqueie volumes com seus snapshots e
    políticas de snapshot, além de gerenciamento de bucket para armazenamento de
    objetos. O próprio protocolo de fio S3 é servido separadamente em
    `objects.{region}.basaltic.cloud`.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://storage.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/volume-types:
    get:
      tags:
        - Storage
      summary: Listar tipos de volume
      operationId: listVolumeTypes
      parameters:
        - in: query
          name: name
          schema:
            type: string
          description: >-
            Nome exato para exibição, case sensitive; um valor vazio não
            corresponde a nada.
        - in: query
          name: crn
          schema:
            type: string
          description: >-
            CRN de tipo de volume de plataforma regional exata. Identidades
            estrangeiras ou não correspondidas retornam uma lista vazia.
      responses:
        '200':
          description: Lista de tipos de volume
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeTypeListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    VolumeTypeListResponse:
      type: object
      properties:
        volume_types:
          type: array
          items:
            $ref: '#/components/schemas/VolumeType'
    VolumeType:
      type: object
      properties:
        included_iops:
          type: integer
          example: 3000
        included_throughput_mib_s:
          type: integer
          example: 125
        max_iops:
          type: integer
          example: 8000
        max_throughput_mib_s:
          type: integer
          example: 250
        crn:
          type: string
          description: >-
            Identidade de catálogo de plataforma regional, usando o token de
            tipo imutável.
          example: crn:storage:sa-saopaulo-1:platform:volume-type/ssd
        id:
          type: string
          description: O token de tipo (corresponde a `volume_type` em um Volume).
          example: ssd
        name:
          description: >-
            Os nomes de recursos não devem começar com o prefixo literal crn: ou
            ser UUIDs (formas canônicas, compactas, entre colchetes ou
            urn:uuid:, em qualquer caso).
          type: string
          example: SSD
        description:
          type: string
          example: SSD-backed general purpose storage
    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
    InternalServerError:
      description: Erro interno do 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: >+
        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.