Se usó la API de Cloud Translation para traducir esta página.

Referencia de recursos del operador de APIM 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 proporciona una referencia para cada recurso de Kubernetes que admite el operador de la API de Apigee para Kubernetes. A menos que se indique específicamente que son opcionales, todos los campos son obligatorios.

APIProduct

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

APIProductSpec

Campo	Descripción
`name` Tipo: `string`	Es el nombre del producto de API.
`approvalType` Tipo: `string`	Es una marca que especifica cómo se aprueban las claves de API para acceder a las APIs definidas por el producto de API. Si se establece en `manual`, la clave del consumidor se genera y se devuelve como `pending`. En este caso, las claves de API no funcionarán hasta que se aprueben de forma explícita. Si se establece en `auto`, la clave del consumidor se genera y se devuelve como `approved`, y se puede usar de inmediato.
`description` Tipo: `string`	Descripción del producto de API.
`displayName` Tipo: `string`	Es el nombre que se muestra en la IU 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 recopilar estadísticas para las operaciones asociadas a este producto.
`enforcementRefs` Tipo: `Array`	Es un array de recursos EnforcementRef que se aplicarán al producto de API.
`attributes` Tipo: `Array`	Es un array de atributos que se pueden usar para extender el perfil predeterminado del producto de la API con metadatos específicos del cliente.

EnforcementRef

Campo	Descripción
`name` Tipo: `string`	Es el nombre del recurso de destino.
`kind` Tipo: `string`	`APIMExtensionPolicy`
`group` Tipo: `string`	APIGroup para el operador de APIM de Apigee, que es `apim.googleapis.com`.
`namespace` Tipo: `string`	Es el espacio de nombres del referente (opcional). Cuando no se especifica, se infiere el espacio de nombres local.

Atributo

Campo	Descripción
`name` Tipo: `string`	Es la clave del atributo.
`value` Tipo: `string`	Es el valor del atributo.

APIOperationSet

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

APIOperationSetSpec

Campo	Descripción
`quota` Tipo: Quota	Es la definición de la cuota.
`restOperations` Tipo: `Array`	Es un array de definiciones de RESTOperation.
`apiProductRefs` Tipo: `Array`	Es un array de recursos APIProductRef o referencias a productos de API en los que se deben aplicar los RESTOperations.

Cuota

Campo	Descripción
`limit` Tipo: `integer`	Cantidad de mensajes de solicitud permitidos por app por el producto de API para los `interval` y `timeUnit` especificados.
`interval` Tipo: `integer`	Es el intervalo de tiempo durante el que se calcula la cantidad de mensajes de solicitud.
`timeUnit` Tipo: `string`	Unidad de tiempo definida para el intervalo. Los valores válidos incluyen `minute`, `hour`, `day` o `month`.

RESTOperation

Campo	Descripción
`name` Tipo: `string`	Nombre de la operación de REST.
`path` Tipo: `string`	En combinación con `methods`, `path` es la ruta de acceso HTTP que se debe hacer coincidir para una cuota o 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 coincidir para una cuota o para un producto de API.

APIProductRef

Campo	Descripción
`name` Tipo: `string`	Es el nombre del recurso de destino.
`kind` Tipo: `string`	`APIProduct`
`group` Tipo: `string`	APIGroup para el operador de APIM de Apigee, que es `apim.googleapis.com`.
`namespace` Tipo: `string`	Es el espacio de nombres del referente (opcional). Cuando 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: Kubernetes meta/v1.ObjectMeta	Consulta la documentación de la API de Kubernetes para conocer los campos disponibles en `metadata`.
`spec` Tipo: APIMExtensionPolicySpec	Define el estado deseado de APIMExtensionPolicy.

APIMExtensionPolicySpec

Campo	Descripción
`apigeeEnv`	(Opcional) Es el entorno de Apigee. Si no se proporciona, se crea un entorno nuevo y se conecta a todas las instancias disponibles. Si se proporciona, este entorno debe adjuntarse a todas las instancias disponibles cuando se usa un balanceador de cargas externo global.
`failOpen` Tipo: `boolean`	Especifica si se debe abrir en caso de falla cuando no se pueda acceder al tiempo de ejecución de Apigee. Si se establece en `true`, las llamadas al entorno de ejecución de Apigee se tratarán como exitosas, incluso si no se puede acceder al entorno de ejecución.
`timeout` Tipo: `string`	Especifica el período 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 ubicación Google Cloud en la que se aplica APIMExtensionPolicy.
`supportedEvents` Tipo: `List` de eventos	Especifica la lista de eventos del procesador de extensiones que se envían a Apigee. Estas 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`	Es el nombre del recurso de destino.
`kind` Tipo: `string`	Especifica el `kind` del recurso de destino, por ejemplo, `Gateway` o `Service`.
`group` Tipo: `string`	APIGroup para el operador de APIM de Apigee, que es `apim.googleapis.com`.
`namespace` Tipo: `string`	Es el espacio de nombres del referente (opcional). Cuando 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: Kubernetes meta/v1.ObjectMeta	Consulta la documentación de la API de Kubernetes para conocer 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 regir las políticas aplicadas a la puerta de enlace de GKE.
`targetRef` Tipo: ExtensionServerRef	Hace referencia a la política de extensión de APIM que debe aplicar esta política específica de Gateway. Se refiere indirectamente a la puerta de enlace de GKE.
`serviceAccount`	(Opcional) Especifica la cuenta de servicio que se usa para generar tokens de autorización de Google en un proxy de Apigee ProApigee.

ApimTemplate

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

ApimTemplateSpec

Campo	Descripción
`templates` Tipo: `list`	Es una lista de recursos ApimTemplateFlow que especifican las políticas que se ejecutarán en el flujo de la solicitud.
`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	Es una lista de recursos ConditionalParameterReference que especifican la lista ordenada de políticas que se ejecutarán como parte del flujo de la solicitud.
`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: Kubernetes meta/v1.ObjectMeta	Consulta la documentación de la API de Kubernetes para conocer 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 deberían estar presentes en el ApimTemplate.
`allowList`	Es la 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` o `false`.

AssignMessage (inyección de tokenGoogle )

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

AssignMessageBean

Campo	Descripción
`setActions` Tipo: `array`	Es un array de objetos `SetActionsBean`. Reemplaza los valores de las propiedades existentes en la solicitud o respuesta, según lo especifica el elemento `AssignTo`. Si los encabezados o parámetros ya están presentes en el mensaje original, `setActions` reemplaza los valores. De lo contrario, `setActions` agrega encabezados o parámetros nuevos según lo especificado.
`AssignTo` Tipo: AssignToBean	Especifica en qué mensaje opera la política AssignMessage. Las opciones incluyen la solicitud, la respuesta o un nuevo mensaje personalizado.

SetActionsBean

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

AuthenticationBean

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

GoogleAccessTokenBean

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

GoogleIDTokenBean

Campo	Descripción
`Audience` Tipo: AudienceBean	Es el público del token de autenticación que se generó, como la API o la cuenta de servicio a la que el token otorga acceso.
`IncludeEmail` Tipo: `boolean`	Si se configura como `true`, el token de autenticación generado contendrá las reclamaciones de cuenta de servicio `email` y `email_verified`.

AudienceBean

Campo	Descripción
`useTargetHost` Tipo: `string`	Si el valor de `Audience` está vacío o si la variable `ref` no se resuelve en un valor válido, y `useTargetUrl` es `true`, la URL del destino (excluyendo cualquier parámetro de consulta) se usa como público.
`useTargetUrl` Tipo: `boolean`	El valor predeterminado de `useTargetUrl` es `false`.

AssignToBean

Campo	Descripción
`createNew` Tipo: `boolean`	Determina si la política crea un mensaje nuevo cuando asigna valores. Si se configura como `true`, la política crea un mensaje nuevo.
`type` Tipo: `string`	Especifica el tipo de mensaje nuevo, cuando `CreateNew` se establece en `true` verdadero. 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: Kubernetes meta/v1.ObjectMeta	Consulta la documentación de la API de Kubernetes para conocer 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`	Es un array de `strings` que especifica `ProxyRequest` o `ProxyResponse`. Determina si la política se adjunta al flujo de solicitud o al flujo de respuesta.
`source` Tipo: `string`	Es código JavaScript intercalado.
`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: Kubernetes meta/v1.ObjectMeta	Consulta la documentación de la API de Kubernetes para conocer 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 usará dinámicamente en el entorno de ejecución.
`expiryTimeInSecs` Tipo: `integer`	Especifica la duración en segundos a partir de la cual Apigee actualiza su valor almacenado en caché del KVM especificado.
`initialEntries` Tipo: `list`	Valores iniciales de KVM, que se propagan en el KVM cuando se inicializa.

OASValidation

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	OASValidation
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	Consulta la documentación de la API de Kubernetes para conocer 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 validará. Como se trata de un fragmento `yaml` de varias líneas, usa el delimitador "\|".
`source` Tipo: `string`	Es uno de los siguientes: `message`, `request` o `response`. Cuando se establece en `request`, evaluará las solicitudes entrantes de las apps cliente; cuando se establece en `response`, evaluará las respuestas de los servidores de destino. Cuando se configura como `message`, evaluará automáticamente la solicitud o la respuesta según si la política se adjunta al flujo de solicitud o de respuesta.
`options` Tipo: `OASValidationOptions`	Consulta OASValidationOptions.

OASValidationOptions

Campo	Descripción
`validateMessageBody` Tipo: `boolean`	Especifica si la política debe validar el cuerpo del mensaje en el esquema del cuerpo de la solicitud de la operación en la Especificación de OpenAPI. Se establece en `true` para validar el contenido del cuerpo del mensaje. Se configura en `false` para validar solo que el cuerpo del mensaje exista.
`allowUnspecifiedParameters` Tipo: `StrictOptions`	Consulta StrictOptions.

StrictOptions

Campo	Descripción
`header` Tipo: `boolean`	Para permitir que se especifiquen parámetros de encabezado en la solicitud que no se definen en la Especificación de OpenAPI, configura este parámetro en `true`. De lo contrario, establece este parámetro en `false` para que falle la ejecución de la política.
`query` Tipo: `boolean`	Para permitir que los parámetros de búsqueda se especifiquen en la solicitud que no están definidos en la Especificación de OpenAPI, configura este parámetro en `true`. De lo contrario, establece este parámetro en `false` para que falle la ejecución de la política.
`cookie` Tipo: `boolean`	Para permitir que los parámetros de cookies se especifiquen en la solicitud que no se definen en la Especificación de OpenAPI, configura este parámetro en `true`. De lo contrario, establece este parámetro en `false` para que falle 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 creó el recurso `UPDATING` = Se está actualizando el recurso `DELETING` = Se está borrando el recurso `CREATE_UPDATE_FAILED` = Error en la operación de creación o actualización `DELETE_FAILED` = No se pudo realizar la operación de eliminación
`errorMessage` Tipo: `string`	Es un mensaje de error relacionado con uno de los estados de falla del campo `currentState`.
`operationResult` Tipo: `string`	Es una cadena de respuesta de una de las operaciones de larga duración relacionadas con la creación, actualización o eliminación de recursos.

ServiceCallout

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	ServiceCallout
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	Consulta la documentación de la API de Kubernetes para conocer 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 las URL, TLS/SSL y las propiedades de HTTP.
`request` Tipo: CalloutRequest	Especifica la variable que contiene el mensaje de la solicitud que se envía desde el proxy de API al otro servicio.
`Response` Tipo: `string`	Especifica la variable que contiene el mensaje de respuesta que se devuelve al proxy de API desde el servicio externo.

HttpTargetConnection

Campo	Descripción
`url` Tipo: `string`	Es 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 Referencia de propiedades de extremos.

CalloutRequest

Campo	Descripción
`url` Tipo: `string`	Es 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 Referencia de propiedades de extremos.

SpikeArrest

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

SpikeArrestBean

Campo	Descripción
`mode` Tipo: `array`	Es un array de `strings` que especifica `ProxyRequest` o `ProxyResponse`. Determina si la política se adjunta al flujo de solicitud o al flujo de respuesta.
`peakMessageRate` Tipo: peakMessageRate	Especifica la tasa de mensajes para SpikeArrest.
`useEffectiveCount` Tipo: `boolean`	Si se configura como `true`true, SpikeArrest se distribuye en una región, y los recuentos de solicitudes se sincronizan entre los procesadores de mensajes (MP) de Apigee en una región. Si se configura como `false`, SpikeArrest usa un algoritmo de bucket 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 `rate`.
`value` Tipo: `string`	Valor real de `rate` si no hay una referencia disponible.

Política ResponseCache

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1
`kind` Tipo: `string`	ResponseCache
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	Consulta la documentación de la API de Kubernetes para conocer 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 solicitud o al flujo de respuesta.
`cacheExpiry` Tipo: cacheExpiry	Proporciona el objeto cacheExpiry.
`cacheKey` Tipo: cacheKey	Proporciona el objeto cacheKey.
`cacheLookupTimeOut` tipo: `integer`	Especifica el período de tiempo de espera de la búsqueda en la caché.
`cacheResourceRef` tipo: `string`	Especifica el identificador del recurso de caché con una referencia de variable.
`excludeErrorResponse` tipo: `boolean`	Esta política puede almacenar en caché respuestas HTTP con cualquier código de estado. Esto significa que tanto las respuestas correctas como las de error se pueden almacenar en caché, incluidos los códigos de estado `2xx` y `3xx`.
`skipCacheLookupCondition` tipo: `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 caché y se debe actualizar la caché.
`skipCachePopulationCondition` tipo: `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 caché y que se debe actualizar la caché en el tiempo de ejecución, especifica que se debe omitir una escritura en la caché.
`useAcceptHeader` tipo: `boolean`	Configúralo como `true` para agregar valores de los encabezados `Accept` de respuesta a la clave de caché de la entrada de caché de respuesta.
`useResponseCacheHeaders` tipo: `boolean`	Configúralo como `true` para que los encabezados de respuesta HTTP se consideren cuando se configure el “tiempo de actividad” (TTL) de la respuesta en la caché.

cacheExpiry

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

cacheKey

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

Referencia de recursos del operador de APIM de Apigee para Kubernetes Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.