REST Resource: projects.locations.endpointPolicies

Ressource: EndpointPolicy

EndpointPolicy ist eine Ressource, mit der Sie die gewünschte Konfiguration auf die Endpunkte anwenden können, die bestimmte Kriterien erfüllen. Diese Ressource kann beispielsweise verwendet werden, um die „Authentifizierungskonfiguration“ auf alle Endpunkte anzuwenden, die Port 8080 bedienen.

JSON-Darstellung
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "type": enum (EndpointPolicyType),
  "authorizationPolicy": string,
  "endpointMatcher": {
    object (EndpointMatcher)
  },
  "trafficPortSelector": {
    object (TrafficPortSelector)
  },
  "description": string,
  "serverTlsPolicy": string,
  "clientTlsPolicy": string
}
Felder
name

string

ID. Name der EndpointPolicy-Ressource. Entspricht dem Muster projects/{project}/locations/*/endpointPolicies/{endpointPolicy}.

createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Ressource erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel der Ressourcenaktualisierung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

labels

map (key: string, value: string)

Optional. Eine Reihe von Label-Tags, die der EndpointPolicy-Ressource zugeordnet sind.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

type

enum (EndpointPolicyType)

Erforderlich. Der Typ der Endpunktrichtlinie. Dies wird hauptsächlich zur Validierung der Konfiguration verwendet.

authorizationPolicy

string

Optional. In diesem Feld wird die URL der AuthorizationPolicy-Ressource angegeben, die Autorisierungsrichtlinien auf den eingehenden Traffic an den übereinstimmenden Endpunkten anwendet. Weitere Informationen finden Sie unter „Autorisierung“. Wenn dieses Feld nicht angegeben ist, wird die Autorisierung für diesen Endpunkt deaktiviert(keine Autorisierungsprüfungen).

endpointMatcher

object (EndpointMatcher)

Erforderlich. Ein Abgleich, der Endpunkte auswählt, auf die die Richtlinien angewendet werden sollen.

trafficPortSelector

object (TrafficPortSelector)

Optional. Portauswahl für die (übereinstimmenden) Endpunkte. Wenn kein Port-Selektor angegeben ist, wird die übereinstimmende Konfiguration auf alle Ports angewendet.

description

string

Optional. Eine Textbeschreibung der Ressource. Maximale Länge: 1.024 Zeichen.

serverTlsPolicy

string

Optional. Eine URL, die auf die ServerTlsPolicy-Ressource verweist. Mit „ServerTlsPolicy“ wird die Authentifizierungsrichtlinie bestimmt, die angewendet werden soll, um den eingehenden Traffic an den identifizierten Backends zu beenden. Wenn dieses Feld nicht festgelegt ist, ist die Authentifizierung für diesen Endpunkt deaktiviert(offen).

clientTlsPolicy
(deprecated)

string

Optional. Verworfen: Dieses Feld wird nicht verwendet und ist ein No-Op. Eine URL, die auf eine ClientTlsPolicy-Ressource verweist. „ClientTlsPolicy“ kann festgelegt werden, um die Authentifizierung für Traffic vom Proxy zu den tatsächlichen Endpunkten anzugeben. Genauer gesagt wird sie auf den ausgehenden Traffic vom Proxy zum Endpunkt angewendet. Dies wird normalerweise für das Sidecar-Modell verwendet, bei dem sich der Proxy gegenüber der Steuerungsebene als Endpunkt identifiziert. Die Verbindung zwischen Sidecar und Endpunkt erfordert eine Authentifizierung. Wenn dieses Feld nicht festgelegt ist, ist die Authentifizierung deaktiviert(offen). Gilt nur, wenn EndpointPolicyType SIDECAR_PROXY ist.

EndpointPolicyType

Der Typ der Endpunktrichtlinie.

Enums
ENDPOINT_POLICY_TYPE_UNSPECIFIED Standardwert. Darf nicht verwendet werden.
SIDECAR_PROXY Stellt einen Proxy dar, der als Sidecar bereitgestellt wird.
GRPC_SERVER Stellt ein proxyfreies gRPC-Backend dar.

EndpointMatcher

Eine Definition eines Abgleichers, der Endpunkte auswählt, auf die die Richtlinien angewendet werden sollen.

JSON-Darstellung
{

  // Union field matcher_type can be only one of the following:
  "metadataLabelMatcher": {
    object (MetadataLabelMatcher)
  }
  // End of list of possible types for union field matcher_type.
}
Felder
Union-Feld matcher_type. Gibt den Typ des Abgleichs an, der für diesen Endpunktabgleich verwendet wird. Für matcher_type ist nur einer der folgenden Werte zulässig:
metadataLabelMatcher

object (MetadataLabelMatcher)

Der Abgleich basiert auf Knotenmetadaten, die von xDS-Clients bereitgestellt werden.

MetadataLabelMatcher

Der Abgleich, der auf Knotenmetadaten basiert, die von xDS-Clients bereitgestellt werden.

JSON-Darstellung
{
  "metadataLabelMatchCriteria": enum (MetadataLabelMatchCriteria),
  "metadataLabels": [
    {
      object (MetadataLabels)
    }
  ]
}
Felder
metadataLabelMatchCriteria

enum (MetadataLabelMatchCriteria)

Gibt an, wie der Abgleich erfolgen soll.

Unterstützte Werte sind: MATCH_ANY: Mindestens eines der im Abgleich angegebenen Labels muss mit den vom xDS-Client bereitgestellten Metadaten übereinstimmen. MATCH_ALL: Die vom xDS-Client bereitgestellten Metadaten müssen alle hier angegebenen Labels enthalten.

Die Auswahl wird anhand der besten Übereinstimmung bestimmt. Angenommen, es gibt drei EndpointPolicy-Ressourcen P1, P2 und P3. Wenn P1 den Abgleich MATCH_ANY <A:1, B:1>, P2 MATCH_ALL <A:1,B:1> und P3 MATCH_ALL <A:1,B:1,C:1> hat.

Wenn ein Client mit dem Label <A:1> eine Verbindung herstellt, wird die Konfiguration von P1 ausgewählt.

Wenn ein Client mit dem Label <A:1,B:1> eine Verbindung herstellt, wird die Konfiguration aus P2 ausgewählt.

Wenn ein Client mit dem Label <A:1,B:1,C:1> eine Verbindung herstellt, wird die Konfiguration von P3 ausgewählt.

Wenn es mehr als eine beste Übereinstimmung gibt (z. B. wenn eine Konfiguration P4 mit dem Selektor <A:1,D:1> vorhanden ist und ein Client mit dem Label <A:1,B:1,D:1> eine Verbindung herstellt), wählen Sie die mit der älteren Erstellungszeit aus.

metadataLabels[]

object (MetadataLabels)

Die Liste der Label-Wert-Paare, die mit Labels in den bereitgestellten Metadaten basierend auf „filterMatchCriteria“ übereinstimmen müssen. Diese Liste kann maximal 64 Einträge enthalten. Die Liste kann leer sein, wenn das Übereinstimmungskriterium MATCH_ANY ist, um eine Platzhalterübereinstimmung anzugeben (d. h. diese Regel gilt für alle Clients).

MetadataLabelMatchCriteria

Mögliche Kriterienwerte, die die Logik für den Abgleich definieren.

Enums
METADATA_LABEL_MATCH_CRITERIA_UNSPECIFIED Standardwert. Sollte nicht verwendet werden.
MATCH_ANY Mindestens eines der im Abgleich angegebenen Labels muss mit den vom xDS-Client bereitgestellten Metadaten übereinstimmen.
MATCH_ALL Die vom xDS-Client bereitgestellten Metadaten sollten alle hier angegebenen Labels enthalten.

MetadataLabels

Definiert einen Name-Paar-Wert für ein einzelnes Label.

JSON-Darstellung
{
  "labelName": string,
  "labelValue": string
}
Felder
labelName

string

Erforderlich. Labelname, der als Schlüssel in xDS-Knotenmetadaten dargestellt wird.

labelValue

string

Erforderlich. Labelwert, der als Wert für den obigen Schlüssel in xDS-Knotenmetadaten dargestellt wird.

TrafficPortSelector

Spezifikation eines portbasierten Selektors.

JSON-Darstellung
{
  "ports": [
    string
  ]
}
Felder
ports[]

string

Optional. Eine Liste von Ports. Kann eine Portnummer oder ein Portbereich sein (z. B. [80–90] für alle Ports von 80 bis 90, einschließlich 80 und 90) oder benannte Ports oder * für alle Ports. Wenn die Liste leer ist, werden alle Ports ausgewählt.

Methoden

create

Erstellt eine neue EndpointPolicy in einem bestimmten Projekt und an einem bestimmten Standort.

delete

Löscht eine einzelne „EndpointPolicy“

get

Ruft Details zu einer einzelnen „EndpointPolicy“ ab

list

Listet EndpointPolicies in einem angegebenen Projekt und an einem angegebenen Standort auf.

patch

Aktualisiert die Parameter einer einzelnen EndpointPolicy.

setIamPolicy

Legt die Zugriffssteuerungsrichtlinie für die angegebene Ressource fest.

testIamPermissions

Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.