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.

Esta página es una referencia para cada recurso de Kubernetes que admite el operador de APIM de Apigee para Kubernetes (versión preliminar). Todos los campos son obligatorios, a menos que se indique lo contrario.

APIProduct

Campo	Descripción
`apiVersion` Tipo: `string`	`apim.googleapis.com/v1alpha1`
`kind` Tipo: `string`	`APIProduct`
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	Consulta la documentación de la API de Kubernetes para ver 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 de consumidor se genera y se muestra 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 muestra 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 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 con 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 de producto de la API predeterminado con metadatos específicos del cliente.

EnforcementRef

Campo	Descripción
`name` Tipo: `string`	El nombre del recurso de destino.
`kind` Tipo: `string`	`APIMExtensionPolicy`
`group` Tipo: `string`	El APIGroup para el operador de APIM de Apigee, que es `apim.googleapis.com`.
`namespace` Tipo: `string`	(Opcional) Es el espacio de nombres del referente. 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/v1alpha1`
`kind` Tipo: `string`	`APIOperationSet`
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	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: Cuota	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 las 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 cual se calcula la cantidad de mensajes de solicitud.
`timeUnit` Tipo: `string`	Es la unidad de tiempo definida para el intervalo. Los valores válidos incluyen `minute`, `hour`, `day` o `month`.

RESTOperation

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

APIProductRef

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

APIMExtensionPolicy

Campo	Descripción
`apiVersion` Tipo: `string`	`apim.googleapis.com/v1alpha1`
`kind` Tipo: `string`	APIMExtensionPolicy
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	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`	Entorno de Apigee (opcional). 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 mientras se usa un balanceador de cargas global externo.
`failOpen` Tipo: `boolean`	Especifica si se debe abrir con error cuando no se puede acceder al entorno de ejecución de Apigee. Si se establece en `true`, las llamadas al entorno de ejecución de Apigee se tratarán como correctas, incluso si no se puede acceder al entorno de ejecución.
`timeout` Tipo: `string`	Especifica el tiempo de espera antes de que falle una llamada al entorno 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.

ExtensionServerRef

Campo	Descripción
`name` Tipo: `string`	El 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 para el operador de APIM de Apigee, que es `apim.googleapis.com`.
`namespace` Tipo: `string`	(Opcional) Es el espacio de nombres del referente. Cuando no se especifica, se infiere el espacio de nombres local.

ApigeeGatewayPolicy

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1alpha1
`kind` Tipo: `string`	ApigeeGatewayPolicy
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	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	Se refiere a la plantilla de APIM creada para administrar 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 de Gateway específica. Se refiere indirectamente a la puerta de enlace de GKE.
`serviceAccount`	(Opcional) Especifica la cuenta de servicio que se usa para generar Google tokens de autenticación en un proxy de Apigee Pro.

ApimTemplate

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1alpha1
`kind` Tipo: `string`	ApimTemplate
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	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`	Es una lista de recursos ApimTemplateFlow que especifican las políticas que se ejecutarán 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	Es una lista de recursos ConditionalParameterReference que especifican la lista ordenada de políticas que se ejecutarán 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/v1alpha1
`kind` Tipo: `string`	ApimTemplateRule
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	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`	Es la lista de políticas (como `strings`) que deben estar presentes en ApimTemplate.
`denyList`	Es la lista de políticas (como `strings`) que no deberían estar presentes en 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`.

JavaScript

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1alpha1
`kind` Tipo: `string`	JavaScript
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	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`	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`	Código JavaScript intercalado
`timeLimit` Tipo: `integer`	Especifica el tiempo de espera para la ejecución del código JavaScript.

SpikeArrest

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1alpha1
`kind` Tipo: `string`	SpikeArrest
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	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 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 establece como `true`true, SpikeArrest se distribuye en una región, con recuentos de solicitudes sincronizados 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`	Es el valor real de `rate` si no hay una referencia disponible.

AssignMessage (inyección de tokenGoogle )

Campo	Descripción
`apiVersion` Tipo: `string`	apim.googleapis.com/v1alpha1
`kind` Tipo: `string`	AssignMessage
`metadata` Tipo: Kubernetes meta/v1.ObjectMeta	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 de AssignMessage.

AssignMessageBean

Campo	Descripción
`setActions` Tipo: `array`	Array de objetos `SetActionsBean`. Reemplaza los valores de las propiedades existentes en la solicitud o respuesta, como se especifica en 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 se especifique.
`AssignTo` Tipo: AssignToBean	Especifica en qué mensaje opera la política AssignMessage. Entre las opciones, se incluyen la solicitud, la respuesta o un mensaje personalizado nuevo.

SetActionsBean

Campo	Descripción
`Authentication` Tipo: AuthenticationBean	Genera Google tokens de 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	Configuración para generar un token de OpenID Connect que autentica 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	El público del token de autenticación que se generó, como la API o la cuenta de servicio a la que el token otorgó 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 como `true` verdadero. Los valores válidos son solicitud o respuesta.