Skip to main content
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.

Utilice la API de gestión de red

PDF

Puede realizar tareas de administración del sistema utilizando la API REST de administración de cuadrícula en lugar de la interfaz de usuario de Grid Manager. Por ejemplo, es posible que desee utilizar la API para automatizar operaciones o crear múltiples entidades, como usuarios, más rápidamente.

Recursos de alto nivel

La API de administración de red proporciona los siguientes recursos de nivel superior:

  • /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 pertenecen a un grupo LDAP local o federado para una cuenta de inquilino. Para obtener más información, consulte "Utilice 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 puntos finales privados de StorageGRID también ignoran la versión API de la solicitud.

Emitir solicitudes de API

La API de administración de red utiliza la plataforma API de código abierto Swagger. Swagger proporciona una interfaz de usuario intuitiva que permite a los desarrolladores y no desarrolladores realizar operaciones en tiempo real en StorageGRID con la API.

La interfaz de usuario de Swagger proporciona detalles completos y documentación para cada operación de API.

Antes de empezar
Precaución Cualquier operación de API que realice utilizando la página web de Documentación de API son operaciones en vivo. Tenga cuidado de no crear, actualizar o eliminar datos de configuración u otros datos por error.
Pasos

  1. Desde el encabezado de Grid Manager, seleccione el ícono de ayuda y seleccione Documentación de API.

    Menú de ayuda

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

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

  3. Seleccione la operación deseada.

    Cuando expande una operación de API, puede ver las acciones HTTP disponibles, como GET, PUT, UPDATE y DELETE.

  4. Seleccione una acción HTTP para ver los detalles de la solicitud, incluida la URL del punto final, una lista de parámetros obligatorios u opcionales, un ejemplo del cuerpo de la solicitud (cuando sea necesario) y las posibles respuestas.

    Ejemplo de Swagger UI

  5. Determinar si la solicitud requiere parámetros adicionales, como un ID de grupo o usuario. Luego, obtenga estos valores. Es posible que primero debas emitir una solicitud API diferente para obtener la información que necesitas.

  6. Determina si necesitas modificar el cuerpo de la solicitud de ejemplo. Si es así, puede seleccionar Modelo para conocer los requisitos de cada campo.

  7. Seleccione Probarlo.

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

  9. Seleccione Ejecutar.

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