Cette page a été traduite par l'API Cloud Translation.

Documentation de référence de l'opérateur Apigee APIM pour les ressources Kubernetes

Cette page s'applique à Apigee, mais pas à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

Cette page sert de référence pour chaque ressource Kubernetes compatible avec l'opérateur Apigee APIM pour Kubernetes. Sauf indication contraire, tous les champs sont obligatoires.

APIProduct

Champ	Description
`apiVersion` Type : `string`	`apim.googleapis.com/v1`
`kind` Type : `string`	`APIProduct`
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : APIProductSpec	`spec` définit l'état souhaité de l'APIProductSet.

APIProductSpec

Champ	Description
`name` Type : `string`	Nom du produit d'API.
`approvalType` Type : `string`	Indicateur qui spécifie l'approbation des clés API pour accéder aux API définies par le produit d'API. Si la valeur est définie sur `manual`, la clé consommateur est générée et renvoyée sous la forme `pending`. Dans ce cas, les clés API ne fonctionneront pas tant qu'elles n'auront pas été explicitement approuvées. Si la valeur est définie sur `auto`, la clé consommateur est générée et renvoyée sous la forme `approved`. Elle peut être utilisée immédiatement.
`description` Type : `string`	Description du produit API.
`displayName` Type : `string`	Nom affiché dans l'UI ou le portail des développeurs pour les développeurs qui s'inscrivent à l'accès à l'API.
`analytics` Type : Analytics	Définit si des données analytiques doivent être collectées pour les opérations associées à ce produit.
`enforcementRefs` Type : `Array`	Tableau de ressources EnforcementRef à appliquer au produit d'API.
`attributes` Type : `Array`	Tableau d'attributs permettant d'étendre le profil du produit d'API par défaut avec des métadonnées spécifiques au client.

EnforcementRef

Champ	Description
`name` Type : `string`	Nom de la ressource cible.
`kind` Type : `string`	`APIMExtensionPolicy`
`group` Type : `string`	Le APIGroup pour l'opérateur APIM Apigee, qui est `apim.googleapis.com`.
`namespace` Type : `string`	(Facultatif) Espace de noms du référent. Lorsqu'il n'est pas spécifié, l'espace de noms local est déduit.

Attribut

Champ	Description
`name` Type : `string`	Clé de l'attribut.
`value` Type : `string`	Valeur de l'attribut.

APIOperationSet

Champ	Description
`apiVersion` Type : `string`	`apim.googleapis.com/v1`
`kind` Type : `string`	`APIOperationSet`
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : APIOperationSetSpec	Définit l'état souhaité de l'APIOperationSet.

APIOperationSetSpec

Champ	Description
`quota` Type : Quota	Définition du quota.
`restOperations` Type : `Array`	Tableau de définitions RESTOperation.
`apiProductRefs` Type : `Array`	Tableau de ressources APIProductRef ou de références à des produits d'API auxquels les RESTOperations doivent s'appliquer.

Quota

Champ	Description
`limit` Type : `integer`	Nombre de messages de requête autorisés par application par le produit API pour les `interval` et `timeUnit` spécifiés.
`interval` Type : `integer`	Intervalle de temps sur lequel le nombre de messages de requête est calculé.
`timeUnit` Type : `string`	Unité de temps définie pour l'intervalle. Les valeurs valides sont `minute`, `hour`, `day` ou `month`.

RESTOperation

Champ	Description
`name` Type : `string`	Nom de l'opération REST.
`path` Type : `string`	En combinaison avec `methods`, `path` correspond au chemin HTTP à faire correspondre pour un quota et/ou pour un produit d'API.
`methods` Type : `array`	En combinaison avec `path`, `methods` est la liste (sous la forme `strings`) des méthodes HTTP applicables à associer pour un quota et/ou pour un produit API.

ApiProductRef

Champ	Description
`name` Type : `string`	Nom de la ressource cible.
`kind` Type : `string`	`APIProduct`
`group` Type : `string`	Le APIGroup pour l'opérateur APIM Apigee, qui est `apim.googleapis.com`.
`namespace` Type : `string`	(Facultatif) Espace de noms du référent. Lorsqu'il n'est pas spécifié, l'espace de noms local est déduit.

APIMExtensionPolicy

Champ	Description
`apiVersion` Type : `string`	`apim.googleapis.com/v1`
`kind` Type : `string`	APIMExtensionPolicy
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : APIMExtensionPolicySpec	Définit l'état souhaité d'APIMExtensionPolicy.

APIMExtensionPolicySpec

Champ	Description
`apigeeEnv`	(Facultatif) Environnement Apigee. Si vous n'indiquez pas d'environnement, un nouvel environnement est créé et associé à toutes les instances disponibles. Si cet environnement est fourni, il doit être associé à toutes les instances disponibles lors de l'utilisation d'un équilibreur de charge externe global.
`failOpen` Type : `boolean`	Indique s'il faut ouvrir l'accès lorsque le runtime Apigee est inaccessible. Si la valeur est définie sur `true`, les appels à l'environnement d'exécution Apigee seront considérés comme réussis, même si l'environnement d'exécution est inaccessible.
`timeout` Type : `string`	Spécifie le délai avant expiration des appels au runtime Apigee, en secondes ou en millisecondes. Par exemple, `10s`.
`targetRef` Type : ExtensionServerRef	Identifie la passerelle Google Kubernetes Engine sur laquelle l'extension doit être installée.
`location` Type : `string`	Identifie l'emplacement Google Cloud où APIMExtensionPolicy est appliqué.
`supportedEvents` Type : `List` événements	Spécifie la liste des événements du processeur d'extension envoyés à Apigee. Voici quelques exemples : `"REQUEST_HEADERS"` `"RESPONSE_HEADERS"` `"REQUEST_BODY"` (Bêta) `"RESPONSE_BODY"` (Bêta) `"REQUEST_TRAILERS"` `"RESPONSE_TRAILERS"`

ExtensionServerRef

Champ	Description
`name` Type : `string`	Nom de la ressource cible.
`kind` Type : `string`	Spécifie le `kind` de la ressource cible, par exemple `Gateway` ou `Service`.
`group` Type : `string`	Le APIGroup pour l'opérateur APIM Apigee, qui est `apim.googleapis.com`.
`namespace` Type : `string`	(Facultatif) Espace de noms du référent. Lorsqu'il n'est pas spécifié, l'espace de noms local est déduit.

ApigeeGatewayPolicy

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	ApigeeGatewayPolicy
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : ApigeeGatewayPolicySpec	Définit l'état souhaité d'ApigeeGatewayPolicy.

ApigeeGatewayPolicySpec

Champ	Description
`ref` Type : ExtensionServerRef	Fait référence au modèle APIM créé pour régir les règles appliquées à la passerelle GKE.
`targetRef` Type : ExtensionServerRef	Fait référence à la règle d'extension APIM qui doit appliquer cette règle de passerelle spécifique. Fait indirectement référence à GKE Gateway.
`serviceAccount`	(Facultatif) Spécifie le compte de service utilisé pour générer des jetons d'authentification Google dans un proxy Apigee ProApigee.

ApimTemplate

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	ApimTemplate
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : ApimTemplateSpec	Définit l'état souhaité d'ApimTemplate.

ApimTemplateSpec

Champ	Description
`templates` Type : `list`	Liste des ressources ApimTemplateFlow qui spécifient les règles à exécuter dans le flux de requêtes.
`apimTemplateRule` Type : ExtensionServerRef	Spécifie la règle de modèle APIM à utiliser pour valider les règles appliquées.

ApimTemplateFlow

Champ	Description
`policies` Type : `list` ConditionalParameterReference	Liste des ressources ConditionalParameterReference qui spécifient la liste ordonnée des règles à exécuter dans le flux de requête.
`condition` Type : `string`	Spécifie les conditions d'exécution de cette ressource.

ConditionalParameterReference

Champ	Description
`condition` `Type: string`	Spécifie les conditions d'exécution de cette ressource.

ApimTemplateRule

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	ApimTemplateRule
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : ApimTemplateRuleSpec	Définit l'état souhaité d'ApimTemplateRule.

ApimTemplateRuleSpec

Champ	Description
`requiredList`	Liste des règles (sous la forme `strings`) qui doivent être présentes dans ApimTemplate.
`denyList`	Liste des règles (sous la forme `strings`) qui ne doivent pas figurer dans ApimTemplate.
`allowList`	Liste des règles (sous forme de `strings`) qui peuvent être présentes dans ApimTemplate, mais qui ne sont pas obligatoires.
`override` Type : `boolean`	Remplace les mises à jour de la règle de modèle APIM dans le cas où des modèles APIM utilisant la règle existent. Les valeurs valides sont `true` ou `false`.

AssignMessage (injection de jetonGoogle )

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	AssignMessage
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : AssignMessageBean	Définit l'état souhaité de la stratégie AssignMessage.

AssignMessageBean

Champ	Description
`setActions` Type : `array`	Tableau d'objets `SetActionsBean`. Remplace les valeurs des propriétés existantes dans la requête ou la réponse, comme spécifié par l'élément `AssignTo`. Si les en-têtes ou les paramètres sont déjà présents dans le message d'origine, `setActions` écrase les valeurs. Sinon, `setActions` ajoute les en-têtes ou les paramètres spécifiés.
`AssignTo` Type : AssignToBean	Indique le message sur lequel la stratégie AssignMessage fonctionne. Les options incluent la requête, la réponse ou un nouveau message personnalisé.

SetActionsBean

Champ	Description
`Authentication` Type : AuthenticationBean	Génère des jetons OAuth 2.0 ou OpenID Connect pour effectuer des appels authentifiés aux services Google ou aux services personnalisés exécutés sur certains produits Google Cloud , tels que les fonctions Cloud Run et Cloud Run. Google

AuthenticationBean

Champ	Description
`GoogleAccessToken` Type : GoogleAccessTokenBean	Génère des jetons Google OAuth 2.0 pour effectuer des appels authentifiés aux services Google.
`GoogleIDToken` Type : GoogleIDTokenBean	Configuration permettant de générer un jeton OpenID Connect pour authentifier la requête cible.
`headerName` Type : `string`	Par défaut, lorsqu'une configuration d'authentification est présente, Apigee génère un jeton d'authentification et l'injecte dans l'en-tête Authorization du message envoyé au système cible. L'élément `headerName` vous permet de spécifier le nom d'un autre en-tête pour contenir le jeton de support.

GoogleAccessTokenBean

Champ	Description
`scopes` Type : `array`	Tableau de `strings` qui spécifie un champ d'application d'API Google valide. Pour en savoir plus, consultez Champs d'application OAuth 2.0 pour les API Google.
`LifetimeInSeconds` Type : `integer`	Spécifie la durée de vie du jeton d'accès en secondes.

GoogleIDTokenBean

Champ	Description
`Audience` Type : AudienceBean	Audience du jeton d'authentification généré, comme l'API ou le compte de service auquel le jeton accorde l'accès.
`IncludeEmail` Type : `boolean`	S'il est défini sur `true`, le jeton d'authentification généré contient les revendications du compte de service `email` et `email_verified`.

AudienceBean

Champ	Description
`useTargetHost` Type : `string`	Si la valeur de `Audience` est vide ou si la variable `ref` ne correspond pas à une valeur valide et que `useTargetUrl` est `true`, l'URL de la cible (sans les paramètres de requête) est utilisée comme audience.
`useTargetUrl` Type : `boolean`	La valeur par défaut de `useTargetUrl` est `false`.

AssignToBean

Champ	Description
`createNew` Type : `boolean`	Détermine si la règle crée un message lors de l'attribution de valeurs. S'il est défini sur `true`, la règle crée un message.
`type` Type : `string`	Spécifie le type du nouveau message, lorsque `CreateNew` est défini sur `true`. Les valeurs valides sont request ou response.

JavaScript

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	JavaScript
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : JavascriptBean	Définit l'état souhaité de la règle JavaScript.

JavascriptBean

Champ	Description
`mode` Type : `array`	Tableau de `strings` qui spécifie `ProxyRequest` ou `ProxyResponse`. Détermine si la règle est associée au flux de requête ou au flux de réponse.
`source` Type : `string`	Code JavaScript intégré.
`timeLimit` Type : `integer`	Spécifie le délai avant expiration pour l'exécution du code JavaScript.

KVM

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	KVM
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : KeyValueMapOperationsBean	Définit l'état souhaité de la règle KVM.

KeyValueMapOperationsBean

Champ	Description
`MapName` Type : `MapName`	Permet à la règle d'identifier le KVM à utiliser de manière dynamique, au moment de l'exécution.
`expiryTimeInSecs` Type : `integer`	Spécifie la durée, en secondes, après laquelle Apigee actualise sa valeur mise en cache à partir du KVM spécifié.
`initialEntries` Type : `list`	Valeurs sources des KVM insérées dans le KVM lors de son initialisation.

OASValidation

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	OASValidation
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : OASValidationBean	Définit l'état souhaité de la règle OASValidation.

OASValidationBean

Champ	Description
`openApiSpec` Type : `string`	Spécifie la spécification OpenAPI dans `yaml` à valider. Comme il s'agit d'un fragment `yaml` multiligne, utilisez le délimiteur "\|".
`source` Type : `string`	Spécifiez l'un des types suivants : `message`, `request` ou `response`. Lorsqu'il est défini sur `request`, il évalue les requêtes entrantes provenant des applications clientes. Lorsqu'il est défini sur `response`, il évalue les réponses des serveurs cibles. Lorsqu'il est défini sur `message`, il évalue automatiquement la requête ou la réponse selon que la règle est associée au flux de requête ou de réponse.
`options` Type : `OASValidationOptions`	Consultez OASValidationOptions/td>

OASValidationOptions

Champ	Description
`validateMessageBody` Type : `boolean`	Spécifie si la règle doit valider le corps du message par rapport au schéma du corps de la requête de l'opération dans la spécification OpenAPI. Définissez la valeur sur `true` pour valider le contenu du corps du message. Définissez la valeur sur `false` pour confirmer que le corps du message existe.
`allowUnspecifiedParameters` Type : `StrictOptions`	Consultez StrictOptions.

StrictOptions

Champ	Description
`header` Type : `boolean`	Pour autoriser la spécification des paramètres d'en-tête dans la requête qui ne sont pas définis dans la spécification OpenAPI, définissez ce paramètre sur `true`. Sinon, définissez ce paramètre sur `false` pour que l'exécution de la stratégie échoue.
`query` Type : `boolean`	Pour autoriser la spécification des paramètres de requête dans la requête qui ne sont pas définis dans la spécification OpenAPI, définissez ce paramètre sur `true`. Sinon, définissez ce paramètre sur `false` pour que l'exécution de la stratégie échoue.
`cookie` Type : `boolean`	Pour autoriser la spécification des paramètres de cookies dans la requête qui ne sont pas définis dans la spécification OpenAPI, définissez ce paramètre sur `true`. Sinon, définissez ce paramètre sur `false` pour que l'exécution de la stratégie échoue.

APIMResourceStatus

Champ	Description
`currentState` Type : `enum`	Indique l'état actuel de la ressource : `RUNNING` : la ressource est en cours d'exécution. `CREATING` : la ressource est en cours de création `CREATED` : la ressource a été créée `UPDATING` : la ressource est en cours de mise à jour. `DELETING` : la ressource est en cours de suppression `CREATE_UPDATE_FAILED` : échec de l'opération de création ou de mise à jour `DELETE_FAILED` : échec de la suppression
`errorMessage` Type : `string`	Message d'erreur lié à l'un des états d'échec du champ `currentState`.
`operationResult` Type : `string`	Chaîne de réponse de l'une des opérations de longue durée liées à la création, à la mise à jour ou à la suppression de ressources.

ServiceCallout

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	ServiceCallout
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : ServiceCalloutBean	Définit l'état souhaité de la règle ServiceCallout.

ServiceCalloutBean

Champ	Description
`httpTargetConnection` Type : `HttpTargetConnection`	Fournit des informations sur le transport, telles que les propriétés d'URL, TLS/SSL et HTTP.
`request` Type : CalloutRequest	Spécifie la variable contenant le message de requête envoyé par le proxy d'API à l'autre service.
`Response` Type : `string`	Spécifie la variable contenant le message de réponse renvoyé au proxy d'API par le service externe.

HttpTargetConnection

Champ	Description
`url` Type : `string`	URL du service cible.
`properties` Type : `Map of <string, string>`	Propriétés de transport HTTP au service de backend. Pour en savoir plus, consultez la documentation de référence sur les propriétés des points de terminaison.

CalloutRequest

Champ	Description
`url` Type : `string`	URL du service cible.
`properties` Type : `Map of <string, string>`	Propriétés de transport HTTP au service de backend. Pour en savoir plus, consultez la documentation de référence sur les propriétés des points de terminaison.

SpikeArrest

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	SpikeArrest
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : SpikeArrestBean	Définit l'état souhaité de la règle SpikeArrest.

SpikeArrestBean

Champ	Description
`mode` Type : `array`	Tableau de `strings` qui spécifie `ProxyRequest` ou `ProxyResponse`. Détermine si la règle est associée au flux de requête ou au flux de réponse.
`peakMessageRate` Type : peakMessageRate	Spécifie le taux de messages pour SpikeArrest.
`useEffectiveCount` Type : `boolean`	Si la valeur est `true`true, SpikeArrest est distribué dans une région, avec le décompte des requêtes synchronisé entre les processeurs de messages (MP) Apigee d'une même région. Si la valeur est `false`, SpikeArrest utilise un algorithme token bucket en local. Pour en savoir plus, consultez UseEffectiveCount.

peakMessageRate

Champ	Description
`ref` Type : `string`	Variable faisant référence à la valeur `rate`.
`value` Type : `string`	Valeur `rate` réelle si aucune référence n'est disponible.

Règle ResponseCache

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1
`kind` Type : `string`	ResponseCache
`metadata` Type : Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type : APIExtensionPolicySpec	Définit l'état souhaité de ResponseCache.

ResponseCacheBean

Champ	Description
`mode` Type : `boolean`	Spécifie `ProxyRequest` ou `ProxyResponse`. Détermine si la règle est associée au flux de requête ou au flux de réponse.
`cacheExpiry` Type : cacheExpiry	Fournit l'objet cacheExpiry.
`cacheKey` Type : cacheKey	Fournit l'objet cacheKey.
`cacheLookupTimeOut` Type : `integer`	Spécifie le délai avant expiration de la recherche dans le cache.
`cacheResourceRef` Type : `string`	Spécifie l'identifiant de ressource du cache à l'aide d'une référence de variable.
`excludeErrorResponse` Type : `boolean`	Cette règle peut mettre en cache les réponses HTTP associées à n'importe quel code d'état. Cela signifie que les réponses de réussite et d'erreur peuvent être mises en cache, y compris les codes d'état `2xx` et `3xx`.
`skipCacheLookupCondition` Type : `string`	Définit une expression qui, si elle est définie sur `true` au moment de l'exécution, spécifie que la recherche dans le cache doit être ignorée et le cache actualisé.
`skipCachePopulationCondition` Type : `string`	Définit une expression qui, si elle est définie sur	Définit une expression qui, si elle est définie sur `true` au moment de l'exécution, spécifie que la recherche dans le cache doit être ignorée et le cache actualisé au moment de l'exécution, spécifie qu'une écriture dans le cache doit être ignorée.
`useAcceptHeader` Type : `boolean`	Définissez cet élément sur `true` pour ajouter des valeurs issues des en-têtes `Accept` de la réponse à la clé de cache de l'entrée de cache de réponse.
`useResponseCacheHeaders` Type : `boolean`	Définissez cet élément sur `true` pour que les en-têtes de réponse HTTP soient pris en compte lors de la définition de la valeur TTL (Time To Live) de la réponse dans le cache.

cacheExpiry

Champ	Description
`expiryDate` Type : `object`	Spécifie la date d'expiration d'une entrée de cache.
`timeOfDay` Type : `object`	Spécifie l'heure à laquelle une entrée de cache doit expirer.
`timeoutInSeconds` Type : `object`	Indique le nombre de secondes après lesquelles une entrée de cache doit expirer.

cacheKey

Champ	Description
`cacheKeyPrefix` Type : `string`	Spécifie une valeur à utiliser comme préfixe de clé de cache.
`fragments` Type : `object`	Spécifie une valeur à inclure dans la clé de cache pour créer un espace de noms pour les requêtes correspondantes aux réponses mises en cache.

Documentation de référence de l'opérateur Apigee APIM pour les ressources Kubernetes Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.