Esta página se aplica a Apigee y Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
Los siguientes conceptos son ideas habituales que tienen un significado único en Apigee.
A
- Ruta base de la API y recursos
- Una API se compone de una ruta base y un conjunto de recursos (también conocidos como rutas de recursos). Para cada API, se define una sola URL raíz (también llamada ruta base) y varias rutas de recursos. Una API es un conjunto de URIs que comparten una ruta base común. Para que te resulte más fácil gestionar tus APIs, Apigee aumenta estos URIs sin formato con nombres y descripciones visibles.
- Consumidor de la API
- Sinónimo de desarrollador de aplicaciones, que usa las APIs creadas por un proveedor de APIs.
- Desarrollador de APIs
- Ingeniero de software de una organización proveedora de APIs que crea APIs. Los desarrolladores de aplicaciones (consumidores de APIs) usan esas APIs para crear aplicaciones.
- Producto de API
- Conjunto de recursos de API (URIs) combinados con un plan de servicio y presentados a los desarrolladores como un paquete. El producto de API también puede incluir algunos metadatos específicos de su empresa para monitorización o analíticas. Se pueden monetizar uno o varios recursos incluyéndolos en un producto de API, que se puede empaquetar en un paquete de API para monetizarlo.
- Proveedor de APIs
- Un proveedor de APIs crea APIs (con Apigee) para que las usen los consumidores de APIs (desarrolladores de aplicaciones).
- Proxy de API
- Un proxy que actúa como fachada de tu API. En lugar de llamar a tu API, los desarrolladores empiezan a llamar a la nueva API generada por Apigee. Esta fachada desacopla tu interfaz pública de tu API de backend, lo que protege a los desarrolladores de los cambios en el backend y te permite innovar en el perímetro sin que ello afecte a tus equipos de desarrollo internos. Mientras haces cambios en el backend, los desarrolladores siguen llamando a la misma API sin interrupciones. En situaciones más avanzadas, Apigee te permite exponer varias interfaces a la misma API, lo que te da libertad para personalizar la firma de una API y satisfacer las necesidades de varios nichos de desarrolladores al mismo tiempo.
- APIs de Apigee
- Los endpoints que puedes usar para configurar entornos, organizaciones, proxies de API y otros servicios híbridos.
- desarrollador de aplicaciones
- Los desarrolladores de aplicaciones registran sus aplicaciones con un proveedor de APIs, que es la forma en que los desarrolladores de aplicaciones obtienen las claves de API que necesitan para llamar a los proxies de APIs del proveedor.
- Aplicaciones de
- Tus desarrolladores usan aplicaciones para acceder a los recursos de tus productos de API. Cuando creas una aplicación, seleccionas el producto de API que quieres incluir y Apigee genera una clave. Cada aplicación tiene una sola clave que proporciona acceso a varios productos de API. Las aplicaciones te permiten controlar quién puede acceder a tus recursos. Puedes controlar quién tiene acceso a tus productos de API revocando y actualizando la clave de una aplicación. Además, puedes controlar el acceso a los paquetes de recursos revocando o eliminando el acceso a los productos de una aplicación.
B
- detalles del saldo
- En el caso de los desarrolladores con prepago, el saldo de su cuenta.
C
- Cassandra
(Solo Apigee hybrid) El repositorio de datos de tiempo de ejecución que almacena las configuraciones de las aplicaciones, los contadores de cuota distribuidos, las claves de API y los tokens de OAuth de las aplicaciones que se ejecutan en la pasarela.
Se trata de un StatefulSet que requiere muchos recursos y debe estar en un nodo de trabajador independiente del procesador de mensajes.
Para obtener más información, consulta Información sobre el plano de ejecución.
- Infraestructura (o plano) de gestión centralizada
- Consulta plano de gestión.
- imagen [contenedorizada]
- Consulta la imagen.
- Plano de control
- Consulta plano de gestión.
D
- deploy
En Apigee, despliega un proxy de API en un entorno para que los clientes de la aplicación puedan acceder a él a través de Internet, ya sea de forma pública o privada, en función de la configuración de tu red.
- desarrollador
- Un desarrollador hace referencia a un rol que puede desempeñar un usuario de Apigee.
Hay dos tipos de desarrolladores en Apigee:
- Desarrolladores de proxies de API: crean los proxies de API y aplican políticas.
- Desarrolladores de aplicaciones: crean aplicaciones que consumen proxies de API.
- Plan de tarifas por categoría de desarrollador
- Un plan de tarifas que se aplica a todos los desarrolladores de una categoría específica y que pueden comprar todos los desarrolladores de esa categoría.
- plan de tarifas para desarrolladores
- Un plan de tarifas que se aplica a un desarrollador específico y que solo puede comprar ese desarrollador.
E
- entorno
Un entorno de Apigee es un entorno de software aislado dentro de una organización en el que se despliegan proxies de API. El entorno se puede escalar para satisfacer las demandas de los proxies implementados en él. Puedes crear varios entornos en una organización.
- Grupo de entornos
-
Un grupo de entornos es un grupo de entornos de Apigee con uno o varios nombres de host. El nombre de host forma parte de la URL que se usa para llamar a los proxies de API desplegados en cualquier entorno del grupo de entornos.
- límite explícito
- Consulta Límite personalizado.
G
- GCR
- Google Container Repository.
- GKE
- Google Kubernetes Engine. Un entorno gestionado por Google y listo para la fase de producción que se ha diseñado para desplegar aplicaciones en contenedores en Kubernetes. GKE te permite empezar a usar Kubernetes en un abrir y cerrar de ojos, ya que no tienes que instalar, gestionar ni controlar tus propios clústeres de Kubernetes.
I
- repositorio de imágenes
- Un grupo de imágenes de contenedor compartidas.
- Límite implícito
- Un límite (como el límite del saldo prepago de un desarrollador) establecido por la monetización.
- Ingress o controlador de Ingress
- Una aplicación en contenedores que dirige el tráfico desde fuera del clúster a los servicios que se encuentran en él.
K
- KMS
- Servicio de gestión de claves. Almacena, mantiene y presenta claves y tokens de OAuth para cifrar y descifrar el tráfico. Apigee KMS gestiona las claves de las aplicaciones, los desarrolladores y los productos de API.
- KVM
- Mapa de clave-valor. Una colección personalizada de pares de cadenas clave/valor que está cifrada o sin cifrar. Para obtener más información, consulta Usar mapas de clave-valor.
- Máquina de administración de Kubernetes
- Tu máquina local, que usas para ejecutar comandos en tu clúster de Kubernetes. Esta máquina suele ser un ordenador de sobremesa que tiene acceso a tus máquinas virtuales de Kubernetes.
M
- Plano de gestión
- Los servicios centrales alojados en Google que se comunican con el plano de tiempo de ejecución a través de cuentas de servicio.
- MART
La API de datos de tiempo de ejecución interactúa con el almacén de datos de tiempo de ejecución local (Cassandra). Actúa como proveedor de APIs para la API pública de Apigee, que permite acceder a los datos del tiempo de ejecución y gestionarlos.
MART es una aplicación sin estado, al igual que los procesadores de mensajes. Es una aplicación en contenedores de Kubernetes.
Para obtener más información, consulta Información sobre el plano de ejecución.
- nodo maestro
- Término de Kubernetes para un nodo que incluye apiserver, cloud-controller-manager (CCM), scheduler y kube-controller-manager.
- Message Processor
-
(Solo Apigee hybrid) El procesador de mensajes evalúa una solicitud entrante, ejecuta las políticas de Apigee y llama a los sistemas backend y a otros sistemas para recuperar datos. Una vez que se han recibido esas respuestas, el procesador de mensajes da formato a una respuesta y la devuelve al cliente.
El MP es un Deployment de Kubernetes. Se configura para un solo entorno de Apigee y apunta a un subdirectorio de ámbito dentro del sistema de archivos compartido al que el sincronizador proporciona datos.
Un MP requiere muchos recursos y debe estar en un nodo de trabajo independiente de Cassandra.
Para obtener más información, consulta Información sobre el plano de ejecución.
- monetización
- Un componente de Apigee que proporciona una forma sencilla y flexible de monetizar productos de API.
- cantidad mensual utilizada
- El uso total de un desarrollador durante un mes determinado, que incluye la tarifa de configuración + la tarifa de transacción + la tarifa periódica.
- Pagos mensuales
- Los pagos periódicos que realiza un desarrollador en función de los planes que haya comprado. Los planes de tarifas pueden tener una cuota periódica que se cobra a los desarrolladores todos los meses, independientemente del uso.
N
- espacio de nombres
- Clústeres virtuales que se usan para dividir los recursos del clúster. Los espacios de nombres son para clústeres más grandes con muchos usuarios. Los clústeres más pequeños con solo decenas de usuarios no suelen necesitar espacios de nombres.
O
- abrir ajuste
- Un ajuste que aún no se ha aplicado en los documentos de facturación publicados.
- mes de facturación abierto
- Un mes natural completo del que no se han publicado los documentos de facturación finales.
- Kubernetes de código abierto
- La implementación de referencia de Kubernetes. Consulta Kubernetes. El tiempo de ejecución de Apigee Hybrid se ejecuta en Kubernetes de código abierto y en versiones basadas en código abierto de Kubernetes que cumplen los requisitos de la CNCF.
- organización
Contenedor de todas las entidades de una cuenta de Apigee, incluidas las proxies de API, los productos de API, los paquetes de API, las aplicaciones y los desarrolladores. En este documento se utilizan indistintamente los términos organización de Apigee y organización con funciones híbridas.
Para instalar y usar Apigee o Apigee hybrid, debes tener una organización de Apigee vinculada a un proyecto de Google Cloud. Esto se hace al crear la organización en un proceso conocido como aprovisionamiento.
Una organización de Apigee no es lo mismo que una organización de Google Cloud. Cuando exista la posibilidad de que haya ambigüedad, este documento debe especificar que la organización es una organización de Apigee.
Para obtener más información, consulta Tipos de organización.
P
- pod
- Un pod es el componente básico de Kubernetes: la unidad más pequeña y sencilla del modelo de objetos de Kubernetes que puedes crear o desplegar. Un pod representa un proceso en ejecución en tu clúster.
- saldo de prepago
- Cantidad de dinero disponible para que un desarrollador prepago pague por adelantado los paquetes de APIs.
- desarrollador prepago
- Desarrollador que paga por adelantado el uso de un producto de API. Los fondos se deducen del saldo de un desarrollador con prepago cuando se usa el producto de API. El desarrollador debe mantener un saldo prepago suficiente para comprar el producto de API. El proveedor de la API asigna a los desarrolladores el estado de prepago o pospago.
- Política de
- Paso de procesamiento que se ejecuta como una unidad de lógica atómica y reutilizable dentro de un flujo de API. Las políticas típicas incluyen el enrutamiento de solicitudes al endpoint adecuado, la transformación de un formato de mensaje, la aplicación del control de acceso, la llamada a servicios remotos para obtener información adicional, el enmascaramiento de datos sensibles para usuarios externos, el examen del contenido de los mensajes para detectar posibles amenazas, el almacenamiento en caché de respuestas comunes para mejorar el rendimiento, etc. Las políticas se pueden ejecutar de forma condicional en función del contenido o el contexto de un mensaje de solicitud o respuesta. Por ejemplo, se puede ejecutar una política de transformación para personalizar un formato de respuesta si el mensaje de solicitud se ha enviado desde un smartphone.
- desarrollador de pospago
- Un desarrollador al que se le factura mensualmente por el uso de productos de API. El desarrollador paga por el uso de los productos de API según los términos de pago definidos en los planes de precios. El proveedor de la API asigna a los desarrolladores el estado de pospago o prepago.
- proxy
- También proxy de API. Un proxy de API es una capa de abstracción que actúa como interfaz para las APIs de tu servicio de backend y proporciona funciones de valor añadido, como seguridad, limitación de frecuencia, cuotas, analíticas y más.
- endpoint proxy
- Un endpoint de proxy define la forma en que tu proxy de API interactúa con las aplicaciones cliente. El endpoint del proxy se configura con una ruta base
que forma parte de la URL a la que responde el proxy de API.
La URL tiene el formato
https://hostname/basepath/pathsuffixes. Consulta Crear un proxy de API.
R
- Plan de tarifas
- Una especificación de las tarifas, otros cargos y el reparto de ingresos por el uso de los productos de API que se ofrecen en un paquete de APIs monetizado.
- controlador de replicación
- Reprograma los pods y gestiona la reparación automática de los pods.
- recurso, ruta de recurso
- Un concepto de RESTful, una ruta de recurso es un identificador uniforme de recurso (URI) que identifica la ruta de red a un recurso determinado.
- revisión
- Paquete numerado y con control de versiones de configuración y políticas empaquetado en un proxy de API. Este término se distingue de versión, que es la interfaz de la API orientada a los desarrolladores. Consulta la sección "Versión" más abajo.
- plano del entorno de ejecución
Los servicios de Apigee hybrid que gestionas en tu propio clúster de Kubernetes se encuentran en el plano de entorno de ejecución. Estos servicios se comunican con el plano de gestión a través de cuentas de servicio.
Incluye MART, Synchronizer, Message Processors, Cassandra y otros componentes.
Para obtener más información, consulta Información sobre el plano de ejecución.
- instancia de tiempo de ejecución
- Apigee se puede configurar con varias instancias de tiempo de ejecución, una por región geográfica. Se pueden adjuntar uno o varios entornos a una instancia de tiempo de ejecución, lo que proporciona alta disponibilidad a los proxies de API en todas las regiones.
- servicio
Término general para las aplicaciones en contenedores que se ejecutan en tu clúster de Kubernetes en el plano de ejecución. Entre estos servicios se incluyen MART, Synchronizer, Message Processors y Cassandra.
Para obtener más información, consulta Información sobre el plano de ejecución.
- nodo con estado
- Un nodo de clúster que requiere almacenamiento persistente para mantener el estado. Consulta Configurar grupos de nodos dedicados.
- nodo sin estado
- Un nodo de clúster que no requiere almacenamiento persistente. Consulta Configurar grupos de nodos dedicados.
- Sincronizador
Un servicio de plano de tiempo de ejecución que sondea el plano de gestión para obtener la configuración de la implementación y los eventos de cada entorno. Descarga los metadatos necesarios sobre los proxies implementados, los archivos de configuración de proxy y más en el plano de tiempo de ejecución.
El sincronizador almacena su información en un sistema de archivos compartido que lee el procesador de mensajes. Se ejecutará como una aplicación DaemonSet, no tiene tráfico de API en tiempo de ejecución y puede sincronizar datos de varios entornos desde un único proceso o pod de Kubernetes.
Para obtener más información, consulta Información sobre el plano de ejecución.
- endpoint de destino
Un endpoint de destino define la forma en que tu proxy de API interactúa con tus servicios de backend. Configuras el endpoint de destino para que reenvíe las solicitudes al servicio de backend adecuado, lo que incluye definir los ajustes de seguridad, el protocolo HTTP o HTTPS y otra información de conexión. Consulta cómo cambiar el punto de conexión de destino.
- recargar
- Acción que realiza un desarrollador con prepago para añadir fondos al saldo de prepago.
- transaction_success_def" id="transaction_success_def">transaction success La variable de monetización
- , si se usa, indica si una transacción de API está monetizada o no. Esta variable se puede usar para anular el comportamiento predeterminado, que se basa en el código de estado HTTP. Consulta Variables de monetización.
- UAP
Plataforma de analíticas unificada. Un servicio de Apigee en el plano de gestión que procesa los datos de analíticas, depuración y estado de la implementación entrantes, y los pone a tu disposición a través de la interfaz de usuario híbrida de Apigee o de las APIs de Apigee.
Para obtener más información, consulta Recogida de datos de depuración, analíticas y estado de la implementación.
- UDCA
Agente de recogida de datos universal. Un servicio que se ejecuta en el pod de recogida de datos del plano de tiempo de ejecución, que extrae datos de analíticas, depuración y estado de la implementación, y los envía a la UAP.
Para obtener más información, consulta Recogida de datos de depuración, analíticas y estado de la implementación.
- Versión de
- La versión de la interfaz de la API orientada a desarrolladores. Por ejemplo,
pivotaltracker.com/services/v3, or api.enterprise.apigee.com/v1. Este término se distingue derevision, que es el paquete numerado y controlado por versiones de configuración y políticas empaquetado en un proxy de API. En resumen, las interfaces de las APIs tienen versiones, mientras que los proxies de APIs tienen revisiones. - volumen
- Almacenamiento compartido que pueden usar todas las aplicaciones contenedorizadas de un pod.