REST Resource: projects.locations.tcpRoutes

Risorsa: TcpRoute

TcpRoute è la risorsa che definisce in che modo il traffico TCP deve essere instradato da una risorsa Mesh/Gateway.

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

string

Identificatore. Nome della risorsa TcpRoute. Corrisponde al pattern projects/*/locations/global/tcpRoutes/tcp_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".
description

string

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

object (RouteRule)

Obbligatorio. Regole che definiscono come viene instradato e gestito il traffico. Deve essere fornita almeno una RouteRule. Se sono presenti più regole, l'azione intrapresa sarà la prima regola corrispondente.
meshes[]

string

Facoltativo. Meshes definisce un elenco di mesh a cui è collegata questa TcpRoute, 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>

Il mesh allegato deve essere di tipo SIDECAR
gateways[]

string

Facoltativo. Gateways definisce un elenco di gateway a cui è collegata questa TcpRoute, 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>
labels

map (key: string, value: string)

Facoltativo. Set di tag etichetta associati alla risorsa TcpRoute.

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

RouteRule

Specifica come trovare la corrispondenza del traffico e come instradarlo quando viene trovata una corrispondenza.

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

object (RouteMatch)

Facoltativo. RouteMatch definisce il predicato utilizzato per abbinare le richieste a una determinata azione. Per la valutazione, i vari tipi di corrispondenza vengono combinati con l'operatore "OR". Se non viene specificato alcun campo routeMatch, questa regola corrisponderà incondizionatamente al traffico.
action

object (RouteAction)

Obbligatorio. La regola dettagliata che definisce come instradare il traffico corrispondente.

RouteMatch

RouteMatch definisce il predicato utilizzato per abbinare le richieste a una determinata azione. Per la valutazione, i vari tipi di corrispondenza vengono combinati con l'operatore "OR". Se non viene specificato alcun campo routeMatch, questa regola corrisponderà incondizionatamente al traffico.

Rappresentazione JSON 
{
  "address": string,
  "port": string
}
Campi
address

string

Obbligatorio. Deve essere specificato nel formato dell'intervallo CIDR. Un intervallo CIDR è costituito da un indirizzo IP e da una lunghezza del prefisso per costruire la subnet mask. Per impostazione predefinita, la lunghezza del prefisso è 32 (ovvero corrisponde a un singolo indirizzo IP). Sono supportati solo gli indirizzi IPv4. Esempi: "10.0.0.1" - corrisponde a questo indirizzo IP esatto. "10.0.0.0/8": corrisponde a qualsiasi indirizzo IP all'interno della subnet 10.0.0.0 e della maschera 255.255.255.0. "0.0.0.0/0" - corrisponde a qualsiasi indirizzo IP.
port

string

Obbligatorio. Specifica la porta di destinazione a cui abbinare la regola.

RouteAction

Le specifiche per il routing del traffico e l'applicazione dei criteri associati.

Rappresentazione JSON 
{
  "destinations": [
    {
      object (RouteDestination)
    }
  ],
  "originalDestination": boolean,
  "idleTimeout": string
}
Campi
destinations[]

object (RouteDestination)

Facoltativo. I servizi di destinazione a cui deve essere inoltrato il traffico. È necessario almeno un servizio di destinazione. È possibile impostare solo una delle destinazioni dell'itinerario o la destinazione originale.
originalDestination

boolean

Facoltativo. Se è true, il router utilizzerà l'IP e la porta di destinazione della connessione originale come destinazione della richiesta. Il valore predefinito è false. È possibile impostare solo una delle destinazioni dell'itinerario o la destinazione originale.
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 è 30 secondi. 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".

RouteDestination

Descrivi la destinazione a cui indirizzare il traffico.

Rappresentazione JSON 
{
  "serviceName": string,
  "weight": integer
}
Campi
serviceName

string

Obbligatorio. L'URL di un BackendService a cui indirizzare il traffico.
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.

Metodi

create

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

delete

 Elimina un singolo TcpRoute.

get

 Recupera i dettagli di una singola TcpRoute.

list

 Elenca TcpRoute in un determinato progetto e località.

patch

 Aggiorna i parametri di una singola TcpRoute.