Esta página foi traduzida pela API Cloud Translation.

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 APIM do Apigee para Kubernetes (pré-lançamento). Todos os campos são obrigatórios, a menos que sejam marcados como opcionais.

APIProduct

Campo	Descrição
`apiVersion` Tipo: `string`	`apim.googleapis.com/v1alpha1`
`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 só vão funcionar após a aprovação explícita. 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 IU ou no portal do desenvolvedor para desenvolvedores que se registram para o acesso à API.
`analytics` Tipo: Google Analytics	Define se os dados de análise precisam ser coletados para operações associadas a esse produto.
`enforcementRefs` Tipo: `Array`	Matriz de recursos EnforcementRef a serem aplicados ao produto da 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 do Apigee APIM, 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/v1alpha1`
`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: cota	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 precisam ser aplicadas.

Cota

Campo	Descrição
`limit` Tipo: `integer`	Número de mensagens de solicitação permitidas por app pelo produto da API para o `interval` e `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 associado a uma cota e/ou a 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 do Apigee APIM, 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/v1alpha1`
`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 da APIMExtensionPolicy.

APIMExtensionPolicySpec

Campo	Descrição
`apigeeEnv`	(Opcional) Ambiente da Apigee. Se não for fornecido, 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 o fail open será usado quando o ambiente de execução da Apigee não puder ser acessado. 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 não possa ser acessado.
`timeout` Tipo: `string`	Especifica o tempo limite antes que as chamadas para o ambiente de execução da Apigee falhem, 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 a APIMExtensionPolicy é aplicada.

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 do Apigee APIM, 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/v1alpha1
`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 de APIM criado para governar as políticas aplicadas ao gateway do GKE.
`targetRef` Tipo: ExtensionServerRef	Refere-se à política de extensão do APIM que precisa 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 Google autenticação em um proxy do Apigee ProApigee.

ApimTemplate

Campo	Descrição
`apiVersion` Tipo: `string`	apim.googleapis.com/v1alpha1
`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ções.
`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 especifica 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/v1alpha1
`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 precisa estar presente 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`.

JavaScript

Campo	Descrição
`apiVersion` Tipo: `string`	apim.googleapis.com/v1alpha1
`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.

SpikeArrest

Campo	Descrição
`apiVersion` Tipo: `string`	apim.googleapis.com/v1alpha1
`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 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 SpikeArrest.
`useEffectiveCount` Tipo: `boolean`	Se definido como `true`true, o SpikeArrest será distribuído 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 usa um algoritmo de bucket 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 real de `rate` se uma referência não estiver disponível.

AssignMessage (injeção de tokenGoogle )

Campo	Descrição
`apiVersion` Tipo: `string`	apim.googleapis.com/v1alpha1
`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, `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 Google tokens do OAuth 2.0 ou do OpenID Connect para fazer chamadas autenticadas para Google serviços ou serviços personalizados em execução em determinados Google Cloud produtos, como funções do Cloud Run e do 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 para 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 da 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` verdadeiro. Os valores válidos são request ou response.