REST Resource: projects.locations.endpointPolicies

リソース: EndpointPolicy

EndpointPolicy は、特定の条件に一致するエンドポイントに必要な構成を適用するために使用できるリソースです。たとえば、このリソースを使用して、ポート 8080 で動作するすべてのエンドポイントに「認証構成」を適用できます。

JSON 表現 
{
  "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
}
フィールド
name

string

ID。EndpointPolicy リソースの名前。パターン projects/{project}/locations/global/endpointPolicies/{endpointPolicy} と一致します。
createTime

string (Timestamp format)

出力専用。リソース作成時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。リソース更新時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
labels

map (key: string, value: string)

省略可。EndpointPolicy リソースに関連付けられた一連のラベルタグ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
type

enum (EndpointPolicyType)

必須。エンドポイント ポリシーのタイプ。主に構成の検証に使用されます。
authorizationPolicy

string

省略可。このフィールドは、一致したエンドポイントで受信トラフィックに認可ポリシーを適用する AuthorizationPolicy リソースの URL を指定します。「認可」を参照してください。このフィールドが指定されていない場合、このエンドポイントでは認可が無効（認可チェックなし）になります。
endpointMatcher

object (EndpointMatcher)

必須。ポリシーを適用する必要があるエンドポイントを選択するマッチャー。
trafficPortSelector

object (TrafficPortSelector)

省略可。（一致した）エンドポイント用のポートセレクタ。ポートセレクタが指定されていない場合、一致した構成がすべてのポートに適用されます。
description

string

省略可。フリーテキストによるリソースの説明。最大長は 1,024 文字です。
serverTlsPolicy

string

省略可。ServerTlsPolicy リソースを参照する URL。ServerTlsPolicy は、特定されたバックエンドで受信トラフィックを終了するために適用される認証ポリシーを決定するために使用されます。このフィールドが設定されていない場合、このエンドポイントでは認証が無効（オープン）になります。
clientTlsPolicy

string

省略可。ClientTlsPolicy リソースを参照する URL。ClientTlsPolicy を設定すると、プロキシから実際のエンドポイントへのトラフィックに適用する認証を指定できます。具体的には、この認証はプロキシからエンドポイントへの送信トラフィックに適用されます。これは通常、プロキシがコントロール プレーンへのエンドポイントとして自身を識別し、サイドカーとエンドポイントの間の接続で認証が必要なサイドカー モデルに使用されます。このフィールドが設定されていない場合、認証は無効（オープン）になります。EndpointPolicyType が SIDECAR_PROXY の場合にのみ適用されます。

EndpointPolicyType

エンドポイント ポリシーのタイプ。

列挙型
ENDPOINT_POLICY_TYPE_UNSPECIFIED デフォルト値。使用しないでください。
SIDECAR_PROXY サイドカーとしてデプロイされたプロキシを表します。
GRPC_SERVER プロキシレス gRPC バックエンドを表します。

EndpointMatcher

ポリシーを適用する必要があるエンドポイントを選択するマッチャーの定義。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド matcher_type。このエンドポイント マッチャーに使用するマッチャーのタイプを指定します。matcher_type は次のいずれかになります。
metadataLabelMatcher

object (MetadataLabelMatcher)

マッチャーは、xDS クライアントから提示されたノード メタデータに基づいています。

MetadataLabelMatcher

xDS クライアントから提示されたノード メタデータに基づくマッチャー。

JSON 表現 
{
  "metadataLabelMatchCriteria": enum (MetadataLabelMatchCriteria),
  "metadataLabels": [
    {
      object (MetadataLabels)
    }
  ]
}
フィールド
metadataLabelMatchCriteria

enum (MetadataLabelMatchCriteria)

マッチング方法を指定します。

使用可能な値は次の 2 つです。MATCH_ANY: マッチャーで指定されたラベルの少なくとも 1 つが、XDS クライアントから提示されたメタデータと一致する必要があります。MATCH_ALL: xDS クライアントから提示されたメタデータに、ここで指定されたすべてのラベルが含まれている必要があります。

選択は、最も一致するものに基づいて行われます。たとえば、3 つの EndpointPolicy リソース P1、P2、P3 があり、P1 のマッチャーが MATCH_ANY <A:1,B:1>、P2 のマッチャーが MATCH_ALL <A:1,B:1>、P3 のマッチャーが MATCH_ALL <A:1,B:1,C:1> だとします。

ラベルが <A:1> のクライアントが接続すると、P1 の構成が選択されます。

ラベルが <A:1,B:1> のクライアントが接続すると、P2 の構成が選択されます。

ラベルが <A:1,B:1,C:1> のクライアントが接続すると、P3 の構成が選択されます。

最も一致するものが複数ある場合（たとえば、セレクタ <A:1,D:1> を持つ構成 P4 が存在し、ラベルが <A:1,B:1,D:1> のクライアントが接続する場合など）、作成時刻が古いほうの構成が選択されます。
metadataLabels[]

object (MetadataLabels)

filterMatchCriteria に基づいて指定されたメタデータのラベルと一致する必要があるラベル値ペアのリスト。このリストには最大 64 個のエントリを含めることができます。一致条件が MATCH_ANY の場合は、このリストを空にすることでワイルドカード一致を指定できます（つまり、すべてのクライアントに一致します）。

MetadataLabelMatchCriteria

マッチング方法のロジックを定義する条件値。

列挙型
METADATA_LABEL_MATCH_CRITERIA_UNSPECIFIED デフォルト値。これは使用しないでください。
MATCH_ANY マッチャーで指定されたラベルの少なくとも 1 つが、xDS クライアントから提示されたメタデータと一致している必要があります。
MATCH_ALL xDS クライアントから提示されたメタデータに、ここで指定されたすべてのラベルが含まれている必要があります。

MetadataLabels

1 つのラベルの名前ペアの値を定義します。

JSON 表現 
{
  "labelName": string,
  "labelValue": string
}
フィールド
labelName

string

必須。xDS ノード メタデータでキーとして提示されるラベル名。
labelValue

string

必須。xDS ノード メタデータで、上記のキーに対応する値として提示されるラベル値。

TrafficPortSelector

ポートベースのセレクタの仕様。

JSON 表現 
{
  "ports": [
    string
  ]
}
フィールド
ports[]

string

省略可。ポートのリスト。ポート番号、ポート範囲（例: [80-90] は 80 から 90 までのポート）、名前付きポート、または *（すべてのポート）を指定できます。リストが空の場合は、すべてのポートが選択されます。

メソッド

create

 指定されたプロジェクトとロケーションで新しい ServerTlsPolicy を作成します。

delete

 1 つの EndpointPolicy を削除します。

get

 1 つの EndpointPolicy の詳細を取得します。

getIamPolicy

 リソースのアクセス制御ポリシーを取得します。

list

 指定されたプロジェクトとロケーションにある EndpointPolicy を一覧表示します。

patch

 1 つの EndpointPolicy のパラメータを更新します。

setIamPolicy

 指定されたリソースのアクセス制御ポリシーを設定します。

testIamPermissions

 指定されたリソースに対して呼び出し元が持っている権限を返します。