REST Resource: projects.locations.grpcRoutes

Risorsa: GrpcRoute

GrpcRoute è la risorsa che definisce il modo in cui viene instradato il traffico gRPC da una risorsa mesh o gateway.

Rappresentazione JSON 
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "hostnames": [
    string
  ],
  "meshes": [
    string
  ],
  "gateways": [
    string
  ],
  "rules": [
    {
      object (RouteRule)
    }
  ]
}
Campi
name

string

Identificatore. Nome della risorsa GrpcRoute. Corrisponde al pattern projects/*/locations/global/grpcRoutes/<grpc_route_name>
createTime

string (Timestamp format)

Solo output. Timestamp di creazione della risorsa.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo output. Timestamp dell'aggiornamento della risorsa.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Facoltativo. Set di tag etichetta associati alla risorsa GrpcRoute.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

Facoltativo. Una descrizione in formato libero della risorsa. Lunghezza massima 1024 caratteri.
hostnames[]

string

Obbligatorio. Nomi host del servizio con una porta facoltativa per cui questa route descrive il traffico.

Formato: [:]

Il nome host è il nome di dominio completo di un host di rete. Corrisponde alla definizione di nome host RFC 1123 con due eccezioni degne di nota: - Gli IP non sono consentiti. - Un nome host può essere preceduto da un'etichetta jolly (*.). L'etichetta jolly deve essere visualizzata da sola come prima etichetta.

Il nome host può essere "esatto", ovvero un nome di dominio senza il punto finale di un host di rete (ad es. foo.example.com) o "con caratteri jolly", ovvero un nome di dominio preceduto da una singola etichetta con caratteri jolly (ad es. *.example.com).

Tieni presente che, in base a RFC1035 e RFC1123, un'etichetta deve essere composta da caratteri alfanumerici minuscoli o "-" e deve iniziare e terminare con un carattere alfanumerico. Non è consentita altra punteggiatura.

Le route associate a una mesh o a un gateway devono avere nomi host univoci. Se tenti di collegare più route con nomi host in conflitto, la configurazione verrà rifiutata.

Ad esempio, mentre è accettabile che le route per i nomi host *.foo.bar.com e *.bar.com siano associate alla stessa route, non è possibile associare due route sia a *.bar.com sia a bar.com.

Se viene specificata una porta, i client gRPC devono utilizzare l'URI del canale con la porta per corrispondere a questa regola (ad es. "xds:///service:123"), altrimenti devono fornire l'URI senza una porta (ad es. "xds:///service").
meshes[]

string

Facoltativo. Meshes definisce un elenco di mesh a cui è collegata questa GrpcRoute, come una delle regole di routing per instradare le richieste gestite dalla mesh.

Ogni riferimento alla mesh deve corrispondere al pattern: projects/*/locations/global/meshes/<mesh_name>
gateways[]

string

Facoltativo. Gateways definisce un elenco di gateway a cui è collegata questa GrpcRoute, come una delle regole di routing per instradare le richieste gestite dal gateway.

Ogni riferimento al gateway deve corrispondere al pattern: projects/*/locations/global/gateways/<gateway_name>
rules[]

object (RouteRule)

Obbligatorio. Un elenco di regole dettagliate che definiscono come instradare il traffico.

All'interno di una singola GrpcRoute, verrà eseguita l'azione GrpcRoute.RouteAction associata alla prima GrpcRoute.RouteRule corrispondente. Deve essere fornita almeno una regola.

RouteRule

Descrive come instradare il traffico.

Rappresentazione JSON 
{
  "matches": [
    {
      object (RouteMatch)
    }
  ],
  "action": {
    object (RouteAction)
  }
}
Campi
matches[]

object (RouteMatch)

Facoltativo. Le corrispondenze definiscono le condizioni utilizzate per confrontare la regola con le richieste gRPC in entrata. Ogni corrispondenza è indipendente, ovvero questa regola verrà soddisfatta se viene soddisfatta UNA QUALSIASI delle corrispondenze. Se non viene specificato alcun campo di corrispondenze, questa regola corrisponderà incondizionatamente al traffico.
action

object (RouteAction)

Obbligatorio. Una regola dettagliata che definisce come instradare il traffico. Questo campo è obbligatorio.

RouteMatch

Criteri per la corrispondenza del traffico. Una RouteMatch verrà considerata una corrispondenza quando tutti i campi forniti corrispondono.

Rappresentazione JSON 
{
  "headers": [
    {
      object (HeaderMatch)
    }
  ],
  "method": {
    object (MethodMatch)
  }
}
Campi
headers[]

object (HeaderMatch)

Facoltativo. Specifica una raccolta di intestazioni da abbinare.
method

object (MethodMatch)

Facoltativo. Un metodo gRPC da confrontare. Se questo campo è vuoto o omesso, verrà trovata una corrispondenza per tutti i metodi.

MethodMatch

Specifica una corrispondenza con un metodo.

Rappresentazione JSON 
{
  "type": enum (Type),
  "grpcService": string,
  "grpcMethod": string,
  "caseSensitive": boolean
}
Campi
type

enum (Type)

Facoltativo. Specifica come eseguire la corrispondenza con il nome. Se non specificato, viene utilizzato il valore predefinito "EXACT".
grpcService

string

Obbligatorio. Nome del servizio da confrontare. Se non specificato, corrisponderà a tutti i servizi.
grpcMethod

string

Obbligatorio. Nome del metodo da abbinare. Se non specificato, corrisponderà a tutti i metodi.
caseSensitive

boolean

Facoltativo. Specifica che le corrispondenze sono sensibili alle maiuscole. Il valore predefinito è true. caseSensitive non deve essere utilizzato con un tipo di REGULAR_EXPRESSION.

Tipo

Il tipo di partita.

Enum
TYPE_UNSPECIFIED Non specificato.
EXACT Corrisponderà solo al nome esatto fornito.
REGULAR_EXPRESSION Interpreterà grpcMethod e grpcService come espressioni regolari. È supportata la sintassi RE2.

HeaderMatch

Una corrispondenza con una raccolta di intestazioni.

Rappresentazione JSON 
{
  "type": enum (Type),
  "key": string,
  "value": string
}
Campi
type

enum (Type)

Facoltativo. Specifica come eseguire la corrispondenza con il valore dell'intestazione. Se non specificato, viene utilizzato il valore predefinito EXACT.
key

string

Obbligatorio. La chiave dell'intestazione.
value

string

Obbligatorio. Il valore dell'intestazione.

Tipo

Il tipo di corrispondenza.

Enum
TYPE_UNSPECIFIED Non specificato.
EXACT Corrisponderà solo al valore esatto fornito.
REGULAR_EXPRESSION Corrisponderanno ai percorsi conformi al prefisso specificato dal valore. È supportata la sintassi RE2.

RouteAction

Specifica come instradare il traffico corrispondente.

Rappresentazione JSON 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "faultInjectionPolicy": {
    object (FaultInjectionPolicy)
  },
  "timeout": string,
  "retryPolicy": {
    object (RetryPolicy)
  },
  "statefulSessionAffinity": {
    object (StatefulSessionAffinityPolicy)
  },
  "idleTimeout": string
}
Campi
destinations[]

object (Destination)

Facoltativo. I servizi di destinazione a cui deve essere inoltrato il traffico. Se vengono specificate più destinazioni, il traffico verrà suddiviso tra i servizi di backend in base al campo peso di queste destinazioni.
faultInjectionPolicy

object (FaultInjectionPolicy)

Facoltativo. La specifica per l'inserimento di errori nel traffico per testare la resilienza dei client all'interruzione del servizio di destinazione. Nell'ambito dell'inserimento di errori, quando i client inviano richieste a una destinazione, è possibile introdurre ritardi su una percentuale di richieste prima di inviarle al servizio di destinazione. Allo stesso modo, le richieste dei client possono essere interrotte per una percentuale di richieste.

timeout e retryPolicy verranno ignorati dai client configurati con un criterio faultInjectionPolicy
timeout

string (Duration format)

Facoltativo. Specifica il timeout per l'itinerario selezionato. Il timeout viene calcolato dal momento in cui la richiesta è stata elaborata completamente (ovvero la fine dello stream) fino al momento in cui la risposta è stata elaborata completamente. Il timeout include tutti i tentativi.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
retryPolicy

object (RetryPolicy)

Facoltativo. Specifica i criteri per i nuovi tentativi associati a questa route.
statefulSessionAffinity

object (StatefulSessionAffinityPolicy)

Facoltativo. Specifica l'affinità sessione stateful basata su cookie.
idleTimeout

string (Duration format)

Facoltativo. Specifica il timeout di inattività per la route selezionata. Il timeout di inattività è definito come il periodo in cui non vengono inviati o ricevuti byte sulla connessione upstream o downstream. Se non viene impostato, il timeout di inattività predefinito è 1 ora. Se impostato su 0 secondi, il timeout verrà disattivato.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

Destinazione

La destinazione a cui verrà indirizzato il traffico.

Rappresentazione JSON 
{

  // Union field destination_type can be only one of the following:
  "serviceName": string
  // End of list of possible types for union field destination_type.
  "weight": integer
}
Campi
Campo unione destination_type. Specifica il tipo di destinazione a cui verrà indirizzato il traffico. destination_type può essere solo uno dei seguenti:
serviceName

string

Obbligatorio. L'URL di un servizio di destinazione a cui indirizzare il traffico. Deve fare riferimento a un BackendService o a un ServiceDirectoryService.
weight

integer

Facoltativo. Specifica la proporzione di richieste inoltrate al backend a cui fa riferimento il campo serviceName. Questo valore viene calcolato come: - peso/somma(pesi in questo elenco di destinazioni). Per i valori diversi da zero, potrebbe esserci un epsilon rispetto alla proporzione esatta definita qui, a seconda della precisione supportata da un'implementazione.

Se viene specificato un solo serviceName e ha un peso maggiore di 0, il 100% del traffico viene inoltrato a quel backend.

Se vengono specificati pesi per un nome di servizio, devono essere specificati per tutti.

Se i pesi non sono specificati per tutti i servizi, il traffico viene distribuito in proporzioni uguali a tutti.

FaultInjectionPolicy

La specifica per l'inserimento di errori nel traffico per testare la resilienza dei client all'interruzione del servizio di destinazione. Nell'ambito dell'inserimento di errori, quando i client inviano richieste a una destinazione, è possibile introdurre ritardi su una percentuale di richieste prima di inviarle al servizio di destinazione. Allo stesso modo, le richieste dei client possono essere interrotte per una percentuale di richieste.

Rappresentazione JSON 
{
  "delay": {
    object (Delay)
  },
  "abort": {
    object (Abort)
  }
}
Campi
delay

object (Delay)

La specifica per l'inserimento di ritardi nelle richieste client.
abort

object (Abort)

La specifica per l'interruzione delle richieste client.

Ritardo

Specifica di come le richieste client vengono ritardate nell'ambito dell'inserimento di errori prima di essere inviate a una destinazione.

Rappresentazione JSON 
{
  "fixedDelay": string,
  "percentage": integer
}
Campi
fixedDelay

string (Duration format)

Specifica un ritardo fisso prima di inoltrare la richiesta.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
percentage

integer

La percentuale di traffico su cui verrà inserito il ritardo.

Il valore deve essere compreso tra [0, 100]

Interrompi

Specifica di come le richieste client vengono interrotte nell'ambito dell'inserimento di errori prima di essere inviate a una destinazione.

Rappresentazione JSON 
{
  "httpStatus": integer,
  "percentage": integer
}
Campi
httpStatus

integer

Il codice di stato HTTP utilizzato per interrompere la richiesta.

Il valore deve essere compreso tra 200 e 599 inclusi.
percentage

integer

La percentuale di traffico che verrà interrotta.

Il valore deve essere compreso tra [0, 100]

RetryPolicy

Le specifiche per i nuovi tentativi. Specifica una o più condizioni a cui si applica questa regola di ripetizione. I valori validi sono:

Rappresentazione JSON 
{
  "retryConditions": [
    string
  ],
  "numRetries": integer
}
Campi
retryConditions[]

string

  • connect-failure: il router ripeterà i tentativi in caso di errori di connessione ai servizi di backend, ad esempio a causa di timeout della connessione.
  • refused-stream: il router riproverà se il servizio di backend reimposta lo stream con un codice di errore REFUSED_STREAM. Questo tipo di ripristino indica che è sicuro riprovare.
  • annullato: il router riproverà se il codice di stato gRPC nell'intestazione della risposta è impostato su annullato
  • deadline-exceeded: il router riproverà se il codice di stato gRPC nell'intestazione della risposta è impostato su deadline-exceeded
  • resource-exhausted: il router riproverà se il codice di stato gRPC nell'intestazione della risposta è impostato su resource-exhausted
  • non disponibile: il router riproverà se il codice di stato gRPC nell'intestazione della risposta è impostato su non disponibile
numRetries

integer (uint32 format)

Specifica il numero consentito di tentativi. Questo numero deve essere maggiore di 0. Se non specificato, il valore predefinito è 1.

StatefulSessionAffinityPolicy

La specifica per l'affinità sessione stateful basata su cookie in cui il piano dati fornisce un "cookie di sessione" con il nome "GSSA" che codifica un host di destinazione specifico e ogni richiesta contenente quel cookie verrà indirizzata a quell'host finché l'host di destinazione rimane attivo e integro.

La libreria mesh senza proxy gRPC o il proxy sidecar gestirà il cookie di sessione, ma il codice dell'applicazione client è responsabile della copia del cookie da ogni RPC nella sessione a quella successiva.

Rappresentazione JSON 
{
  "cookieTtl": string
}
Campi
cookieTtl

string (Duration format)

Obbligatorio. Il valore TTL del cookie per l'intestazione Set-Cookie generata dal piano dati. La durata del cookie può essere impostata su un valore compreso tra 1 e 86.400 secondi (24 ore) inclusi.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

Metodi

create

 Crea una nuova GrpcRoute in un determinato progetto e in una determinata località.

delete

 Elimina una singola GrpcRoute.

get

 Recupera i dettagli di una singola GrpcRoute.

list

 Elenca le GrpcRoute in un determinato progetto e in una determinata località.

patch

 Aggiorna i parametri di una singola GrpcRoute.