REST Resource: projects.locations.gateways

リソース: Gateway

Gateway は、プロキシの構成を表します（通常はロードバランサ）。Gateway は、サービスがプロキシとすべてのポリシー構成で公開される ip:port を取得します。ルートには、この Gateway でリクエストをどのようにルーティングするかについて指示する Gateway への参照があります。

JSON 表現 
{
  "name": string,
  "selfLink": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "type": enum (Type),
  "addresses": [
    string
  ],
  "ports": [
    integer
  ],
  "scope": string,
  "serverTlsPolicy": string,
  "certificateUrls": [
    string
  ],
  "gatewaySecurityPolicy": string,
  "network": string,
  "subnetwork": string,
  "ipVersion": enum (IpVersion),
  "routingMode": enum (RoutingMode),
  "envoyHeaders": enum (EnvoyHeaders)
}
フィールド
name

string

ID。Gateway リソースの名前。projects/*/locations/*/gateways/<gateway_name> の形式で指定する必要があります。
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)

省略可。Gateway リソースに関連付けられたラベルタグのセット。

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

string

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

enum (Type)

変更不可。顧客管理のゲートウェイのタイプ。このフィールドは必須です。指定しない場合はエラーが返されます。
addresses[]

string

省略可。Gateway がトラフィックを受信する IPv4 アドレスまたは IPv6 アドレス（0 個または 1 個）。アドレスが指定されていない場合、サブネットワークの IP が割り振られます。

このフィールドは、'SECURE_WEB_GATEWAY' タイプのゲートウェイにのみ適用されます。'OPEN_MESH' タイプのゲートウェイは、IPv4 では 0.0.0.0、IPv6 では :: をリッスンします。
ports[]

integer

必須。Gateway がトラフィックを受信する 1 つ以上のポート番号（1～65535）。プロキシは、指定されたポートにバインドされます。'SECURE_WEB_GATEWAY' タイプのゲートウェイは 1 ポートに制限されます。'OPEN_MESH' タイプのゲートウェイは、IPv4 では 0.0.0.0、IPv6 では :: をリッスンし、複数のポートをサポートします。
scope

string

省略可。スコープにより、複数の Gateway インスタンスにわたる構成を結合する方法が決まります。同じスコープを持つ複数の Gateway インスタンスの構成は、プロキシ / ロードバランサに対する単一の構成として結合されます。

最大長は 64 文字です。スコープの先頭は英字にしてください。使用できる文字は英数字とハイフンのみです。
serverTlsPolicy

string

省略可。ServerTLSPolicy の完全修飾 URL リファレンス。TLS トラフィックの終端方法を指定します。空の場合、TLS 終端は無効になります。
certificateUrls[]

string

省略可。Certificates の完全修飾 URL リファレンス。プロキシは、TLS 接続の確立時に Certificate（SNI に基づいて選択）を提示します。この機能は、'SECURE_WEB_GATEWAY' タイプのゲートウェイにのみ適用されます。
gatewaySecurityPolicy

string

省略可。GatewaySecurityPolicy の完全修飾 URL リファレンス。サーバーがインバウンド（VM からプロキシ）開始接続にセキュリティ ポリシーを適用する方法を定義します。

例: projects/*/locations/*/gatewaySecurityPolicies/swg-policy。

このポリシーは、'SECURE_WEB_GATEWAY' タイプのゲートウェイに固有のものです。
network

string

省略可。この構成を使用している VPC ネットワークを識別する関連リソース名。例: projects/*/global/networks/network-1。

現在、このフィールドは 'SECURE_WEB_GATEWAY' タイプのゲートウェイに固有のものです。
subnetwork

string

省略可。この SWG が割り振られているサブネットワークを識別する関連リソース名。例: projects/*/regions/us-central1/subnetworks/network-1

現在、このフィールドは 'SECURE_WEB_GATEWAY' タイプのゲートウェイに固有のものです。
ipVersion

enum (IpVersion)

省略可。このゲートウェイで使用される IP バージョン。有効なオプションは IPV4 または IPV6 です。デフォルトは IPV4 です。
routingMode

enum (RoutingMode)

省略可。Gateway のルーティング モード。このフィールドは、SECURE_WEB_GATEWAY タイプのゲートウェイでのみ構成できます。このフィールドは、SECURE_WEB_GATEWAY タイプのゲートウェイに必須です。
envoyHeaders

enum (EnvoyHeaders)

省略可。envoy が内部デバッグ ヘッダーをアップストリーム リクエストに挿入するかどうかを指定します。他の Envoy ヘッダーが挿入される可能性もあります。デフォルトでは、Envoy はデバッグ ヘッダーを挿入しません。

Type

顧客管理のゲートウェイのタイプ。有効な値は、* OPEN_MESH * SECURE_WEB_GATEWAY です。

列挙型
TYPE_UNSPECIFIED 顧客管理のゲートウェイのタイプは指定されていません。
OPEN_MESH 顧客管理のゲートウェイのタイプは TrafficDirector Open Mesh です。
SECURE_WEB_GATEWAY 顧客管理のゲートウェイのタイプは SecureWebGateway（SWG）です。

IpVersion

ゲートウェイの IP バージョンのタイプ。有効な値は * IPV4 * IPV6 です。

列挙型
IP_VERSION_UNSPECIFIED IP バージョンが指定されていない場合のタイプ。デフォルトは IPV4 です。
IPV4 IP バージョン 4 のタイプ。
IPV6 IP バージョン 6 のタイプ。

RoutingMode

Gateway のルーティング モード。Gateway がトラフィックをルーティングする方法を決定します。現在、このフィールドは SECURE_WEB_GATEWAY タイプのゲートウェイにのみ適用されます。有効な値は、* EXPLICIT_ROUTING_MODE * NEXT_HOP_ROUTING_MODE です。

列挙型
EXPLICIT_ROUTING_MODE ルーティング モードは明示的です。クライアントはゲートウェイ経由でトラフィックを送信するように構成されます。これはデフォルトのルーティング モードです。
NEXT_HOP_ROUTING_MODE ルーティング モードはネクストホップです。クライアントはゲートウェイを認識しません。クライアントからゲートウェイにトラフィックを転送するように、ルート（高度なルートまたは他のルートタイプ）を構成できます。ゲートウェイは、宛先へのネクストホップとして機能します。

メソッド

create

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

delete

 1 つの Gateway を削除します。

get

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

list

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

patch

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

setIamPolicy

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

testIamPermissions

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