> ## 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 regiones (IAM heredado)
> Endpoint de compatibilidad heredada. Los nuevos clientes deben usar catalog.basaltic.sh/v1/regions. Este extremo conserva los CRN de la región con espacio de nombres de IAM y su forma de respuesta existente. Enumera todas las regiones publicadas. Este punto final es público y no requiere autenticación. Devuelve todas las regiones con su estado de disponibilidad.
Debido a que no requiere credenciales, las solicitudes están limitadas por la velocidad por IP del cliente.
Requiere **sin acción de IAM**. El acceso se decide por las propias reglas del punto final en lugar de por una política. Consulte la descripción anterior.
## OpenAPI
````yaml /es/api-reference/specs/iam.yaml get /v1/regions
openapi: 3.0.3
info:
title: API de Basaltic IAM
version: 1.0.0
description: >
Administración de identidad y acceso de cuentas: cuentas de servicio, roles,
directivas de cuenta y sesiones temporales con ámbito de cuenta. La
autenticación y el inicio de sesión personal permanecen en IAM. Las
organizaciones, cuentas, usuarios, grupos y directivas de organización se
administran mediante la API de Workspace.
Las funciones y las políticas personalizadas pertenecen a la cuenta
seleccionada. Sus CRN globales usan una región vacía y el identificador de
la cuenta propietaria.Las entradas de relación se clasifican una vez
como CRN, UUID o nombre, sin fallback de sintaxis.
AssumeRole resuelve la cuenta propietaria del rol de destino. El llamador
necesita permiso de origen y el rol de destino debe confiar en el llamador;
la sesión resultante usa solo los permisos del rol de destino, sujeto a
límites y restricciones de sesión.
contact:
name: Basaltic Support
email: ping@basaltic.sh
license:
name: Proprietary
url: https://basaltic.sh/terms
servers:
- url: https://iam.basaltic.sh
description: Endpoint de API global
security:
- BearerAuth: []
paths:
/v1/regions:
get:
tags:
- Regions
summary: Listar regiones (IAM heredado)
description: >
Endpoint de compatibilidad heredada. Los nuevos clientes deben usar
catalog.basaltic.sh/v1/regions. Este extremo conserva los CRN de la
región con espacio de nombres de IAM y su forma de respuesta existente.
Enumera todas las regiones publicadas. Este punto final es público y no
requiere autenticación. Devuelve todas las regiones con su estado de
disponibilidad.
Debido a que no requiere credenciales, las solicitudes están limitadas
por la velocidad por IP del cliente.
operationId: listRegions
parameters:
- $ref: '#/components/parameters/IAMNameFilter'
- $ref: '#/components/parameters/IAMCRNFilter'
responses:
'200':
description: Lista de regiones
content:
application/json:
schema:
type: object
required:
- regions
- default
properties:
regions:
type: array
description: Lista de regiones disponibles
items:
$ref: '#/components/schemas/Region'
default:
type: string
description: The default region code
example: sa-saopaulo-1
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
deprecated: true
security: []
components:
parameters:
IAMNameFilter:
name: name
in: query
allowEmptyValue: true
description: >-
Nombre exacto del recurso, combinado con crn usando AND antes de la
paginación. Los valores vacíos son filtros. Los recursos sin nombre
nunca coinciden.
schema:
type: string
IAMCRNFilter:
name: crn
in: query
allowEmptyValue: true
description: >-
CRN exacto devuelto, combinado con el nombre usando AND antes de la
paginación. Los CRN mal formados o vacíos devuelven 400; los CRN válidos
no coincidentes o extranjeros devuelven una página vacía. Los recursos
sin un CRN nunca coinciden. Los CRN de ámbito de organización usan la
organización autenticada.
schema:
type: string
schemas:
Region:
type: object
required:
- crn
- code
- name
- location
- country_code
- available
- coming_soon
properties:
crn:
type: string
description: >-
Identidad de región global de propiedad de la plataforma, utilizando
el código de región inmutable.
example: crn:iam::platform:region/sa-saopaulo-1
code:
type: string
description: Código de región único utilizado en llamadas a API y CRN
example: sa-saopaulo-1
name:
type: string
description: Nombre de región legible por humanos
example: São Paulo 1
location:
type: string
description: Ubicación geográfica de la región
example: São Paulo, Brazil
country_code:
type: string
description: >-
Código de país ISO 3166-1 alfa-2 (utilizado para mostrar la bandera
en la interfaz de usuario)
example: BR
minLength: 2
maxLength: 2
available:
type: boolean
description: Si la región está disponible actualmente para su uso
example: true
coming_soon:
type: boolean
description: Si la región está anunciada pero aún no está disponible
example: false
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
responses:
TooManyRequests:
description: >
Límite de velocidad excedido. El presupuesto es una ventana fija contada
por punto final y por llamador (el principal autenticado cuando la
solicitud lleva credenciales, la IP del cliente de lo contrario), de
modo que un punto final con restricción nunca gasta el presupuesto de
otro, y un inquilino nunca gasta el de otro.
Espere `Retry-After` segundos, luego vuelva a intentarlo. Los
encabezados `X-RateLimit-*` también se basan en las respuestas exitosas
de un punto final con límite de velocidad, por lo que un cliente puede
acelerarse en lugar de descubrir el límite al alcanzarlo.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: RATE_LIMITED
message: Too many requests, please try again later
request_id: 550e8400-e29b-41d4-a716-446655440000
headers:
Retry-After:
description: Segundos para esperar antes de volver a intentarlo. Nunca a cero.
required: true
schema:
type: integer
minimum: 1
example: 42
X-RateLimit-Limit:
description: Solicitudes permitidas por ventana en este punto final.
required: true
schema:
type: integer
minimum: 1
example: 5
X-RateLimit-Remaining:
description: Solicitudes que quedan en la ventana actual. Siempre 0 en un 429.
required: true
schema:
type: integer
minimum: 0
example: 0
X-RateLimit-Reset:
description: >-
Segundos hasta que la ventana se reinicia: una duración, no una
marca de tiempo, por lo que no necesita ningún acuerdo de reloj
entre el cliente y el servidor.
required: true
schema:
type: integer
minimum: 1
example: 42
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.