Esta página se ha traducido con Cloud Translation API.

Referencia de recursos del operador de gestión de APIs de Apigee para Kubernetes

Esta página se aplica a Apigee, pero no a Apigee Hybrid.

Consulta la documentación de Apigee Edge.

En esta página se hace referencia a cada recurso de Kubernetes compatible con el operador de gestión de APIs de Apigee para Kubernetes. Todos los campos son obligatorios, a menos que se indique que son opcionales.

APIProduct

Campo	Descripción
`apiVersion` Tipo: `string`	`apim.googleapis.com/v1`
`kind` Tipo: `string`	`APIProduct`
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: APIProductSpec	`spec` define el estado deseado de APIProductSet.

APIProductSpec

Campo	Descripción
`name` Tipo: `string`	Nombre del producto de API.
`approvalType` Tipo: `string`	Marca que especifica cómo se aprueban las claves de API para acceder a las APIs definidas por el producto de API. Si se asigna el valor `manual`, la clave de consumidor se genera y se devuelve como `pending`. En este caso, las claves de API no funcionarán hasta que se aprueben explícitamente. Si se asigna el valor `auto`, la clave de cliente se genera y se devuelve como `approved` y se puede usar inmediatamente.
`description` Tipo: `string`	Descripción del producto de la API.
`displayName` Tipo: `string`	Nombre que se muestra en la interfaz de usuario o en el portal para desarrolladores a los desarrolladores que se registran para obtener acceso a la API.
`analytics` Tipo: Analytics	Define si se deben recoger analíticas de las operaciones asociadas a este producto.
`enforcementRefs` Tipo: `Array`	Matriz de recursos EnforcementRef que se aplicará al producto de API.
`attributes` Tipo: `Array`	Matriz de atributos que se pueden usar para ampliar el perfil de producto de API predeterminado con metadatos específicos del cliente.

EnforcementRef

Campo	Descripción
`name` Tipo: `string`	Nombre del recurso de destino.
`kind` Tipo: `string`	`APIMExtensionPolicy`
`group` Tipo: `string`	El APIGroup del operador de gestión de APIs de Apigee, que es `apim.googleapis.com`.
`namespace` Tipo: `string`	(Opcional) El espacio de nombres del referente. Si no se especifica, se infiere el espacio de nombres local.

Atributo

Campo	Descripción
`name` Tipo: `string`	La clave del atributo.
`value` Tipo: `string`	Valor del atributo.

APIOperationSet

Campo	Descripción
`apiVersion` Tipo: `string`	`apim.googleapis.com/v1`
`kind` Tipo: `string`	`APIOperationSet`
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: APIOperationSetSpec	Define el estado deseado de APIOperationSet.

APIOperationSetSpec

Campo	Descripción
`quota` Tipo: Quota	Definición de cuota.
`restOperations` Tipo: `Array`	Matriz de definiciones de RESTOperation.
`apiProductRefs` Tipo: `Array`	Array de recursos APIProductRef o referencias a productos de API en los que se deben aplicar las RESTOperations.

Cuota

Campo	Descripción
`limit` Tipo: `integer`	Número de mensajes de solicitud permitidos por aplicación en el producto de API para los `interval` y `timeUnit` especificados.
`interval` Tipo: `integer`	Intervalo de tiempo durante el que se calcula el número de mensajes de solicitud.
`timeUnit` Tipo: `string`	Unidad de tiempo definida para el intervalo. Los valores válidos son `minute`, `hour`, `day` o `month`.

RESTOperation

Campo	Descripción
`name` Tipo: `string`	El nombre de la operación REST.
`path` Tipo: `string`	En combinación con `methods`, `path` es la ruta HTTP que debe coincidir con una cuota o con un producto de API.
`methods` Tipo: `array`	En combinación con `path`, `methods` es la lista (como `strings`) de los métodos HTTP aplicables que se deben usar para una cuota o un producto de API.

APIProductRef

Campo	Descripción
`name` Tipo: `string`	Nombre del recurso de destino.
`kind` Tipo: `string`	`APIProduct`
`group` Tipo: `string`	El APIGroup del operador de gestión de APIs de Apigee, que es `apim.googleapis.com`.
`namespace` Tipo: `string`	(Opcional) El espacio de nombres del referente. Si no se especifica, se infiere el espacio de nombres local.

APIMExtensionPolicy

Campo	Descripción
`apiVersion` Tipo: `string`	`apim.googleapis.com/v1`
`kind` Tipo: `string`	APIMExtensionPolicy
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: APIMExtensionPolicySpec	Define el estado deseado de APIMExtensionPolicy.

APIMExtensionPolicySpec

Campo	Descripción
`apigeeEnv`	(Opcional) Entorno de Apigee. Si no se proporciona, se crea un nuevo entorno y se adjunta a todas las instancias disponibles. Si se proporciona, este entorno debe asociarse a todas las instancias disponibles al usar un balanceador de carga global externo.
`failOpen` Tipo: `boolean`	Especifica si se debe abrir en caso de fallo cuando no se pueda acceder al tiempo de ejecución de Apigee. Si se asigna el valor `true`, las llamadas al entorno de ejecución de Apigee se tratarán como correctas aunque no se pueda acceder al entorno de ejecución.
`timeout` Tipo: `string`	Especifica el periodo de tiempo de espera antes de que fallen las llamadas al tiempo de ejecución de Apigee, en segundos o milisegundos. Por ejemplo, `10s`.
`targetRef` Tipo: ExtensionServerRef	Identifica la puerta de enlace de Google Kubernetes Engine en la que se debe instalar la extensión.
`location` Tipo: `string`	Identifica la Google Cloud ubicación en la que se aplica APIMExtensionPolicy.
`supportedEvents` Tipo: `List` de eventos	Especifica la lista de eventos del procesador de extensiones enviados a Apigee. Entre ellas, se incluyen las siguientes: `"REQUEST_HEADERS"` `"RESPONSE_HEADERS"` `"REQUEST_BODY"` (vista previa) `"RESPONSE_BODY"` (vista previa) `"REQUEST_TRAILERS"` `"RESPONSE_TRAILERS"`

ExtensionServerRef

Campo	Descripción
`name` Tipo: `string`	Nombre del recurso de destino.
`kind` Tipo: `string`	Especifica el `kind` del recurso de destino, por ejemplo, `Gateway` o `Service`.
`group` Tipo: `string`	El APIGroup del operador de gestión de APIs de Apigee, que es `apim.googleapis.com`.
`namespace` Tipo: `string`	(Opcional) El espacio de nombres del referente. Si no se especifica, se infiere el espacio de nombres local.

ApigeeGatewayPolicy

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	ApigeeGatewayPolicy
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: ApigeeGatewayPolicySpec	Define el estado deseado de ApigeeGatewayPolicy.

ApigeeGatewayPolicySpec

Campo	Descripción
`ref` Tipo: ExtensionServerRef	Hace referencia a la plantilla de APIM creada para controlar las políticas aplicadas a la pasarela de GKE.
`targetRef` Tipo: ExtensionServerRef	Hace referencia a la política de extensión de APIM que debe aplicar esta política de Gateway específica. Hace referencia indirectamente a la puerta de enlace de GKE.
`serviceAccount`	(Opcional) Especifica la cuenta de servicio que se usa para generar tokens de autorización en un proxy de Apigee ProApigee. Google

ApimTemplate

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	ApimTemplate
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: ApimTemplateSpec	Define el estado deseado de ApimTemplate.

ApimTemplateSpec

Campo	Descripción
`templates` Tipo: `list`	Lista de recursos ApimTemplateFlow que especifican las políticas que se van a ejecutar en el flujo de solicitudes.
`apimTemplateRule` Tipo: ExtensionServerRef	Especifica la regla de plantilla de APIM que se debe usar para validar las políticas aplicadas.

ApimTemplateFlow

Campo	Descripción
`policies` Tipo: `list` ConditionalParameterReference	Lista de recursos ConditionalParameterReference que especifican la lista ordenada de políticas que se van a ejecutar como parte del flujo de solicitudes.
`condition` Tipo: `string`	Especifica las condiciones para ejecutar este recurso.

ConditionalParameterReference

Campo	Descripción
`condition` `Type: string`	Especifica las condiciones para ejecutar este recurso.

ApimTemplateRule

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	ApimTemplateRule
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: ApimTemplateRuleSpec	Define el estado deseado de ApimTemplateRule.

ApimTemplateRuleSpec

Campo	Descripción
`requiredList`	Lista de políticas (como `strings`) que deben estar presentes en ApimTemplate.
`denyList`	Lista de políticas (como `strings`) que no deben estar presentes en ApimTemplate.
`allowList`	Lista de políticas (como `strings`) que pueden estar presentes en ApimTemplate, pero no son obligatorias.
`override` Tipo: `boolean`	Anula las actualizaciones de la regla de plantilla de APIM en caso de que existan plantillas de APIM que usen la regla. Los valores válidos son `true` y `false`.

AssignMessage (inyección de tokensGoogle )

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	AssignMessage
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: AssignMessageBean	Define el estado deseado de la política AssignMessage.

AssignMessageBean

Campo	Descripción
`setActions` Tipo: `array`	Matriz de objetos `SetActionsBean`. Sustituye los valores de las propiedades existentes en la solicitud o la respuesta, tal como se especifica en el elemento `AssignTo`. Si las cabeceras o los parámetros ya están presentes en el mensaje original, `setActions` sobrescribe los valores. De lo contrario, `setActions` añade los encabezados o parámetros especificados.
`AssignTo` Tipo: AssignToBean	Especifica en qué mensaje opera la política AssignMessage. Entre las opciones se incluyen la solicitud, la respuesta o un nuevo mensaje personalizado.

SetActionsBean

Campo	Descripción
`Authentication` Tipo: AuthenticationBean	Genera tokens de Google OAuth 2.0 u OpenID Connect para hacer llamadas autenticadas a Google servicios o servicios personalizados que se ejecutan en determinados productos, como funciones de Cloud Run y Cloud Run. Google Cloud

AuthenticationBean

Campo	Descripción
`GoogleAccessToken` Tipo: GoogleAccessTokenBean	Genera tokens de OAuth 2.0 de Google para hacer llamadas autenticadas a servicios de Google.
`GoogleIDToken` Tipo: GoogleIDTokenBean	Configuración para generar un token de OpenID Connect con el que autenticar la solicitud de destino.
`headerName` Tipo: `string`	De forma predeterminada, cuando hay una configuración de autenticación, Apigee genera un token de portador y lo inserta en el encabezado Authorization del mensaje enviado al sistema de destino. El elemento `headerName` le permite especificar el nombre de un encabezado diferente para contener el token de portador.

GoogleAccessTokenBean

Campo	Descripción
`scopes` Tipo: `array`	Matriz de `strings` que especifica un ámbito de API de Google válido. Para obtener más información, consulta Permisos de OAuth 2.0 para APIs de Google.
`LifetimeInSeconds` Tipo: `integer`	Especifica la duración del token de acceso en segundos.

GoogleIDTokenBean

Campo	Descripción
`Audience` Tipo: AudienceBean	La audiencia del token de autenticación generado, como la API o la cuenta de servicio a la que el token ha concedido acceso.
`IncludeEmail` Tipo: `boolean`	Si se define como `true`, el token de autenticación generado contendrá las reclamaciones `email` y `email_verified` de la cuenta de servicio.

AudienceBean

Campo	Descripción
`useTargetHost` Tipo: `string`	Si el valor de `Audience` está vacío o la variable `ref` no se resuelve en un valor válido y `useTargetUrl` es `true`, se usa como audiencia la URL de destino (sin incluir ningún parámetro de consulta).
`useTargetUrl` Tipo: `boolean`	De forma predeterminada, `useTargetUrl` es `false`.

AssignToBean

Campo	Descripción
`createNew` Tipo: `boolean`	Determina si la política crea un nuevo mensaje al asignar valores. Si se define como `true`, la política crea un mensaje nuevo.
`type` Tipo: `string`	Especifica el tipo del nuevo mensaje cuando `CreateNew` se define como `true` true. Los valores válidos son request o response.

JavaScript

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	JavaScript
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: JavascriptBean	Define el estado deseado de la política de JavaScript.

JavascriptBean

Campo	Descripción
`mode` Tipo: `array`	Matriz de `strings` que especifica `ProxyRequest` o `ProxyResponse`. Determina si la política se adjunta al flujo de solicitudes o al flujo de respuestas.
`source` Tipo: `string`	Código JavaScript insertado.
`timeLimit` Tipo: `integer`	Especifica el tiempo de espera para la ejecución del código JavaScript.

KVM

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	KVM
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: KeyValueMapOperationsBean	Define el estado deseado de la política de KVM.

KeyValueMapOperationsBean

Campo	Descripción
`MapName` Tipo: `MapName`	Habilita la política para identificar qué KVM se debe usar de forma dinámica en el tiempo de ejecución.
`expiryTimeInSecs` Tipo: `integer`	Especifica la duración en segundos tras la cual Apigee actualiza su valor almacenado en caché del KVM especificado.
`initialEntries` Tipo: `list`	Valores iniciales de los KVMs, que se rellenan en el KVM cuando se inicializa.

OASValidation

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	OASValidation
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: OASValidationBean	Define el estado deseado de la política OASValidation.

OASValidationBean

Campo	Descripción
`openApiSpec` Tipo: `string`	Especifica la especificación de OpenAPI en `yaml` que se va a validar. Como se trata de un fragmento de varias líneas `yaml`, usa el delimitador "\|".
`source` Tipo: `string`	Uno de los valores `message`, `request` o `response`. Si se define como `request`, se evaluarán las solicitudes entrantes de las aplicaciones cliente. Si se define como `response`, se evaluarán las respuestas de los servidores de destino. Si se define como `message`, se evaluará automáticamente la solicitud o la respuesta en función de si la política se adjunta al flujo de solicitud o de respuesta.
`options` Tipo: `OASValidationOptions`	Consulta OASValidationOptions/td>

OASValidationOptions

Campo	Descripción
`validateMessageBody` Tipo: `boolean`	Especifica si la política debe validar el cuerpo del mensaje con el esquema del cuerpo de la solicitud de la operación en la especificación de OpenAPI. Definir como `true` para validar el contenido del cuerpo del mensaje. Define como `false` para validar solo que el cuerpo del mensaje existe.
`allowUnspecifiedParameters` Tipo: `StrictOptions`	Consulta StrictOptions.

StrictOptions

Campo	Descripción
`header` Tipo: `boolean`	Para permitir que se especifiquen en la solicitud parámetros de encabezado que no estén definidos en la especificación de OpenAPI, defina este parámetro como `true`. De lo contrario, defina este parámetro como `false` para que se produzca un error en la ejecución de la política.
`query` Tipo: `boolean`	Para permitir que se especifiquen en la solicitud parámetros de consulta que no estén definidos en la especificación de OpenAPI, defina este parámetro como `true`. De lo contrario, defina este parámetro como `false` para que se produzca un error en la ejecución de la política.
`cookie` Tipo: `boolean`	Para permitir que se especifiquen en la solicitud parámetros de cookies que no estén definidos en la especificación OpenAPI, asigna a este parámetro el valor `true`. De lo contrario, defina este parámetro como `false` para que se produzca un error en la ejecución de la política.

APIMResourceStatus

Campo	Descripción
`currentState` Tipo: `enum`	Muestra el estado actual del recurso: `RUNNING`: el recurso está en estado de ejecución. `CREATING` = se está creando el recurso `CREATED` = se ha creado el recurso `UPDATING` = el recurso se está actualizando `DELETING` = El recurso se está eliminando. `CREATE_UPDATE_FAILED` = error en la operación de creación o actualización `DELETE_FAILED` = no se ha podido realizar la operación de eliminación
`errorMessage` Tipo: `string`	Mensaje de error relacionado con uno de los estados de fallo del campo `currentState`.
`operationResult` Tipo: `string`	Una cadena de respuesta de una de las operaciones de larga duración relacionadas con la creación, la actualización o la eliminación de recursos.

ServiceCallout

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	ServiceCallout
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: ServiceCalloutBean	Define el estado deseado de la política ServiceCallout.

ServiceCalloutBean

Campo	Descripción
`httpTargetConnection` Tipo: `HttpTargetConnection`	Proporciona detalles del transporte, como la URL y las propiedades de TLS/SSL y HTTP.
`request` Tipo: CalloutRequest	Especifica la variable que contiene el mensaje de solicitud que se envía del proxy de API al otro servicio.
`Response` Tipo: `string`	Especifica la variable que contiene el mensaje de respuesta que devuelve el servicio externo al proxy de API.

HttpTargetConnection

Campo	Descripción
`url` Tipo: `string`	La URL del servicio de destino.
`properties` Tipo: `Map of <string, string>`	Propiedades de transporte HTTP al servicio de backend. Para obtener más información, consulta la referencia de propiedades de puntos de conexión.

CalloutRequest

Campo	Descripción
`url` Tipo: `string`	La URL del servicio de destino.
`properties` Tipo: `Map of <string, string>`	Propiedades de transporte HTTP al servicio de backend. Para obtener más información, consulta la referencia de propiedades de puntos de conexión.

SpikeArrest

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	SpikeArrest
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: SpikeArrestBean	Define el estado deseado de la política SpikeArrest.

SpikeArrestBean

Campo	Descripción
`mode` Tipo: `array`	Matriz de `strings` que especifica `ProxyRequest` o `ProxyResponse`. Determina si la política se adjunta al flujo de solicitudes o al flujo de respuestas.
`peakMessageRate` Tipo: peakMessageRate	Especifica la frecuencia de mensajes de SpikeArrest.
`useEffectiveCount` Tipo: `boolean`	Si se define como `true`true, SpikeArrest se distribuye en una región, con recuentos de solicitudes sincronizados en los procesadores de mensajes (MPs) de Apigee de una región. Si se define como `false`, SpikeArrest usa un algoritmo de cubo de tokens de forma local. Para obtener más información, consulta UseEffectiveCount.

peakMessageRate

Campo	Descripción
`ref` Tipo: `string`	Variable que hace referencia al valor de `rate`.
`value` Tipo: `string`	Valor `rate` real si no hay ninguna referencia disponible.

Política ResponseCache

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	ResponseCache
`metadata` Tipo: meta/v1.ObjectMeta de Kubernetes	Consulta la documentación de la API de Kubernetes para ver los campos disponibles en `metadata`.
`spec` Tipo: APIExtensionPolicySpec	Define el estado deseado de ResponseCache.

ResponseCacheBean

Campo	Descripción
`mode` Tipo: `boolean`	Especifica `ProxyRequest` o `ProxyResponse`. Determina si la política se adjunta al flujo de solicitudes o al flujo de respuestas.
`cacheExpiry` Tipo: cacheExpiry	Proporciona el objeto cacheExpiry.
`cacheKey` Tipo: cacheKey	Proporciona el objeto cacheKey.
`cacheLookupTimeOut` type: `integer`	Especifica el periodo de tiempo de espera de la búsqueda en la caché.
`cacheResourceRef` type: `string`	Especifica el identificador del recurso de caché mediante una referencia de variable.
`excludeErrorResponse` type: `boolean`	Esta política puede almacenar en caché respuestas HTTP con cualquier código de estado. Esto significa que se pueden almacenar en caché tanto las respuestas correctas como las que contienen errores, incluidos los códigos de estado `2xx` y `3xx`.
`skipCacheLookupCondition` type: `string`	Define una expresión que, si se evalúa como `true` en el tiempo de ejecución, especifica que se debe omitir la búsqueda en la caché y que se debe actualizar la caché.
`skipCachePopulationCondition` type: `string`	Define una expresión que, si se evalúa como	Define una expresión que, si se evalúa como `true` en el tiempo de ejecución, especifica que se debe omitir la búsqueda en la caché y que se debe actualizar en el tiempo de ejecución. Especifica que se debe omitir la escritura en la caché.
`useAcceptHeader` type: `boolean`	Asigna el valor `true` para añadir valores de los encabezados de respuesta `Accept` a la clave de caché de la entrada de caché de la respuesta.
`useResponseCacheHeaders` type: `boolean`	Se define como `true` para que se tengan en cuenta los encabezados de respuesta HTTP al definir el tiempo de vida (TTL) de la respuesta en la caché.

cacheExpiry

Campo	Descripción
`expiryDate` Tipo: `object`	Especifica la fecha en la que debe caducar una entrada de caché.
`timeOfDay` Tipo: `object`	Especifica la hora del día en la que debe caducar una entrada de caché.
`timeoutInSeconds` Tipo: `object`	Especifica el número de segundos después de los cuales debe caducar una entrada de caché.

cacheKey

Campo	Descripción
`cacheKeyPrefix` Tipo: `string`	Especifica un valor que se usará como prefijo de clave de caché.
`fragments` Tipo: `object`	Especifica un valor que se incluirá en la clave de caché para crear un espacio de nombres para las solicitudes que coincidan con las respuestas almacenadas en caché.

Referencia de recursos del operador de gestión de APIs de Apigee para Kubernetes Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.