Skip to main content
Hay disponible una nueva versión de este producto.
Se proporciona el idioma español mediante traducción automática para su comodidad. En caso de alguna inconsistencia, el inglés precede al español.

Conoce la API de gestión de inquilinos de StorageGRID

PDF

Puedes realizar tareas de administración de sistemas utilizando la API de REST de administración de inquilinos en lugar de la interfaz de usuario de Tenant Manager. Por ejemplo, es posible que quieras usar la API para automatizar operaciones o para crear varias entidades, como usuarios, de forma más rápida.

La API de gestión de inquilinos:

  • Utiliza la plataforma de API de código abierto Swagger. Swagger ofrece una interfaz de usuario intuitiva que permite tanto a desarrolladores como a usuarios sin conocimientos de programación interactuar con la API. La interfaz de usuario de Swagger proporciona información detallada y documentación completa sobre cada operación de la API.

  • Utiliza "${post_edited_translations.segment}".

Para acceder a la documentación de Swagger de la API de gestión de inquilinos:

  1. Inicia sesión en Tenant Manager.

  2. En la parte superior de Tenant Manager, selecciona el icono de ayuda y selecciona API documentation.

${post_edited_translations.segment}

La API de gestión de inquilinos organiza las operaciones de la API disponibles en las siguientes secciones:

  • cuenta: Operaciones en la cuenta del inquilino actual, incluyendo obtener información sobre el uso del almacenamiento.

  • auth: Operaciones para realizar la autenticación de la sesión del usuario.

    La API de gestión de inquilinos es compatible con el esquema de autenticación Bearer Token. Para que un inquilino inicie sesión, debes proporcionar un nombre de usuario, una contraseña y un accountId en el cuerpo JSON de la solicitud de autenticación (es decir, POST /api/v3/authorize). Si el usuario se autentica correctamente, se devuelve un token de seguridad. Este token debe proporcionarse en el encabezado de las solicitudes de API posteriores ("Authorization: Bearer token").

    Para obtener información sobre cómo mejorar la seguridad de autenticación, consulta "Protégete contra la falsificación de solicitudes entre sitios".

    Nota Si el inicio de sesión único (SSO) está habilitado para el sistema StorageGRID, debes realizar pasos diferentes para autenticarte. Consulta "Instrucciones para usar la API de administración de Grid".

  • config: Operaciones relacionadas con el lanzamiento del producto y las versiones de la Tenant Management API. Puedes consultar la versión de lanzamiento del producto y las versiones principales de la API compatibles con dicho lanzamiento.

  • contenedores: Operaciones en buckets de S3.

  • ${post_edited_translations.segment}

  • puntos finales: Operaciones para gestionar un punto final. Los puntos finales permiten que un bucket de S3 utilice un servicio externo para la replicación de StorageGRID CloudMirror, notificaciones o integración de búsqueda.

  • grid-federation-connections: Operaciones en conexiones de federación de grid y replicación entre grids.

  • grupos: Operaciones para gestionar grupos de inquilinos locales y para recuperar grupos de inquilinos federados desde una fuente de identidad externa.

  • fuente-de-identidad: Operaciones para configurar una fuente de identidad externa y para sincronizar manualmente la información de grupos y usuarios federados.

  • ilm: Operaciones sobre la configuración de la gestión del ciclo de vida de la información (ILM).

  • regiones: Operaciones para determinar qué regiones se han configurado para el sistema StorageGRID.

  • s3: Operaciones para gestionar las claves de acceso a S3 de los usuarios del inquilino.

  • s3-object-lock: Operaciones sobre la configuración global de S3 Object Lock, usadas para admitir el cumplimiento normativo.

  • Usuarios: Operaciones para ver y gestionar usuarios de inquilinos.

Detalles de la operación

Al desplegar cada operación de la API, podrás ver su acción HTTP, la URL del endpoint, una lista de los parámetros obligatorios u opcionales, un ejemplo del cuerpo de la solicitud (cuando sea necesario) y las posibles respuestas.

Ejemplo que muestra la operación GET groups en la API de Swagger

Realizar solicitudes a la API

Precaución Cualquier operación de la API que realices a través de la página web de la documentación de la API es una operación en tiempo real. Ten cuidado de no crear, actualizar ni eliminar por error datos de configuración u otros datos.
Pasos

  1. Selecciona la acción HTTP para ver los detalles de la solicitud.

  2. Comprueba si la solicitud requiere parámetros adicionales, como un ID de grupo o de usuario. Luego, obtén estos valores. Puede que primero tengas que enviar otra solicitud a la API para obtener la información que necesitas.

  3. Comprueba si es necesario modificar el cuerpo de la solicitud de ejemplo. Si es así, puedes seleccionar Modelo para conocer los requisitos de cada campo.

  4. ${post_edited_translations.segment}

  5. Introduce los parámetros necesarios o modifica el cuerpo de la solicitud según sea necesario.

  6. Selecciona Ejecutar.

  7. Revisa el código de respuesta para determinar si la solicitud fue exitosa.