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.

Usa la API de gestión de StorageGRID Grid

PDF

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

Recursos de primer nivel

La API de gestión de la red ofrece los siguientes recursos de primer nivel:

  • /grid: El acceso está restringido a los usuarios de Grid Manager y se basa en los permisos de grupo configurados.

  • /org: El acceso está restringido a los usuarios que pertenezcan a un grupo LDAP local o federado de una cuenta de inquilino. Para obtener más información, consulta "Utiliza una cuenta de inquilino".

  • /private: El acceso está restringido a los usuarios de Grid Manager y se basa en los permisos de grupo configurados. Las API privadas están sujetas a cambios sin previo aviso. Los endpoints privados de StorageGRID también ignoran la versión de la API de la solicitud.

Realizar solicitudes a la API

La API de gestión de la red 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 realizar operaciones en tiempo real en StorageGRID mediante la API.

La interfaz de usuario de Swagger ofrece información completa y documentación detallada para cada operación de la API.

Antes de empezar
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. En la barra de encabezado de Grid Manager, selecciona el icono de ayuda y selecciona Documentación de la API.

    Menú de ayuda

  2. Para realizar una operación con la API privada, selecciona Ir a la documentación de la API privada en la página StorageGRID Management API.

    Las API privadas están sujetas a cambios sin previo aviso. Los puntos finales privados de StorageGRID también ignoran la versión de la API de la solicitud.

  3. Selecciona la operación que desees.

    Al desplegar una operación de la API, podrás ver las acciones HTTP disponibles, como GET, PUT, UPDATE y DELETE.

  4. Selecciona una acción HTTP para ver los detalles de la solicitud, incluyendo 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 de Swagger UI

  5. 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.

  6. 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.

  7. ${post_edited_translations.segment}

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

  9. Selecciona Ejecutar.

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