インデックス
EdgeContainer(インターフェース)Authorization(メッセージ)Cluster(メッセージ)ClusterNetworking(メッセージ)ClusterUser(メッセージ)CreateClusterRequest(メッセージ)CreateNodePoolRequest(メッセージ)CreateVpnConnectionRequest(メッセージ)DeleteClusterRequest(メッセージ)DeleteNodePoolRequest(メッセージ)DeleteVpnConnectionRequest(メッセージ)Fleet(メッセージ)GenerateAccessTokenRequest(メッセージ)GenerateAccessTokenResponse(メッセージ)GetClusterRequest(メッセージ)GetMachineRequest(メッセージ)GetNodePoolRequest(メッセージ)GetVpnConnectionRequest(メッセージ)KmsKeyState(列挙型)ListClustersRequest(メッセージ)ListClustersResponse(メッセージ)ListMachinesRequest(メッセージ)ListMachinesResponse(メッセージ)ListNodePoolsRequest(メッセージ)ListNodePoolsResponse(メッセージ)ListVpnConnectionsRequest(メッセージ)ListVpnConnectionsResponse(メッセージ)LocationMetadata(メッセージ)Machine(メッセージ)MaintenancePolicy(メッセージ)MaintenanceWindow(メッセージ)NodePool(メッセージ)NodePool.LocalDiskEncryption(メッセージ)OperationMetadata(メッセージ)Quota(メッセージ)RecurringTimeWindow(メッセージ)TimeWindow(メッセージ)UpdateClusterRequest(メッセージ)UpdateNodePoolRequest(メッセージ)VpnConnection(メッセージ)VpnConnection.BgpRoutingMode(列挙型)VpnConnection.Details(メッセージ)VpnConnection.Details.CloudRouter(メッセージ)VpnConnection.Details.CloudVpn(メッセージ)VpnConnection.Details.State(列挙型)VpnConnection.VpcProject(メッセージ)ZoneMetadata(メッセージ)
EdgeContainer
EdgeContainer API は、Google Edge Cloud デプロイでの Kubernetes クラスタの管理を提供します。
| CreateCluster |
|---|
|
指定されたプロジェクトとロケーションに新しいクラスタを作成します。
|
| CreateNodePool |
|---|
|
指定されたプロジェクトとロケーションに新しい NodePool を作成します。
|
| CreateVpnConnection |
|---|
|
指定されたプロジェクトとロケーションに新しい VPN 接続を作成します。
|
| DeleteCluster |
|---|
|
1 つのクラスタを削除します。
|
| DeleteNodePool |
|---|
|
1 つの NodePool を削除します。
|
| DeleteVpnConnection |
|---|
|
単一の VPN 接続を削除します。
|
| GenerateAccessToken |
|---|
|
クラスタのアクセス トークンを生成します。
|
| GetCluster |
|---|
|
1 つのクラスタの詳細を取得します。
|
| GetMachine |
|---|
|
1 つの Machine の詳細を取得します。
|
| GetNodePool |
|---|
|
1 つの NodePool の詳細を取得します。
|
| GetVpnConnection |
|---|
|
1 つの VPN 接続の詳細を取得します。
|
| ListClusters |
|---|
|
指定されたプロジェクトとロケーションのクラスタを一覧表示します。
|
| ListMachines |
|---|
|
指定されたプロジェクトとロケーションの Machine を一覧表示します。
|
| ListNodePools |
|---|
|
指定されたプロジェクトとロケーションの NodePool を一覧表示します。
|
| ListVpnConnections |
|---|
|
指定されたプロジェクトとロケーションの VPN 接続を一覧表示します。
|
| UpdateCluster |
|---|
|
単一のクラスタのパラメータを更新します。
|
| UpdateNodePool |
|---|
|
単一の NodePool のパラメータを更新します。
|
承認
GEC によって適用および管理される RBAC ポリシー。
| フィールド | |
|---|---|
admin_users |
必須。クラスタへの完全アクセス権をもつクラスタ管理者ロールが付与されるユーザー。現在は単一のフィールドですが、将来的には複数の管理者を指定できるようになる予定です。 |
クラスタ
Google Distributed Cloud Edge Kubernetes クラスタ。
| フィールド | |
|---|---|
name |
必須。クラスタのリソース名。 |
create_time |
出力専用。クラスタが作成された日時。 |
update_time |
出力専用。クラスタが最後に更新された時刻。 |
labels |
このリソースに関連付けられたラベル。 |
fleet |
省略可。フリート構成。 |
networking |
必須。クラスタ全体のネットワーキング構成。 |
authorization |
必須。変更不可。GEC によって適用および管理される RBAC ポリシー。 |
default_max_pods_per_node |
省略可。このクラスタ内のノードプールに最大値が明示的に指定されていない場合に使用される、ノードあたりのデフォルトの最大 Pod 数。これが指定されていない場合は、Kubernetes のデフォルト値が使用されます。 |
endpoint |
出力専用。Kubernetes API サーバーの IP アドレス。 |
cluster_ca_certificate |
出力専用。クラスタの CA の PEM でエンコードされた公開証明書。 |
maintenance_policy |
省略可。クラスタ全体のメンテナンス ポリシー構成。 |
control_plane_version |
出力専用。コントロール プレーンのリリース バージョン |
node_version |
出力専用。すべてのワーカーノードの中で最も低いリリース バージョン。クラスタにワーカーノードがない場合、このフィールドは空にできます。 |
ClusterNetworking
クラスタ全体のネットワーキング構成。
| フィールド | |
|---|---|
cluster_ipv4_cidr_blocks[] |
必須。クラスタ内のすべての Pod には、これらのブロックから RFC1918 IPv4 アドレスが割り当てられます。単一のブロックのみがサポートされます。作成後にこのフィールドを変更することはできません。 |
services_ipv4_cidr_blocks[] |
必須。クラスタ内のすべてのサービスには、これらのブロックから RFC1918 IPv4 アドレスが割り当てられます。単一のブロックのみがサポートされます。作成後にこのフィールドを変更することはできません。 |
ClusterUser
RBAC ポリシーのユーザー プリンシパル。
| フィールド | |
|---|---|
username |
必須。有効な Google ユーザー名。 |
CreateClusterRequest
クラスタを作成します。
| フィールド | |
|---|---|
parent |
必須。このクラスタが作成される親ロケーション。 認可には、指定されたリソース
|
cluster_id |
必須。クライアントが指定したクラスタの一意の識別子。 |
cluster |
必須。作成するクラスタ。 |
request_id |
このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、 |
CreateNodePoolRequest
ノードプールを作成します。
| フィールド | |
|---|---|
parent |
必須。このノードプールが作成される親クラスタ。 認可には、指定されたリソース
|
node_pool_id |
必須。クライアントが指定したノードプールの固有識別子。 |
node_pool |
必須。作成するノードプール。 |
request_id |
このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、 |
CreateVpnConnectionRequest
VPN 接続を作成します。
| フィールド | |
|---|---|
parent |
必須。この VPN 接続が作成される親ロケーション。 認可には、指定されたリソース
|
vpn_connection_id |
必須。VPN 接続の ID。 |
vpn_connection |
必須。作成する VPN 接続。 |
request_id |
このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、 |
DeleteClusterRequest
クラスタを削除します。
| フィールド | |
|---|---|
name |
必須。クラスタのリソース名。 認可には、指定されたリソース
|
request_id |
このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、 |
DeleteNodePoolRequest
ノードプールを削除します。
| フィールド | |
|---|---|
name |
必須。ノードプールのリソース名。 認可には、指定されたリソース
|
request_id |
このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、 |
DeleteVpnConnectionRequest
VPN 接続を削除します。
| フィールド | |
|---|---|
name |
必須。VPN 接続のリソース名。 認可には、指定されたリソース
|
request_id |
このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、 |
フリート
フリート関連の構成。
フリートとは、複数のクラスタを論理的に編成するための Google Cloud のコンセプトです。フリートを使用することによって、マルチクラスタ機能の使用と管理、複数のシステム間での一貫したポリシーの適用が可能になります。
| フィールド | |
|---|---|
project |
必須。このクラスタが登録されるフリート ホスト プロジェクトの名前。 プロジェクト名の形式は |
membership |
出力専用。このクラスタに関連付けられているマネージド Hub メンバーシップ リソースの名前。 メンバーシップ名の形式は |
GenerateAccessTokenRequest
クラスタのアクセス トークンを生成します。
| フィールド | |
|---|---|
cluster |
必須。クラスタのリソース名。 認可には、指定されたリソース
|
GenerateAccessTokenResponse
クラスタのアクセス トークン。
| フィールド | |
|---|---|
access_token |
出力専用。k8s api-server での認証に使用するアクセス トークン。 |
expire_time |
出力専用。トークンの有効期限を示すタイムスタンプ。 |
GetClusterRequest
クラスタを取得します。
| フィールド | |
|---|---|
name |
必須。クラスタのリソース名。 認可には、指定されたリソース
|
GetMachineRequest
マシンを取得します。
| フィールド | |
|---|---|
name |
必須。マシンのリソース名。 認可には、指定されたリソース
|
GetNodePoolRequest
ノードプールを取得します。
| フィールド | |
|---|---|
name |
必須。ノードプールのリソース名。 認可には、指定されたリソース
|
GetVpnConnectionRequest
VPN 接続を取得します。
| フィールド | |
|---|---|
name |
必須。VPN 接続のリソース名。 認可には、指定されたリソース
|
KmsKeyState
CMEK 統合に使用される顧客管理の KMS 鍵のアクセシビリティ状態を表します。
| 列挙型 | |
|---|---|
KMS_KEY_STATE_UNSPECIFIED |
指定なし。 |
KMS_KEY_STATE_KEY_AVAILABLE |
キーは使用可能で、依存リソースにアクセスできる必要があります。 |
KMS_KEY_STATE_KEY_UNAVAILABLE |
キーは不明な理由で使用できません。依存リソースにアクセスできない可能性があります。 |
ListClustersRequest
ロケーション内のクラスタを一覧表示します。
| フィールド | |
|---|---|
parent |
必須。このクラスタのコレクションを所有する親ロケーション。 認可には、指定されたリソース
|
page_size |
一覧表示するリソースの最大数。 |
page_token |
前回のリスト リクエストから受け取ったページトークン。前の一覧表示リクエストから受け取ったページトークン。 |
filter |
このフィルタに一致するリソースのみが一覧表示されます。 |
order_by |
リソースが一覧表示される順序を指定します。 |
ListClustersResponse
ロケーション内のクラスタのリスト。
| フィールド | |
|---|---|
clusters[] |
ロケーション内のクラスタ。 |
next_page_token |
結果の次ページを取得するためのトークン。 |
unreachable[] |
到達できなかったロケーション。 |
ListMachinesRequest
サイト内のマシンを一覧表示します。
| フィールド | |
|---|---|
parent |
必須。このマシン コレクションを所有する親サイト。 認可には、指定されたリソース
|
page_size |
一覧表示するリソースの最大数。 |
page_token |
前の一覧表示リクエストから受け取ったページトークン。 |
filter |
このフィルタに一致するリソースのみが一覧表示されます。 |
order_by |
リソースが一覧表示される順序を指定します。 |
ListMachinesResponse
サイト内のマシンのリスト。
| フィールド | |
|---|---|
machines[] |
サイト内のマシン。 |
next_page_token |
結果の次ページを取得するためのトークン。 |
unreachable[] |
到達できなかったロケーション。 |
ListNodePoolsRequest
クラスタ内のノードプールを一覧表示します。
| フィールド | |
|---|---|
parent |
必須。このノードプール コレクションを所有する親クラスタ。 認可には、指定されたリソース
|
page_size |
一覧表示するリソースの最大数。 |
page_token |
前の一覧表示リクエストから受け取ったページトークン。 |
filter |
このフィルタに一致するリソースのみが一覧表示されます。 |
order_by |
リソースが一覧表示される順序を指定します。 |
ListNodePoolsResponse
クラスタ内のノードプールのリスト。
| フィールド | |
|---|---|
node_pools[] |
クラスタ内のノードプール。 |
next_page_token |
結果の次ページを取得するためのトークン。 |
unreachable[] |
到達できなかったロケーション。 |
ListVpnConnectionsRequest
VPN 接続を一覧表示します。
| フィールド | |
|---|---|
parent |
必須。この VPN 接続のコレクションを所有する親ロケーション。 認可には、指定されたリソース
|
page_size |
一覧表示するリソースの最大数。 |
page_token |
前の一覧表示リクエストから受け取ったページトークン。 |
filter |
このフィルタに一致するリソースのみが一覧表示されます。 |
order_by |
リソースが一覧表示される順序を指定します。 |
ListVpnConnectionsResponse
ロケーション内の VPN 接続のリスト。
| フィールド | |
|---|---|
vpn_connections[] |
ロケーション内の VpnConnection。 |
next_page_token |
結果の次ページを取得するためのトークン。 |
unreachable[] |
到達できなかったロケーション。 |
LocationMetadata
特定の google.cloud.location.Location のメタデータ。
| フィールド | |
|---|---|
available_zones |
ロケーションで使用可能な Google Distributed Cloud Edge ゾーンのセット。マップは各ゾーンの小文字の ID でキー設定されます。 |
マシン
Kubernetes ノードとして機能できる Google Distributed Cloud Edge マシン。
| フィールド | |
|---|---|
name |
必須。マシンのリソース名。 |
create_time |
出力専用。ノードプールが作成された時刻。 |
update_time |
出力専用。ノードプールが最後に更新された時刻。 |
labels |
このリソースに関連付けられたラベル。 |
hosted_node |
このマシンがホストするノードの正規リソース名(例: projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node})。マシンがノードのロールを担うように割り当てられていない場合は空。 エッジマシンでホストされているコントロール プレーン ノードの場合、次の形式が返されます: 「projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}」。 |
zone |
このマシンの Google Distributed Cloud Edge ゾーン。 |
version |
出力専用。マシンのソフトウェア バージョン。 |
disabled |
出力専用。マシンが無効かどうか。無効にすると、マシンはサービスを開始できません。 |
MaintenancePolicy
メンテナンス ポリシーの構成。
| フィールド | |
|---|---|
window |
メンテナンスが実行されるメンテナンスの時間枠を指定します。 |
MaintenanceWindow
メンテナンスの時間枠の構成
| フィールド | |
|---|---|
recurring_window |
定期的なメンテナンスの時間枠の構成。 |
ノードプール
共通の構成と仕様を持つクラスタ内の Kubernetes ノードのセット。
| フィールド | |
|---|---|
name |
必須。ノードプールのリソース名。 |
create_time |
出力専用。ノードプールが作成された時刻。 |
update_time |
出力専用。ノードプールが最後に更新された時刻。 |
labels |
このリソースに関連付けられたラベル。 |
node_location |
このノードプールが作成される Google Distributed Cloud Edge ゾーンの名前。例: |
node_count |
必須。プール内のノード数。 |
machine_filter |
このフィルタに一致するマシンのみがノードプールに参加できます。フィルタリング言語は「name= |
local_disk_encryption |
省略可。ローカル ディスクの暗号化オプション。このフィールドは、CMEK サポートを有効にする場合にのみ使用されます。 |
node_version |
出力専用。すべてのワーカーノードの中で最も低いリリース バージョン。 |
LocalDiskEncryption
エッジマシンのローカル ディスク暗号化の CMEK サポートの構成。
| フィールド | |
|---|---|
kms_key |
変更不可。ノードのローカル ディスクの保護に使用する Cloud KMS CryptoKey(例: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey})。指定しない場合は、代わりに Google が管理する鍵が使用されます。 |
kms_key_active_version |
出力専用。ノードのローカル ディスクの保護に現在使用されている Cloud KMS CryptoKeyVersion。kms_key が設定されている場合にのみ適用されます。 |
kms_key_state |
出力専用。Cloud KMS CryptoKey の可用性。 |
kms_status |
出力専用。この鍵を使用するときに Cloud KMS から返されるエラー ステータス。このフィールドは、 |
OperationMetadata
Edge Container API メソッドの長時間実行オペレーションのメタデータ。
| フィールド | |
|---|---|
create_time |
オペレーションが作成された時刻。 |
end_time |
オペレーションの実行が終了した時刻。 |
target |
オペレーションのターゲットに対応するサーバー定義のリソースパス。 |
verb |
オペレーションによって実行される動詞。 |
status_message |
人が読める形式のオペレーションのステータス(存在する場合)。 |
requested_cancellation |
ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、 |
api_version |
オペレーションを開始するために使用された API のバージョン。 |
warnings[] |
オペレーションをブロックしないが、エンドユーザーが受け取るべき関連情報を含む警告。 |
割り当て
Edge コンテナ リソースの割り当てを表します。
| フィールド | |
|---|---|
metric |
割り当て指標の名前。 |
limit |
この指標の割り当て上限。 |
usage |
この指標の現在の使用状況。 |
RecurringTimeWindow
繰り返される任意の期間を表します。
| フィールド | |
|---|---|
window |
最初の定期購入の期間。 |
recurrence |
このウィンドウの繰り返し方法を示す RRULE(https://tools.ietf.org/html/rfc5545#section-3.8.5.3)。開始時刻から終了時刻までの期間にわたって実行されます。 |
TimeWindow
任意の期間を表します。
| フィールド | |
|---|---|
start_time |
ウィンドウが最初に開始される時刻。 |
end_time |
ウィンドウの終了時刻。終了時間は開始時間より後にする必要があります。 |
UpdateClusterRequest
クラスタを更新します。
| フィールド | |
|---|---|
update_mask |
フィールド マスクは、更新によって Cluster リソース内で上書きされるフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。 |
cluster |
更新されたクラスタ。 認可には、指定されたリソース
|
request_id |
このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、 |
UpdateNodePoolRequest
ノードプールを更新します。
| フィールド | |
|---|---|
update_mask |
フィールド マスクは、更新によって NodePool リソース内で上書きされるフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。 |
node_pool |
更新されたノードプール。 認可には、指定されたリソース
|
request_id |
このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、 |
VpnConnection
VPN 接続。
| フィールド | |
|---|---|
name |
必須。VPN 接続のリソース名 |
create_time |
出力専用。VPN 接続が作成された時刻。 |
update_time |
出力専用。VPN 接続が最後に更新された日時。 |
labels |
このリソースに関連付けられたラベル。 |
nat_gateway_ip |
NAT ゲートウェイの IP アドレスまたは WAN IP アドレス。NAT IP が複数ある場合は、1 つの外部 IP のみが GMEC Anthos クラスタにマッピングされるように NAT を構成する必要があります。NAT が使用されていない場合は空になります。 |
bgp_routing_mode |
VPC ネットワークの動的ルーティング モード( |
cluster |
接続先の正規クラスタ名。形式は projects/{project}/locations/{location}/clusters/{cluster} です。 |
vpc |
接続する VPC のネットワーク ID。 |
vpc_project |
省略可。VPC ネットワークのプロジェクトの詳細。VPC がクラスタ プロジェクトとは異なるプロジェクトにある場合に必要です。 |
enable_high_availability |
この VPN 接続でクラスタ側で HA が有効になっているかどうか。有効にすると、VPN 接続の作成時に 2 つの ANG フローティング IP の使用が試行されます。 |
details |
出力専用。作成された接続の詳細。 |
BgpRoutingMode
ルーティング モード。
| 列挙型 | |
|---|---|
BGP_ROUTING_MODE_UNSPECIFIED |
不明。 |
REGIONAL |
リージョン モード。 |
GLOBAL |
グローバル モード。 |
詳細
作成された接続の詳細。
| フィールド | |
|---|---|
state |
この接続の状態。 |
error |
エラー メッセージ。これは、state=ERROR の場合にのみ入力されます。 |
cloud_router |
Cloud Router の情報。 |
cloud_vpns[] |
各接続には複数の Cloud VPN ゲートウェイがあります。 |
CloudRouter
Cloud Router の情報。
| フィールド | |
|---|---|
name |
関連付けられている Cloud Router の名前。 |
CloudVpn
Cloud VPN の情報。
| フィールド | |
|---|---|
gateway |
作成された Cloud VPN ゲートウェイの名前。 |
状態
現在の接続状態。
| 列挙型 | |
|---|---|
STATE_UNSPECIFIED |
不明。 |
STATE_CONNECTED |
接続しました。 |
STATE_CONNECTING |
まだ接続中です。 |
STATE_ERROR |
エラーが発生しました。 |
VpcProject
VPC ネットワークのプロジェクトの詳細。
| フィールド | |
|---|---|
project_id |
接続する VPC のプロジェクト。指定しない場合は、クラスタ プロジェクトと同じになります。 |
service_account |
省略可。ユーザーが構成した VPC プロジェクトのサービス アカウント。VPN 接続用の Cloud Router と Cloud HA VPN の作成/削除に使用されます。VPN 接続の作成中または作成後にこの SA が変更された場合は、|project_id| の Cloud Router リソースと Cloud VPN リソースを削除する必要があります。これは、service-{project_number}@gcp-sa-edgecontainer.iam.gserviceaccount.com の形式です。 |
ZoneMetadata
エッジマシンが配置されている Google Distributed Cloud Edge ゾーン。
| フィールド | |
|---|---|
quota[] |
このゾーンのリソースの割り当て。 |