> ## 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.
# Obtener instantánea
Requiere la acción de IAM **`storage:GetSnapshot`**. Consulte [permisos de almacenamiento](/es/storage/permissions) para obtener la lista completa, lo que cubre cada una y un ejemplo de política.
## OpenAPI
````yaml /es/api-reference/specs/storage.yaml get /v1/snapshots/{snapshot_id}
openapi: 3.0.3
info:
title: API de almacenamiento de Basaltic
version: 1.0.0
description: >
Las referencias de almacenamiento aceptan UUID, CRN o nombres de ámbito en
un campo. Los nombres de instantáneas requieren un volumen fijo;
source_snapshot solo acepta UUID o CRN anidado. Bloquee volúmenes con sus
instantáneas y políticas de instantáneas, además de la administración de
buckets para el almacenamiento de objetos. El protocolo de cable S3 en sí se
sirve por separado en `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: Punto final de API regional
variables:
region:
default: sa-saopaulo-1
description: Código de región
security:
- BearerAuth: []
paths:
/v1/snapshots/{snapshot_id}:
get:
tags:
- Storage
summary: Obtener instantánea
operationId: getSnapshot
parameters:
- $ref: '#/components/parameters/SnapshotId'
responses:
'200':
description: Detalles de la instantánea
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
security:
- BearerAuth: []
components:
parameters:
SnapshotId:
name: snapshot_id
in: path
description: ID de instantánea
required: true
schema:
type: string
format: uuid
example: 550e8400-e29b-41d4-a716-446655440000
schemas:
SnapshotResponse:
type: object
properties:
snapshot:
$ref: '#/components/schemas/Snapshot'
Snapshot:
type: object
required:
- faults
properties:
id:
type: string
format: uuid
readOnly: true
example: 7b1e9c4d-3a2f-4b8c-9d6e-0f1a2b3c4d5e
crn:
type: string
readOnly: true
description: Nombre de recurso de Cloud (basado en nombre, con ámbito de región).
example: >-
crn:storage:sa-saopaulo-1:my-account:volume/data-vol-01/snapshot/weekly-backup
volume_id:
type: string
format: uuid
description: Volumen de origen del que se tomó la instantánea.
example: 5f8d2c1a-9b3e-4d7a-8c6f-1e2a3b4c5d6e
snapshot_policy_id:
type: string
format: uuid
readOnly: true
description: >
La directiva de instantánea que tomó esta instantánea. Ausente
cuando una persona lo hizo. Esto es también lo que coincide con la
retención, por lo que su presencia es lo que hace que una
instantánea sea elegible para la eliminación automática; las
instantáneas tomadas manualmente nunca se cosechan.
example: 3c9f1b2e-6d4a-4e8b-9f1c-2a3b4c5d6e7f
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
maxLength: 128
example: nightly-2026-01-15
description:
type: string
example: Nightly backup of data-vol-01
tags:
$ref: '#/components/schemas/Tags'
size_gb:
type: integer
description: >
Tamaño congelado del volumen de origen en el momento en que se tomó
la instantánea; el volumen puede haberse ampliado desde entonces.
example: 100
status:
$ref: '#/components/schemas/SnapshotStatus'
faults:
type: array
readOnly: true
description: >-
Fallas activas, más reciente primero. Vacío cuando está sano. El
estado es error si y solo si existe un fallo activo de gravedad de
error. El historial resuelto se conserva internamente.
items:
$ref: '#/components/schemas/Fault'
created_at:
type: string
format: date-time
readOnly: true
example: '2026-01-15T09:30:00Z'
updated_at:
type: string
format: date-time
readOnly: true
example: '2026-01-15T09:30:42Z'
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
Tags:
type: object
additionalProperties:
type: string
example:
environment: production
team: backend
SnapshotStatus:
type: string
enum:
- creating
- available
- deleting
- error
example: available
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:
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
`. 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.