Skip to main content
Cada parte de Basaltic es una API HTTP. La consola y la CLI son clientes de estos mismos puntos finales; no hay nada en el producto al que puedan llegar y que no puedas alcanzar.

​
Cómo se genera esta referencia

Estas páginas se generan a partir de las especificaciones de OpenAPI con las que se construyen y verifican los servicios, no se escriben a mano junto a ellas. Una operación aparece aquí porque existe, con las formas de solicitud y respuesta que el servicio implementa realmente, incluidas las respuestas de error, que se documentan en lugar de dejar que se descubran.

​
Convenios

Versioning. Cada ruta tiene el prefijo /v1. Identificadores. Las respuestas de recursos exponen identidades canónicas. Las rutas de recursos UUID usan el id devuelto; los campos de referencia de petición aceptan solo los tipos declarados por su operación. Consulte Referencias de recursos para obtener información sobre nombres con ámbito, CRN anidados, versiones de imágenes, filtros de lista exacta y obtención de un recurso por cualquier referencia. Los CRN de ámbito de organización requieren el contexto de organización autenticado. Errores. Los errores devuelven un cuerpo JSON con un código estable y legible por máquina. Coincide con el código, no con el mensaje legible por el ser humano, que puede cambiar. Faults. Los recursos que se ejecutan en segundo plano siempre incluyen faults: una matriz de observaciones activas, o [] cuando no quedan ninguna. Consulte Resource faults para conocer la matriz, el orden, la recuperación y cómo la gravedad se asigna al estado. Idempotencia y trabajo asíncrono. Las operaciones que se entregan a un flujo de trabajo en segundo plano responden 202 Accepted en lugar de fingir que el trabajo está hecho. Sonda el recurso hasta que alcance un estado terminal; un 202 seguido de una lectura que aún muestra el estado antiguo es el contrato que funciona, no un error. Paginación. Lista de operaciones de la página. Siga los campos de paginación en la respuesta en lugar de asumir que lo tiene todo.

​
Cómo empezar

Autenticación

Tokens de portador, sesiones de rol de cuenta y de dónde provienen las credenciales.

Regiones y endpoints

En qué host responde cada servicio y cuáles son globales.

Inicio rápido

Una solicitud autenticada que funciona, de extremo a extremo.

CLI

Utilice las API desde su terminal.

​
Las APIs

Workspace: organizaciones, cuentas, usuarios, grupos, invitaciones y directivas de la organización. Global, con autorización de ámbito de organización. Identidad y cuenta: IAM administra los roles de cuenta, las cuentas de servicio, las directivas de cuenta y las sesiones. La cuota, la auditoría y la facturación requieren subvenciones de la organización. Estos servicios utilizan puntos finales globales; IAM de cuentas todavía requiere el ámbito de cuenta. Compute: computación (instancias, imágenes, variantes, grupos de instancias) y base de datos (clústeres administrados). Networking: red (VPC, subredes, puertas de enlace, IP flotantes), equilibrador de carga, DNS, certificado. Almacenamiento: almacenamiento (volúmenes de bloques, instantáneas, depósitos). El protocolo de cable S3 se sirve por separado; consulte object storage. Seguridad — KMS (claves de cifrado), secretos. Observabilidad — Telemetría (registros, métricas, trazas).