Esta página se aplica a Apigee, pero no a Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
Advanced API Security supervisa tus APIs de forma continua para protegerlas de amenazas de seguridad, incluidos los ataques de clientes maliciosos y el abuso. Advanced API Security analiza el tráfico de tu API para identificar solicitudes sospechosas a la API y proporciona herramientas que pueden bloquearlas o marcarlas. Además, Advanced API Security evalúa tus configuraciones de API para garantizar que cumplan con los estándares de seguridad y te brinda recomendaciones para mejorarlas si es necesario.
Si eres cliente de pago por uso, Advanced API Security está disponible como un complemento pago. En este tema, se describe cómo habilitar y administrar el complemento de Advanced API Security para entornos de pago por uso. Si deseas obtener más información para usar Advanced API Security después de habilitar el complemento en tus entornos de Apigee, consulta Descripción general de la Advanced API Security.
Disponibilidad
Advanced API Security está disponible como una función complementaria de complemento de pago que se administra para cada entorno de Apigee en tu implementación de Apigee. El complemento se puede habilitar en cualquier entorno intermedio o integral de Apigee. No puedes habilitar y usar Advanced API Security en entornos de Base. Para obtener más detalles sobre las capacidades del entorno de Apigee, consulta Comparación de los tipos de entornos.
Roles y permisos requeridos
Para obtener los permisos que necesitas a fin de administrar el complemento Advanced API Security, pídele a tu administrador que te otorgue el rol de IAM de administrador del entorno de Apigee (apigee.environment.admin) en el proyecto.
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
Este rol predefinido contiene los permisos necesarios para administrar el complemento Advanced API Security. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:
Permisos necesarios
Se requieren los siguientes permisos para administrar el complemento Advanced API Security:
-
apigee.addonsconfig.get -
apigee.addonsconfig.update
También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.
Después de habilitar el complemento, es posible que se requieran funciones adicionales para realizar tareas con Advanced API Security. Para obtener más información, consulta los Roles requeridos.
Habilita el complemento Advanced API Security
Puedes habilitar el complemento Advanced API Security para un entorno Intermedio o Integral de Apigee mediante la IU de Apigee en la consola de Google Cloud o usando la API, como se describe en las siguientes secciones.
Apigee en la consola de Google Cloud
Para habilitar el complemento de Advanced API Security en la consola de Google Cloud, sigue estos pasos:
- Abre la página Apigee en la consola.
- Selecciona el proyecto con la organización de pago por uso y los entornos que deseas administrar.
- Selecciona Complementos > Advanced API Security para abrir la página Complemento Advanced API Security.
- En el panel Administrar complemento Advanced API Security, selecciona la casilla de verificación del entorno (o los entornos) en el que deseas habilitar el complemento.
- Haz clic en habilitar los seleccionados.
- Cuando se complete la habilitación para los entornos seleccionados, el estado del entorno mostrará habilitado.
- Selecciona Advanced API Security para ver las opciones de página de usar tus datos de seguridad, incluido Evaluación de riesgos, Detección de abuso, Informes de seguridad y Acciones de seguridad. Los datos de Advanced API Security pueden tardar hasta 10 minutos en mostrarse.
API de Apigee
Para habilitar el complemento Advanced API Security mediante la API de Apigee, ingresa el siguiente comando:
curl -X POST \
https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
-H "Authorization: Bearer $token" \
-H "Content-type: application/json" \
-d '{"apiSecurityEnabled":true}'En el ejemplo anterior, se ilustra lo siguiente:
- ORG_NAME es el nombre de la organización de pago por uso de Apigee en la que deseas inhabilitar Advanced API Security en entornos aptos.
- ENV_NAME es el nombre del entorno de Apigee en el que deseas habilitar el complemento Advanced API Security.
Una vez que se complete la habilitación, haz clic en Advanced API Security para ver las opciones de página para usar tus datos de seguridad, incluido Evaluación de riesgos, Detección de abuso, Informes de seguridad y Acciones de seguridad. Pueden transcurrir hasta 10 minutos para que se muestren los datos de Advanced API Security en la IU, o bien que estén disponibles a través de una llamada a la API.
El proceso de habilitación del complemento Advanced API Security puede tardar hasta 15 minutos. Una vez habilitado, los datos de seguridad del entorno se conservan durante 14 meses. Puedes acceder a los datos históricos del entorno desde las páginas de Advanced API Security en la consola, siempre y cuando el complemento esté habilitado.
La facturación por el uso del complemento Advanced API Security comienza una vez que comienza la habilitación del complemento.
Inhabilita el complemento Advanced API Security
Puedes inhabilitar el complemento Advanced API Security para un entorno de Apigee intermedio o integral mediante la IU de Apigee en la consola de Google Cloud o mediante la API, como se describe en las siguientes secciones.
Apigee en la consola de Cloud
Para inhabilitar el complemento Advanced API Security en la consola de Google Cloud, sigue estos pasos:
- Abre la página Apigee en la consola.
- Selecciona el proyecto con la organización de pago por uso y los entornos que deseas administrar.
- Selecciona Complementos > Advanced API Security para abrir la página Complemento Advanced API Security.
- En el panel Administrar complemento Advanced API Security, selecciona la casilla de verificación del entorno (o los entornos) en el que deseas inhabilitar el complemento.
- Haz clic en Inhabilitar los seleccionados.
- Cuando se complete la inhabilitación, el Estado mostrará Inhabilitado para cada entorno.
API de Apigee
Para inhabilitar el complemento Advanced API Security mediante la API de Apigee, ingresa el siguiente comando:
curl -X POST \
https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
-H "Authorization: Bearer $token" \
-H "Content-type: application/json" \
-d '{"apiSecurityEnabled":false}'En el ejemplo anterior, se ilustra lo siguiente:
- ORG_NAME es el nombre de la organización de pago por uso de Apigee en la que deseas inhabilitar Advanced API Security en entornos aptos.
- ENV_NAME es el nombre del entorno de Apigee en el que deseas inhabilitar el complemento Advanced API Security.
Visualiza el estado del complemento Advanced API Security en un entorno
Puedes verificar el estado del complemento Advanced API Security para un entorno de Apigee intermedio o integral mediante la IU de Apigee en la consola de Google Cloud o mediante la API, como se describe en las siguientes secciones.
Apigee en la consola de Google Cloud
Para ver el estado del complemento de Advanced API Security en un entorno que usa la consola de Google Cloud, sigue estos pasos:
- Abre la página Apigee en la consola.
- Selecciona el proyecto con la organización de pago por uso y los entornos que deseas administrar.
- Selecciona Complementos > Advanced API Security para abrir la página Complemento Advanced API Security.
- En el panel Administrar complemento Advanced API Security, se muestra una lista de entornos.
- En la columna de estado, puedes ver si el complemento está Habilitado o Inhabilitado en cada entorno intermedio o integral. Los entornos base no muestran ninguno de estos estados.
API de Apigee
Para ver el estado del complemento Advanced API Security en un entorno con la API de Apigee, ingresa el siguiente comando:
curl -X GET \
https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
-H "Authorization: Bearer $token" \
-H "Content-type: application/json" En el ejemplo anterior, se ilustra lo siguiente:
- ORG_NAME es el nombre de la organización de pago por uso de Apigee.
- ENV_NAME es el nombre del entorno de Apigee.
La respuesta devuelve un objeto ApiSecurityConfig que representa el estado actual del complemento.
Administra los datos de Advanced API Security
Una vez que el complemento Advanced API Security esté habilitado para un entorno, los datos de seguridad del entorno se conservarán durante 14 meses. Puedes acceder a los informes de seguridad generados anteriormente para el entorno desde la página Informes de seguridad en la consola, pero no se pueden crear informes nuevos.
Si inhabilitas el complemento Advanced API Security en un entorno, los datos de seguridad del entorno se borran después de 30 días. Si vuelves a habilitar el complemento en el mismo entorno dentro de los 30 días posteriores a la inhabilitación, puedes recuperar el acceso a los datos de seguridad del entorno durante el período de retención de 14 meses. No se restablecen los datos si el complemento se vuelve a habilitar para el entorno después de 30 días.
Si deseas conservar los informes de seguridad para cualquier entorno más allá del período de retención de 14 meses, te recomendamos exportar y guardar tus datos en otra ubicación. También puedes exportar los datos de Advanced API Security antes de inhabilitar el complemento o dentro del período de 30 días después de la inhabilitación. Puedes exportar tus informes de seguridad con el botón Exportar en la página Informes de seguridad de la consola o descargar un informe con la API de informes de seguridad