Errores y paginación de la API
Inspecciona el estado HTTP y el cuerpo de respuesta cuando falle una solicitud. Mantén el cuerpo privado si contiene datos de cuentas, código fuente o aplicaciones.
Códigos de estado
| Estado | Qué comprobar |
|---|---|
| 400 | Campos obligatorios, codificación del cuerpo, IDs de recursos, valores de consulta y X-Tenant-ID. |
| 401 | Token ausente, caducado o incompatible. Obtén un nuevo token de diagnóstico cuando sea necesario. |
| 402 | La suscripción o el derecho de recursos del equipo para la operación. |
| 403 | Pertenencia al equipo, rol, permisos sobre el recurso y coincidencia entre token y equipo. |
| 404 | ID de recursos, equipo activo y ruta. |
| 409 | Estado de recursos conflictivos o una operación ya en curso. |
| 429 | Espera antes de reintentar y respeta Retry-After cuando esté presente. |
| 5xx | Disponibilidad del servicio. Conserva la hora, la ruta y la respuesta sin datos sensibles para diagnosticar el problema. |
Las operaciones correctas devuelven un estado 2xx. Las eliminaciones CRUD generadas usan HTTP 200 con un mensaje, mientras que las eliminaciones de objetos documentadas usan 204. Sigue el contrato de cada endpoint en lugar de asumir un único estado de éxito para todos los métodos.
Paginación de listas
Las listas de CRUD generadas aceptan:
| Parámetro | Valor predeterminado | Límite |
|---|---|---|
page | 1 | Usa la información de paginación devuelta para solicitar las siguientes páginas. |
per_page | 20 | Máximo 100. |
Devuelven los registros en data y metadatos en pagination. Los endpoints personalizados pueden usar otros formatos de lista o cursores; consulta sus parámetros y su contrato de respuesta. Copia los IDs de los datos devueltos para operaciones posteriores.
Reintentos y trabajo asíncrono
Reintenta las lecturas tras un fallo transitorio con una espera limitada. Antes de reintentar una creación, un despliegue, el inicio de un flujo de trabajo, una subida u otra mutación, inspecciona el estado del destino para determinar si el primer intento ya surtió efecto. Esta referencia pública no promete un contrato universal de claves de idempotencia.
Una solicitud correcta de compilación, despliegue, vista previa o comando puede iniciar trabajo que termine más tarde. Lee su estado y sus registros antes de considerar completada la acción. Consulta Verificación del despliegue y registros y métricas.