Referência do recurso do operador do Apigee APIM para Kubernetes

Esta página se aplica à Apigee, mas não à Apigee híbrida.

Confira a documentação da Apigee Edge.

Esta página é uma referência para cada recurso do Kubernetes compatível com o operador da API Apigee para Kubernetes. A menos que seja indicado especificamente como "Opcional", todos os campos são obrigatórios.

APIProduct

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	APIProduct
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: APIProductSpec	spec define o estado desejado do APIProductSet.

APIProductSpec

Campo	Descrição
name Tipo: string	O nome do produto de API.
approvalType Tipo: string	Flag que especifica como as chaves de API são aprovadas para acessar as APIs definidas pelo produto de API. Se definida como manual, a chave do consumidor será gerada e retornada como pending. Nesse caso, as chaves de API não vão funcionar até serem explicitamente aprovadas. Se definido como auto, a chave do consumidor será gerada e retornada como approved e poderá ser usada imediatamente.
description Tipo: string	Descrição do produto de API.
displayName Tipo: string	Nome exibido na UI ou no portal do desenvolvedor para desenvolvedores que se inscrevem para acesso à API.
analytics Tipo: Analytics	Define se as análises devem ser coletadas para operações associadas a este produto.
enforcementRefs Tipo: Array	Matriz de recursos EnforcementRef a serem aplicados ao produto de API.
attributes Tipo: Array	Matriz de atributos que pode ser usada para estender o perfil de produto da API padrão com metadados específicos do cliente.

EnforcementRef

Campo	Descrição
name Tipo: string	O nome do recurso de destino.
kind Tipo: string	APIMExtensionPolicy
group Tipo: string	O APIGroup para o operador APIM da Apigee, que é apim.googleapis.com.
namespace Tipo: string	(Opcional) O namespace do referente. Quando não especificado, o namespace local é inferido.

Atributo

Campo	Descrição
name Tipo: string	A chave do atributo.
value Tipo: string	O valor do atributo.

APIOperationSet

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	APIOperationSet
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: APIOperationSetSpec	Define o estado desejado do APIOperationSet.

APIOperationSetSpec

Campo	Descrição
quota Tipo: Quota	Definição de cota.
restOperations Tipo: Array	Matriz de definições de RESTOperation.
apiProductRefs Tipo: Array	Matriz de recursos APIProductRef ou referências a produtos de API em que as RESTOperations devem ser aplicadas.

Cota

Campo	Descrição
limit Tipo: integer	Número de mensagens de solicitação permitidas por app pelo produto de API para o interval e o timeUnit especificados.
interval Tipo: integer	Intervalo de tempo em que o número de mensagens de solicitação é calculado.
timeUnit Tipo: string	Unidade de tempo definida para o intervalo. Os valores válidos incluem minute, hour, day ou month.

RESTOperation

Campo	Descrição
name Tipo: string	O nome da operação REST.
path Tipo: string	Em combinação com methods, path é o caminho HTTP a ser correspondido para uma cota e/ou para um produto de API.
methods Tipo: array	Em combinação com path, methods é a lista (como strings) de métodos HTTP aplicáveis para corresponder a uma cota e/ou a um produto de API.

APIProductRef

Campo	Descrição
name Tipo: string	O nome do recurso de destino.
kind Tipo: string	APIProduct
group Tipo: string	O APIGroup para o operador APIM da Apigee, que é apim.googleapis.com.
namespace Tipo: string	(Opcional) O namespace do referente. Quando não especificado, o namespace local é inferido.

APIMExtensionPolicy

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	APIMExtensionPolicy
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: APIMExtensionPolicySpec	Define o estado desejado de APIMExtensionPolicy.

APIMExtensionPolicySpec

Campo	Descrição
apigeeEnv	(Opcional) Ambiente da Apigee. Se não for informado, um novo ambiente será criado e anexado a todas as instâncias disponíveis. Se fornecido, esse ambiente precisa ser anexado a todas as instâncias disponíveis ao usar um balanceador de carga global externo.
failOpen Tipo: boolean	Especifica se é necessário abrir em caso de falha quando o ambiente de execução da Apigee não está disponível. Se definido como true, as chamadas para o ambiente de execução da Apigee serão tratadas como bem-sucedidas, mesmo que o ambiente de execução esteja inacessível.
timeout Tipo: string	Especifica o período de tempo limite antes da falha das chamadas para o ambiente de execução da Apigee, em segundos ou milissegundos. Por exemplo, 10s
targetRef Tipo: ExtensionServerRef	Identifica o gateway do Google Kubernetes Engine em que a extensão precisa ser instalada.
location Tipo: string	Identifica o Google Cloud local em que APIMExtensionPolicy é aplicado.
supportedEvents Tipo: List de eventos	Especifica a lista de eventos do processador de extensão enviados ao Apigee. Isso inclui o seguinte: "REQUEST_HEADERS" "RESPONSE_HEADERS" "REQUEST_BODY" (Visualização prévia) "RESPONSE_BODY" (Visualização prévia) "REQUEST_TRAILERS" "RESPONSE_TRAILERS"

ExtensionServerRef

Campo	Descrição
name Tipo: string	O nome do recurso de destino.
kind Tipo: string	Especifica o kind do recurso de destino, por exemplo, Gateway ou Service.
group Tipo: string	O APIGroup para o operador APIM da Apigee, que é apim.googleapis.com.
namespace Tipo: string	(Opcional) O namespace do referente. Quando não especificado, o namespace local é inferido.

ApigeeGatewayPolicy

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	ApigeeGatewayPolicy
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: ApigeeGatewayPolicySpec	Define o estado desejado de ApigeeGatewayPolicy.

ApigeeGatewayPolicySpec

Campo	Descrição
ref Tipo: ExtensionServerRef	Refere-se ao modelo do APIM criado para reger as políticas aplicadas ao Gateway do GKE.
targetRef Tipo: ExtensionServerRef	Refere-se à política de extensão do APIM que deve aplicar essa política específica do gateway. Refere-se indiretamente ao GKE Gateway.
serviceAccount	(Opcional) Especifica a conta de serviço usada para gerar tokens de autenticação Google em um proxy do Apigee ProApigee.

ApimTemplate

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	ApimTemplate
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: ApimTemplateSpec	Define o estado desejado do ApimTemplate.

ApimTemplateSpec

Campo	Descrição
templates Tipo: list	Uma lista de recursos ApimTemplateFlow que especificam as políticas a serem executadas no fluxo de solicitação.
apimTemplateRule Tipo: ExtensionServerRef	Especifica a regra de modelo do APIM que deve ser usada para validar as políticas aplicadas.

ApimTemplateFlow

Campo	Descrição
policies Tipo: list ConditionalParameterReference	Uma lista de recursos ConditionalParameterReference que especificam a lista ordenada de políticas a serem executadas como parte do fluxo de solicitação.
condition Tipo: string	Especifica as condições para executar esse recurso.

ConditionalParameterReference

Campo	Descrição
condition Type: string	Especifica as condições para executar esse recurso.

ApimTemplateRule

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	ApimTemplateRule
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: ApimTemplateRuleSpec	Define o estado desejado de ApimTemplateRule.

ApimTemplateRuleSpec

Campo	Descrição
requiredList	A lista de políticas (como strings) que precisam estar presentes no ApimTemplate.
denyList	A lista de políticas (como strings) que não devem estar presentes no ApimTemplate.
allowList	A lista de políticas (como strings) que podem estar presentes no ApimTemplate, mas não são obrigatórias.
override Tipo: boolean	Substitui as atualizações da regra de modelo do APIM caso existam modelos do APIM que usam a regra. Os valores válidos são true ou false.

AssignMessage (injeção de tokenGoogle )

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	AssignMessage
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: AssignMessageBean	Define o estado desejado da política AssignMessage.

AssignMessageBean

Campo	Descrição
setActions Tipo: array	Matriz de objetos SetActionsBean. Substitui os valores das propriedades atuais na solicitação ou resposta, conforme especificado pelo elemento AssignTo. Se os cabeçalhos ou parâmetros já estiverem presentes na mensagem original, o setActions vai substituir os valores. Caso contrário, setActions adiciona novos cabeçalhos ou parâmetros conforme especificado.
AssignTo Tipo: AssignToBean	Especifica em que mensagem a política AssignMessage funciona. As opções incluem a solicitação, a resposta ou uma nova mensagem personalizada.

SetActionsBean

Campo	Descrição
Authentication Tipo: AuthenticationBean	Gera tokens Google OAuth 2.0 ou OpenID Connect para fazer chamadas autenticadas para serviços Google ou personalizados em execução em determinados produtos Google Cloud , como funções do Cloud Run e o Cloud Run.

AuthenticationBean

Campo	Descrição
GoogleAccessToken Tipo: GoogleAccessTokenBean	Gera tokens do Google OAuth 2.0 para fazer chamadas autenticadas aos serviços do Google.
GoogleIDToken Tipo: GoogleIDTokenBean	Configuração para gerar um token do OpenID Connect e autenticar a solicitação de destino.
headerName Tipo: string	Por padrão, quando uma configuração de autenticação está presente, a Apigee gera um token do portador e o injeta no cabeçalho de autorização da mensagem enviada ao sistema de destino. O elemento headerName permite especificar o nome de um cabeçalho diferente para armazenar o token do portador.

GoogleAccessTokenBean

Campo	Descrição
scopes Tipo: array	Matriz de strings que especifica um escopo válido de API do Google. Para mais informações, consulte Escopos do OAuth 2.0 para APIs do Google.
LifetimeInSeconds Tipo: integer	Especifica a duração do token de acesso em segundos.

GoogleIDTokenBean

Campo	Descrição
Audience Tipo: AudienceBean	O público-alvo do token de autenticação gerado, como a API ou a conta de serviço a que o token concede acesso.
IncludeEmail Tipo: boolean	Se definido como true, o token de autenticação gerado vai conter as declarações email e email_verified da conta de serviço.

AudienceBean

Campo	Descrição
useTargetHost Tipo: string	Se o valor de Audience estiver vazio ou a variável ref não for resolvida como um valor válido e useTargetUrl for true, o URL de destino (excluindo qualquer parâmetro de consulta) será usado como público-alvo.
useTargetUrl Tipo: boolean	Por padrão, useTargetUrl é false.

AssignToBean

Campo	Descrição
createNew Tipo: boolean	Determina se a política cria uma nova mensagem ao atribuir valores. Se definida como true, a política vai criar uma nova mensagem.
type Tipo: string	Especifica o tipo da nova mensagem, quando CreateNew é definido como true true. Os valores válidos são request ou response.

JavaScript

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	JavaScript
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: JavascriptBean	Define o estado desejado da política de JavaScript.

JavascriptBean

Campo	Descrição
mode Tipo: array	Matriz de strings que especifica ProxyRequest ou ProxyResponse. Determina se a política está anexada ao fluxo de solicitação ou de resposta.
source Tipo: string	Código JavaScript inline.
timeLimit Tipo: integer	Especifica o tempo limite para a execução do código JavaScript.

KVM

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	KVM
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: KeyValueMapOperationsBean	Define o estado desejado da política de KVM.

KeyValueMapOperationsBean

Campo	Descrição
MapName Tipo: MapName	Permite que a política identifique qual KVM usar dinamicamente, no ambiente de execução.
expiryTimeInSecs Tipo: integer	Especifica a duração em segundos após a Apigee atualizar o valor em cache do KVM especificado.
initialEntries Tipo: list	Valores de semente para KVMs, que são preenchidas no KVM quando ele é inicializado.

OASValidation

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	OASValidation
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: OASValidationBean	Define o estado desejado da política OASValidation.

OASValidationBean

Campo	Descrição
openApiSpec Tipo: string	Especifica a especificação OpenAPI em yaml a ser validada. Como este é um fragmento yaml de várias linhas, use o delimitador "|".
source Tipo: string	Um de message, request ou response. Quando definido como request, ele avalia as solicitações recebidas de apps clientes. Quando definido como response, ele avalia as respostas dos servidores de destino. Quando definido como message, ele avalia automaticamente a solicitação ou a resposta, dependendo se a política está anexada ao fluxo de solicitação ou de resposta.
options Tipo: OASValidationOptions	Consulte OASValidationOptions/td>

OASValidationOptions

Campo	Descrição
validateMessageBody Tipo: boolean	Especifica se a política deve validar o corpo da mensagem com o esquema de corpo da solicitação da operação na especificação OpenAPI. Defina como true para validar o conteúdo do corpo da mensagem. Defina como false para validar apenas que o corpo da mensagem existe.
allowUnspecifiedParameters Tipo: StrictOptions	Consulte StrictOptions.

StrictOptions

Campo	Descrição
header Tipo: boolean	Para permitir que os parâmetros de cabeçalho sejam especificados na solicitação que não esteja definida na especificação OpenAPI, defina esse parâmetro como true. Caso contrário, defina esse parâmetro como false para que a execução da política falhe.
query Tipo: boolean	Para permitir que os parâmetros de consulta sejam especificados na solicitação que não estão definidos na especificação OpenAPI, defina esse parâmetro como true. Caso contrário, defina esse parâmetro como false para que a execução da política falhe.
cookie Tipo: boolean	Para permitir que parâmetros de cookie sejam especificados em uma solicitação não definida na especificação OpenAPI, configure esse parâmetro como true. Caso contrário, defina esse parâmetro como false para que a execução da política falhe.

APIMResourceStatus

Campo	Descrição
currentState Tipo: enum	Mostra o estado atual do recurso: RUNNING = o recurso está em estado de execução. CREATING = o recurso está sendo criado CREATED = o recurso foi criado UPDATING = o recurso está sendo atualizado DELETING = o recurso está sendo excluído CREATE_UPDATE_FAILED = falha na operação de criação ou atualização DELETE_FAILED = falha na operação de exclusão
errorMessage Tipo: string	Mensagem de erro relacionada a um dos estados de falha do campo currentState.
operationResult Tipo: string	Uma string de resposta de uma das operações de longa duração relacionadas à criação, atualização ou exclusão de recursos.

ServiceCallout

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	ServiceCallout
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: ServiceCalloutBean	Define o estado desejado da política ServiceCallout.

ServiceCalloutBean

Campo	Descrição
httpTargetConnection Tipo: HttpTargetConnection	Fornece detalhes de transporte, como propriedades URL, TLS/SSL e HTTP.
request Tipo: CalloutRequest	Especifica a variável que contém a mensagem de solicitação enviada do proxy de API para o outro serviço.
Response Tipo: string	Especifica a variável que contém a mensagem de resposta retornada ao proxy de API pelo serviço externo.

HttpTargetConnection

Campo	Descrição
url Tipo: string	O URL do serviço de destino.
properties Tipo: Map of <string, string>	Propriedades de transporte HTTP para o serviço de back-end. Para mais informações, consulte Referência de propriedades do endpoint.

CalloutRequest

Campo	Descrição
url Tipo: string	O URL do serviço de destino.
properties Tipo: Map of <string, string>	Propriedades de transporte HTTP para o serviço de back-end. Para mais informações, consulte Referência de propriedades do endpoint.

SpikeArrest

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	SpikeArrest
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: SpikeArrestBean	Define o estado desejado da política de SpikeArrest.

SpikeArrestBean

Campo	Descrição
mode Tipo: array	Matriz de strings que especifica ProxyRequest ou ProxyResponse. Determina se a política está anexada ao fluxo de solicitação ou de resposta.
peakMessageRate Tipo: peakMessageRate	Especifica a taxa de mensagens para a política de Detenção de pico.
useEffectiveCount Tipo: boolean	Se definida como truetrue, a SpikeArrest será distribuída em uma região, com contagens de solicitações sincronizadas entre os processadores de mensagens (MPs) da Apigee em uma região. Se definida como false, a SpikeArrest usará um algoritmo de intervalo de token localmente. Para mais informações, consulte UseEffectiveCount.

peakMessageRate

Campo	Descrição
ref Tipo: string	Variável que faz referência ao valor rate.
value Tipo: string	Valor rate real se uma referência não estiver disponível.

Política ResponseCache

Campo	Descrição
apiVersion Tipo: string	apim.googleapis.com/v1
kind Tipo: string	ResponseCache
metadata Tipo: Kubernetes meta/v1.ObjectMeta	Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
spec Tipo: APIExtensionPolicySpec	Define o estado desejado de ResponseCache.

ResponseCacheBean

Campo	Descrição
mode Tipo: boolean	Especifica ProxyRequest ou ProxyResponse. Determina se a política está anexada ao fluxo de solicitação ou de resposta.
cacheExpiry Tipo: cacheExpiry	Fornece o objeto cacheExpiry.
cacheKey Tipo: cacheKey	Fornece o objeto cacheKey.
cacheLookupTimeOut Tipo: integer	Especifica o período de tempo limite de pesquisa de cache.
cacheResourceRef Tipo: string	Especifica o identificador do recurso de cache usando uma referência de variável.
excludeErrorResponse Tipo: boolean	Essa política pode armazenar em cache as respostas HTTP com qualquer código de status. Isso significa que as respostas de sucesso e erro podem ser armazenadas em cache, incluindo códigos de status 2xx e 3xx.
skipCacheLookupCondition Tipo: string	Define uma expressão que, se for avaliada como true no ambiente de execução, especifica que a pesquisa de cache precisa ser ignorada e o cache precisa ser atualizado.
skipCachePopulationCondition Tipo: string	Define uma expressão que, se for avaliada como	Define uma expressão que, se for avaliada como true no ambiente de execução, especifica que a pesquisa de cache precisa ser ignorada e o cache precisa ser atualizado no ambiente de execução, especifica que uma gravação no cache precisa ser ignorada.
useAcceptHeader Tipo: boolean	Defina como true para anexar valores dos cabeçalhos Accept da resposta à chave de cache da entrada de cache de resposta.
useResponseCacheHeaders Tipo: boolean	Defina como true para que os cabeçalhos de resposta HTTP sejam considerados ao definir o "time to live" (TTL) da resposta no cache.

cacheExpiry

Campo	Descrição
expiryDate Tipo: object	Especifica a data em que uma entrada de cache expira.
timeOfDay Tipo: object	Especifica a hora em que uma entrada de cache deve expirar.
timeoutInSeconds Tipo: object	Especifica o número de segundos após o qual uma entrada de cache expira.

cacheKey

Campo	Descrição
cacheKeyPrefix Tipo: string	Especifica um valor para usar como prefixo da chave de cache.
fragments Tipo: object	Especifica um valor a ser incluído na chave de cache para criar um namespace para solicitações correspondentes a respostas em cache.