Package google.cloud.edgecontainer.v1

インデックス

EdgeContainer

EdgeContainer API は、Google Edge Cloud デプロイでの Kubernetes クラスタの管理を提供します。

CreateCluster

rpc CreateCluster(CreateClusterRequest) returns (Operation)

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
CreateNodePool

rpc CreateNodePool(CreateNodePoolRequest) returns (Operation)

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
CreateVpnConnection

rpc CreateVpnConnection(CreateVpnConnectionRequest) returns (Operation)

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
DeleteCluster

rpc DeleteCluster(DeleteClusterRequest) returns (Operation)

1 つのクラスタを削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
DeleteNodePool

rpc DeleteNodePool(DeleteNodePoolRequest) returns (Operation)

1 つの NodePool を削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
DeleteVpnConnection

rpc DeleteVpnConnection(DeleteVpnConnectionRequest) returns (Operation)

単一の VPN 接続を削除します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
GenerateAccessToken

rpc GenerateAccessToken(GenerateAccessTokenRequest) returns (GenerateAccessTokenResponse)

クラスタのアクセス トークンを生成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
GenerateOfflineCredential

rpc GenerateOfflineCredential(GenerateOfflineCredentialRequest) returns (GenerateOfflineCredentialResponse)

クラスタのオフライン認証情報を生成します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
GetCluster

rpc GetCluster(GetClusterRequest) returns (Cluster)

1 つのクラスタの詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
GetMachine

rpc GetMachine(GetMachineRequest) returns (Machine)

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
GetNodePool

rpc GetNodePool(GetNodePoolRequest) returns (NodePool)

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
GetServerConfig

rpc GetServerConfig(GetServerConfigRequest) returns (ServerConfig)

サーバー構成を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
GetVpnConnection

rpc GetVpnConnection(GetVpnConnectionRequest) returns (VpnConnection)

1 つの VPN 接続の詳細を取得します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
ListClusters

rpc ListClusters(ListClustersRequest) returns (ListClustersResponse)

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
ListMachines

rpc ListMachines(ListMachinesRequest) returns (ListMachinesResponse)

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
ListNodePools

rpc ListNodePools(ListNodePoolsRequest) returns (ListNodePoolsResponse)

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
ListVpnConnections

rpc ListVpnConnections(ListVpnConnectionsRequest) returns (ListVpnConnectionsResponse)

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
UpdateCluster

rpc UpdateCluster(UpdateClusterRequest) returns (Operation)

単一のクラスタのパラメータを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
UpdateNodePool

rpc UpdateNodePool(UpdateNodePoolRequest) returns (Operation)

単一の NodePool のパラメータを更新します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。
UpgradeCluster

rpc UpgradeCluster(UpgradeClusterRequest) returns (Operation)

単一のクラスタをアップグレードします。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform

詳細については、Authentication Overview をご覧ください。

承認

GEC によって適用および管理される RBAC ポリシー。

フィールド
admin_users

ClusterUser

必須。クラスタへの完全アクセス権をもつクラスタ管理者ロールが付与されるユーザー。現在は単一のフィールドですが、将来的には複数の管理者を指定できるようになる予定です。

ChannelConfig

リリース チャンネルの構成。

フィールド
default_version

string

出力専用。このリリース チャンネルのデフォルト バージョン（例: "1.4.0"。

クラスタ

Google Distributed Cloud Edge Kubernetes クラスタ。

フィールド
name

string

必須。クラスタのリソース名。
create_time

Timestamp

出力専用。クラスタが作成された日時。
update_time

Timestamp

出力専用。クラスタが最後に更新された時刻。
labels

map<string, string>

このリソースに関連付けられたラベル。
fleet

Fleet

必須。フリート構成。
networking

ClusterNetworking

必須。クラスタ全体のネットワーキング構成。
authorization

Authorization

必須。変更不可。GEC によって適用および管理される RBAC ポリシー。
default_max_pods_per_node

int32

省略可。このクラスタ内のノードプールに最大値が明示的に指定されていない場合に使用される、ノードあたりのデフォルトの最大 Pod 数。これが指定されていない場合は、Kubernetes のデフォルト値が使用されます。
endpoint

string

出力専用。Kubernetes API サーバーの IP アドレス。
port

int32

出力専用。Kubernetes API サーバーのポート番号。
cluster_ca_certificate

string

出力専用。クラスタの CA の PEM でエンコードされた公開証明書。
maintenance_policy

MaintenancePolicy

省略可。クラスタ全体のメンテナンス ポリシー構成。
control_plane_version

string

出力専用。コントロール プレーンのリリース バージョン
node_version

string

出力専用。すべてのワーカーノードの中で最も低いリリース バージョン。クラスタにワーカーノードがない場合、このフィールドは空にできます。
control_plane

ControlPlane

省略可。クラスタ コントロール プレーンの構成。
system_addons_config

SystemAddonsConfig

省略可。システム アドオンの構成。
external_load_balancer_ipv4_address_pools[]

string

省略可。クラスタ データプレーンの外部ロード バランシング用の IPv4 アドレスプール。
control_plane_encryption

ControlPlaneEncryption

省略可。リモート コントロール プレーンのディスク暗号化オプション。このフィールドは、CMEK サポートを有効にする場合にのみ使用されます。
status

Status

出力専用。クラスタの現在のステータス。
maintenance_events[]

MaintenanceEvent

出力専用。クラスタでスケジュールされているすべてのメンテナンス イベント（進行中のもの、今後予定されているもの、過去に実施されたもの（最大 90 日間）を含む）。
target_version

string

省略可。ターゲット クラスタのバージョン。例: 「1.5.0」。
release_channel

ReleaseChannel

省略可。クラスタが登録されているリリース チャンネル。
survivability_config

SurvivabilityConfig

省略可。ネットワーク接続が失われた場合など、クラスタの存続可能性の構成。注: これはローカル コントロール プレーン クラスタにのみ適用されます。
external_load_balancer_ipv6_address_pools[]

string

省略可。クラスタ データプレーンの外部ロード バランシング用の IPv6 アドレスプール。
connection_state

ConnectionState

出力専用。クラスタの現在の接続状態。
external_load_balancer_address_pools[]

ExternalLoadBalancerPool

省略可。クラスタの外部ロードバランサ プール。
zone_storage_encryption

ZoneStorageEncryption

省略可。ゾーン ストレージの暗号化構成
container_runtime_config

ContainerRuntimeConfig

省略可。クラスタのコンテナ ランタイム構成。
enable_cluster_isolation

bool

省略可。これは、クラスタを分離する必要があるかどうかを示します。go/cluster-isolation-in-gdcc-cluster
google_group_authentication

GoogleGroupAuthenticationConfig

省略可。クラスタの Google グループ認証構成。

ConnectionState

ConnectionState は、クラスタから Google への現在の接続状態を保持します。

フィールド
state

State

出力専用。現在の接続状態。
update_time

Timestamp

出力専用。接続状態が最後に変更された時刻。

状態

接続状態。

列挙型
STATE_UNSPECIFIED 接続状態が不明です。
DISCONNECTED このクラスタは現在 Google から切断されています。
CONNECTED このクラスタは現在 Google に接続されています。
CONNECTED_AND_SYNCING このクラスタは現在 Google に接続されていますが、最近接続が切断された後に再接続された可能性があります。まだ同期中です。

ContainerRuntimeConfig

クラスタのコンテナ ランタイム構成。

フィールド
default_container_runtime

DefaultContainerRuntime

省略可。クラスタで構成されるデフォルトのコンテナ ランタイム。

DefaultContainerRuntime

サポートされているコンテナ ランタイムのリスト。

列挙型
DEFAULT_CONTAINER_RUNTIME_UNSPECIFIED コンテナ ランタイムが指定されていません。
RUNC クラスタでデフォルトのコンテナ ランタイムとして runc を使用します。
GVISOR クラスタで gVisor をデフォルトのコンテナ ランタイムとして使用します。

ControlPlane

クラスタ コントロール プレーンの構成。

フィールド

共用体フィールド config。

config は次のいずれかになります。
remote

Remote

リモート コントロール プレーンの構成。
local

Local

ローカル コントロール プレーンの構成。

警告: ローカル コントロール プレーン クラスタは、独自のプロジェクトに作成する必要があります。ローカル コントロール プレーン クラスタは、GDCE 以外のクラスタを含む他のタイプのクラスタと同じプロジェクトに共存できません。同じプロジェクトでローカル コントロール プレーン GDCE クラスタと他のタイプのクラスタを混在させると、データ損失が発生する可能性があります。

ローカル

コントロール プレーンがローカルでホストされているクラスタに固有の構成。

警告: ローカル コントロール プレーン クラスタは、独自のプロジェクトに作成する必要があります。ローカル コントロール プレーン クラスタは、GDCE 以外のクラスタを含む他のタイプのクラスタと同じプロジェクトに共存できません。同じプロジェクトでローカル コントロール プレーン GDCE クラスタと他のタイプのクラスタを混在させると、データ損失が発生する可能性があります。

フィールド
node_location

string

このノードプールが作成される Google Distributed Cloud Edge ゾーンの名前。例: us-central1-edge-customer-a。
node_count

int32

コントロール プレーンのレプリカとして機能するノードの数。
machine_filter

string

このフィルタに一致するマシンのみがコントロール プレーン ノードをホストできます。フィルタリング言語は「name=」のような文字列を受け入れます。詳細については、AIP-160 をご覧ください。
shared_deployment_policy

SharedDeploymentPolicy

ユーザー アプリケーションのデプロイ方法に関するポリシー構成。
control_plane_node_storage_schema

string

省略可。コントロール プレーン ノードのストレージ スキーマの名前。

リモート

この型にはフィールドがありません。

コントロール プレーンがリモートでホストされているクラスタに固有の構成。

SharedDeploymentPolicy

ユーザー アプリケーションのデプロイ方法に関するポリシー構成を表します。

列挙型
SHARED_DEPLOYMENT_POLICY_UNSPECIFIED 指定なし。
ALLOWED ユーザー アプリケーションは、コントロール プレーンとワーカーノードの両方にデプロイできます。
DISALLOWED ユーザー アプリケーションはコントロール プレーン ノードにデプロイできず、ワーカーノードにのみデプロイできます。

ControlPlaneEncryption

コントロール プレーン ノードの顧客管理 KMS 鍵のサポートの構成。

フィールド
kms_key

string

省略可。コントロール プレーン ディスクの保護に使用する Cloud KMS CryptoKey（例: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}）。指定しない場合は、代わりに Google が管理する鍵が使用されます。
kms_key_active_version

string

出力専用。コントロール プレーン ディスクの保護に現在使用されている Cloud KMS CryptoKeyVersion。kms_key が設定されている場合にのみ適用されます。
kms_key_state

KmsKeyState

出力専用。Cloud KMS CryptoKey の可用性。KEY_AVAILABLE でない場合、ノードはローカルデータにアクセスできないため、オフラインになる可能性があります。これは、鍵を使用する権限がない場合、または鍵が無効になっているか削除されている場合に発生する可能性があります。
kms_status

Status

出力専用。この鍵を使用するときに Cloud KMS から返されるエラー ステータス。このフィールドは、kms_key_state が KMS_KEY_STATE_KEY_AVAILABLE でない場合にのみ入力できます。このフィールドに値が設定されている場合、Cloud KMS によって報告されたエラー ステータスが含まれます。
resource_state

ResourceState

出力専用。cmek に関連付けられている現在のリソースの状態。

ExternalLoadBalancerPool

名前、手動/自動割り当て、重複しない IPv4、オプションの IPv6 アドレス範囲などのカスタム構成を持つ外部ロードバランサ プール。

フィールド
address_pool

string

省略可。外部ロードバランサ プールの名前。
ipv4_range[]

string

必須。外部ロードバランサ プールの重複しない IPv4 アドレス範囲。
ipv6_range[]

string

省略可。外部ロードバランサ プールの重複しない IPv6 アドレス範囲。
avoid_buggy_ips

bool

省略可。true の場合、末尾が .0 と .255 の IP アドレスがプールから除外されます。一部のネットワーク ハードウェアは、これらの特別なアドレスへのトラフィックをドロップします。デフォルト値は false です。
manual_assign

bool

省略可。true の場合、このプール内のアドレスは Kubernetes Service に自動的に割り当てられません。true の場合、このプール内の IP アドレスは、サービスによって明示的に指定された場合にのみ使用されます。デフォルト値は false です。

GoogleGroupAuthenticationConfig

クラスタの Google グループ認証構成。go/gdc-google-group-authentication

フィールド
enable

bool

省略可。true の場合、クラスタは Google グループ認証を使用するように構成されます。

MaintenanceEvent

メンテナンス イベントとは、Google 主導またはユーザー主導のクラスタ アップグレード、ノードの再起動を必要とするユーザー主導のクラスタ構成の変更など、クラスタ ワークロードに一時的な中断を引き起こす可能性のあるオペレーションです。

フィールド
uuid

string

出力専用。メンテナンス イベントの UUID。
target_version

string

出力専用。クラスタのターゲット バージョン。
operation

string

出力専用。メンテナンス イベントを実行するオペレーション。projects/*/locations/*/operations/* の形式で指定します。メンテナンス イベントが複数のオペレーションに分割されている場合（メンテナンスの時間枠が原因など）、最新のオペレーションが記録されます。
type

Type

出力専用。メンテナンス イベントのタイプ。
schedule

Schedule

出力専用。メンテナンス イベントのスケジュール。
state

State

出力専用。メンテナンス イベントの状態。
create_time

Timestamp

出力専用。メンテナンス イベント リクエストが作成された時刻。
start_time

Timestamp

出力専用。メンテナンス イベントが開始された時刻。
end_time

Timestamp

出力専用。メンテナンス イベントが正常に終了したかどうかにかかわらず、終了した時間。メンテナンス イベントが複数のメンテナンス ウィンドウに分割されている場合、end_time はフロー全体が終了したときにのみ更新されます。
update_time

Timestamp

出力専用。メンテナンス イベント メッセージが更新された日時。

スケジュール

メンテナンス イベントを実施するタイミングを示します。

列挙型
SCHEDULE_UNSPECIFIED 指定なし。
IMMEDIATELY リクエストを受け取った直後。

状態

メンテナンス イベントの状態を示します。

列挙型
STATE_UNSPECIFIED 指定なし。
RECONCILING メンテナンス イベントが進行中です。クラスタが使用できなくなる可能性があります。
SUCCEEDED メンテナンス イベントが成功しました。
FAILED メンテナンス イベントが失敗しました。

タイプ

メンテナンス イベントのタイプを示します。

列挙型
TYPE_UNSPECIFIED 指定なし。
USER_INITIATED_UPGRADE ユーザーが開始したアップグレード。
GOOGLE_DRIVEN_UPGRADE Google 主導のアップグレード。

ReleaseChannel

クラスタが登録されているリリース チャンネル。

列挙型
RELEASE_CHANNEL_UNSPECIFIED リリース チャンネルが指定されていません。デフォルトでは REGULAR チャンネルが選択されています。
NONE リリース チャンネルはありません。
REGULAR 通常のリリース チャンネル。

ステータス

クラスタのステータスを示します。

列挙型
STATUS_UNSPECIFIED ステータスが不明です。
PROVISIONING クラスタを作成しています。
RUNNING クラスタが作成され、完全に使用可能です。
DELETING クラスタを削除しています。
ERROR ステータスは、クラスタの調整または削除中にエラーが発生したことを示します。
RECONCILING クラスタでバージョン アップグレードなどの作業が行われています。

SurvivabilityConfig

ネットワーク接続が失われた場合など、クラスタの存続可能性の構成。

フィールド
offline_reboot_ttl

Duration

省略可。クラスタノードを再起動して、Google へのネットワーク接続なしで機能させることができる期間。デフォルトの 0 は許可されないことを意味します。最長で 7 日です。

SystemAddonsConfig

お客様が GDCE システム アドオン用に定義できる構成。

フィールド
ingress

Ingress

省略可。Ingress の構成。
vm_service_config

VMServiceConfig

省略可。VM Service の構成。

Ingress

クラスタ内のサーバーへの外部アクセスを管理する Ingress オブジェクトを作成できる Ingress アドオンの構成。アドオンは istiod と istio-ingress で構成されています。

フィールド
disabled

bool

省略可。Ingress が無効かどうか。
ipv4_vip

string

省略可。上り（内向き）VIP。

VMServiceConfig

VMServiceConfig は、GDCE VM Service の構成を定義します。

フィールド
vmm_enabled

bool

省略可。VMM が有効かどうか。

ZoneStorageEncryption

ゾーン ストレージの CMEK サポートの構成

フィールド
kms_key

string

省略可。Cloud KMS 鍵
kms_key_active_version

string

出力専用。現在暗号化/復号に使用されている Cloud KMS CryptoKeyVersion
resource_state

ResourceState

出力専用。CMEK の現在のリソース状態

ClusterNetworking

クラスタ全体のネットワーキング構成。

フィールド
cluster_ipv4_cidr_blocks[]

string

必須。クラスタ内のすべての Pod には、これらのブロックから RFC1918 IPv4 アドレスが割り当てられます。単一のブロックのみがサポートされます。作成後にこのフィールドを変更することはできません。
services_ipv4_cidr_blocks[]

string

必須。クラスタ内のすべてのサービスには、これらのブロックから RFC1918 IPv4 アドレスが割り当てられます。単一のブロックのみがサポートされます。作成後にこのフィールドを変更することはできません。

ClusterUser

RBAC ポリシーのユーザー プリンシパル。

フィールド
username

string

必須。有効な Google ユーザー名。

ConfigData

構成データには、ゾーンに関連するすべての構成データが保持されます。

フィールド
available_external_lb_pools_ipv4[]

string

外部ロードバランサで使用可能な v4 IP プールのリスト
available_external_lb_pools_ipv6[]

string

外部ロードバランサで使用可能な v6 IP プールのリスト

CreateClusterRequest

クラスタを作成します。

フィールド
parent

string

必須。このクラスタが作成される親ロケーション。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • edgecontainer.clusters.create
cluster_id

string

必須。クライアントが指定したクラスタの一意の識別子。
cluster

Cluster

必須。作成するクラスタ。
request_id

string

このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、request_id が指定されている場合にのみべき等です。

CreateNodePoolRequest

ノードプールを作成します。

フィールド
parent

string

必須。このノードプールが作成される親クラスタ。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • edgecontainer.nodePools.create
node_pool_id

string

必須。クライアントが指定したノードプールの固有識別子。
node_pool

NodePool

必須。作成するノードプール。
request_id

string

このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、request_id が指定されている場合にのみべき等です。

CreateVpnConnectionRequest

VPN 接続を作成します。

フィールド
parent

string

必須。この VPN 接続が作成される親ロケーション。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • edgecontainer.vpnConnections.create
vpn_connection_id

string

必須。VPN 接続の ID。
vpn_connection

VpnConnection

必須。作成する VPN 接続。
request_id

string

このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、request_id が指定されている場合にのみべき等です。

DeleteClusterRequest

クラスタを削除します。

フィールド
name

string

必須。クラスタのリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • edgecontainer.clusters.delete
request_id

string

このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、request_id が指定されている場合にのみべき等です。

DeleteNodePoolRequest

ノードプールを削除します。

フィールド
name

string

必須。ノードプールのリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • edgecontainer.nodePools.delete
request_id

string

このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、request_id が指定されている場合にのみべき等です。

DeleteVpnConnectionRequest

VPN 接続を削除します。

フィールド
name

string

必須。VPN 接続のリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • edgecontainer.vpnConnections.delete
request_id

string

このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、request_id が指定されている場合にのみべき等です。

フリート

フリート関連の構成。

フリートとは、複数のクラスタを論理的に編成するための Google Cloud のコンセプトです。フリートを使用することによって、マルチクラスタ機能の使用と管理、複数のシステム間での一貫したポリシーの適用が可能になります。

フィールド
project

string

必須。このクラスタが登録されるフリート ホスト プロジェクトの名前。

プロジェクト名の形式は projects/<project-number> です。
membership

string

出力専用。このクラスタに関連付けられているマネージド Hub メンバーシップ リソースの名前。

メンバーシップ名の形式は projects/<project-number>/locations/global/membership/<cluster-id> です。

GenerateAccessTokenRequest

クラスタのアクセス トークンを生成します。

フィールド
cluster

string

必須。クラスタのリソース名。

認可には、指定されたリソース cluster に対する次の IAM の権限が必要です。

  • edgecontainer.clusters.generateAccessToken

GenerateAccessTokenResponse

クラスタのアクセス トークン。

フィールド
access_token

string

出力専用。k8s api-server での認証に使用するアクセス トークン。
expire_time

Timestamp

出力専用。トークンの有効期限を示すタイムスタンプ。

GenerateOfflineCredentialRequest

クラスタのオフライン認証情報（オフライン）を生成します。

フィールド
cluster

string

必須。クラスタのリソース名。

認可には、指定されたリソース cluster に対する次の IAM の権限が必要です。

  • edgecontainer.clusters.generateOfflineCredential

GenerateOfflineCredentialResponse

クラスタのオフライン認証情報。

フィールド
client_certificate

string

出力専用。k8s api-server での認証に使用するクライアント証明書。
client_key

string

出力専用。k8s api-server での認証に使用するクライアントの秘密鍵。
user_id

string

出力専用。クライアントの ID。
expire_time

Timestamp

出力専用。この認証情報の有効期限を示すタイムスタンプ。

GetClusterRequest

クラスタを取得します。

フィールド
name

string

必須。クラスタのリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • edgecontainer.clusters.get

GetMachineRequest

マシンを取得します。

フィールド
name

string

必須。マシンのリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • edgecontainer.machines.get

GetNodePoolRequest

ノードプールを取得します。

フィールド
name

string

必須。ノードプールのリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • edgecontainer.nodePools.get

GetServerConfigRequest

サーバー構成を取得します。

フィールド
name

string

必須。取得するサーバー構成の名前（プロジェクトとロケーション）。projects/*/locations/* の形式で指定します。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • edgecontainer.serverConfig.get

GetVpnConnectionRequest

VPN 接続を取得します。

フィールド
name

string

必須。VPN 接続のリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • edgecontainer.vpnConnections.get

KmsKeyState

CMEK 統合に使用される顧客管理の KMS 鍵のアクセシビリティ状態を表します。

列挙型
KMS_KEY_STATE_UNSPECIFIED 指定なし。
KMS_KEY_STATE_KEY_AVAILABLE キーは使用可能で、依存リソースにアクセスできる必要があります。
KMS_KEY_STATE_KEY_UNAVAILABLE キーは不明な理由で使用できません。依存リソースにアクセスできない可能性があります。

ListClustersRequest

ロケーション内のクラスタを一覧表示します。

フィールド
parent

string

必須。このクラスタのコレクションを所有する親ロケーション。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • edgecontainer.clusters.list
page_size

int32

一覧表示するリソースの最大数。
page_token

string

前回のリスト リクエストから受け取ったページトークン。前の一覧表示リクエストから受け取ったページトークン。
filter

string

このフィルタに一致するリソースのみが一覧表示されます。
order_by

string

リソースが一覧表示される順序を指定します。

ListClustersResponse

ロケーション内のクラスタのリスト。

フィールド
clusters[]

Cluster

ロケーション内のクラスタ。
next_page_token

string

結果の次ページを取得するためのトークン。
unreachable[]

string

到達できなかったロケーション。

ListMachinesRequest

サイト内のマシンを一覧表示します。

フィールド
parent

string

必須。このマシン コレクションを所有する親サイト。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • edgecontainer.machines.list
page_size

int32

一覧表示するリソースの最大数。
page_token

string

前の一覧表示リクエストから受け取ったページトークン。
filter

string

このフィルタに一致するリソースのみが一覧表示されます。
order_by

string

リソースが一覧表示される順序を指定します。

ListMachinesResponse

サイト内のマシンのリスト。

フィールド
machines[]

Machine

サイト内のマシン。
next_page_token

string

結果の次ページを取得するためのトークン。
unreachable[]

string

到達できなかったロケーション。

ListNodePoolsRequest

クラスタ内のノードプールを一覧表示します。

フィールド
parent

string

必須。このノードプール コレクションを所有する親クラスタ。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • edgecontainer.nodePools.list
page_size

int32

一覧表示するリソースの最大数。
page_token

string

前の一覧表示リクエストから受け取ったページトークン。
filter

string

このフィルタに一致するリソースのみが一覧表示されます。
order_by

string

リソースが一覧表示される順序を指定します。

ListNodePoolsResponse

クラスタ内のノードプールのリスト。

フィールド
node_pools[]

NodePool

クラスタ内のノードプール。
next_page_token

string

結果の次ページを取得するためのトークン。
unreachable[]

string

到達できなかったロケーション。

ListVpnConnectionsRequest

VPN 接続を一覧表示します。

フィールド
parent

string

必須。この VPN 接続のコレクションを所有する親ロケーション。

認可には、指定されたリソース parent に対する次の IAM の権限が必要です。

  • edgecontainer.vpnConnections.list
page_size

int32

一覧表示するリソースの最大数。
page_token

string

前の一覧表示リクエストから受け取ったページトークン。
filter

string

このフィルタに一致するリソースのみが一覧表示されます。
order_by

string

リソースが一覧表示される順序を指定します。

ListVpnConnectionsResponse

ロケーション内の VPN 接続のリスト。

フィールド
vpn_connections[]

VpnConnection

ロケーション内の VpnConnection。
next_page_token

string

結果の次ページを取得するためのトークン。
unreachable[]

string

到達できなかったロケーション。

LocationMetadata

特定の google.cloud.location.Location のメタデータ。

フィールド
available_zones

map<string, ZoneMetadata>

ロケーションで使用可能な Google Distributed Cloud Edge ゾーンのセット。マップは各ゾーンの小文字の ID でキー設定されます。

マシン

Kubernetes ノードとして機能できる Google Distributed Cloud Edge マシン。

フィールド
name

string

必須。マシンのリソース名。
create_time

Timestamp

出力専用。ノードプールが作成された時刻。
update_time

Timestamp

出力専用。ノードプールが最後に更新された時刻。
labels

map<string, string>

このリソースに関連付けられたラベル。
hosted_node

string

このマシンがホストするノードの正規リソース名（例: projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node}）。マシンがノードのロールを担うように割り当てられていない場合は空。

エッジマシンでホストされているコントロール プレーン ノードの場合、次の形式が返されます: 「projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}」。
zone

string

このマシンの Google Distributed Cloud Edge ゾーン。
version

string

出力専用。マシンのソフトウェア バージョン。
disabled

bool

出力専用。マシンが無効かどうか。無効にすると、マシンはサービスを開始できません。
status

Status

出力専用。マシンの現在のステータス。
purpose

Purpose

マシンが使用されるクラスタのタイプ。

目的

マシンの目的は、VIRTUALIZED_WORKLOAD または BAREMETAL_CLUSTER のいずれかです。

列挙型
PURPOSE_UNSPECIFIED 目的が指定されていません。
VIRTUALIZED_WORKLOAD マシンが仮想ワークロードに使用されている。
BAREMETAL_CLUSTER マシンはベアメタル ユーザー クラスタに使用されます。

ステータス

マシンのステータスを示します。

列挙型
STATUS_UNSPECIFIED ステータスが不明です。
READY マシンはノードをホストする準備ができています。これがデフォルトです。
DISABLED_FOR_REPAIR 1 つ以上の無効化申し立てを追加することで、修理のためにマシンが無効化されています。

MaintenanceExclusionWindow

メンテナンスの除外期間を表します。

フィールド
window

TimeWindow

省略可。期間。
id

string

省略可。ウィンドウの一意（クラスタごと）の ID。

MaintenancePolicy

メンテナンス ポリシーの構成。

フィールド
window

MaintenanceWindow

メンテナンスが実行されるメンテナンスの時間枠を指定します。
maintenance_exclusions[]

MaintenanceExclusionWindow

省略可。自動メンテナンスの除外。緊急以外のメンテナンスは、これらの時間枠内で行わないでください。各除外には一意の名前が付けられ、有効または期限切れのいずれかの状態になります。一度に許可されるメンテナンスの除外の最大数は 3 です。

MaintenanceWindow

メンテナンスの時間枠の構成

フィールド
recurring_window

RecurringTimeWindow

定期的なメンテナンスの時間枠の構成。

ノードプール

共通の構成と仕様を持つクラスタ内の Kubernetes ノードのセット。

フィールド
name

string

必須。ノードプールのリソース名。
create_time

Timestamp

出力専用。ノードプールが作成された時刻。
update_time

Timestamp

出力専用。ノードプールが最後に更新された時刻。
labels

map<string, string>

このリソースに関連付けられたラベル。
node_location

string

このノードプールが作成される Google Distributed Cloud Edge ゾーンの名前。例: us-central1-edge-customer-a。
node_count

int32

必須。プール内のノード数。
machine_filter

string

このフィルタに一致するマシンのみがノードプールに参加できます。フィルタリング言語は「name=」のような文字列を受け入れます。詳細については、AIP-160 をご覧ください。
local_disk_encryption

LocalDiskEncryption

省略可。ローカル ディスクの暗号化オプション。このフィールドは、CMEK サポートを有効にする場合にのみ使用されます。
node_version

string

出力専用。すべてのワーカーノードの中で最も低いリリース バージョン。
node_config

NodeConfig

省略可。NodePool 内の各ノードの構成

LocalDiskEncryption

エッジマシンのローカル ディスク暗号化の CMEK サポートの構成。

フィールド
kms_key

string

省略可。ノードのローカル ディスクの保護に使用する Cloud KMS CryptoKey（例: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}）。指定しない場合は、代わりに Google が管理する鍵が使用されます。
kms_key_active_version

string

出力専用。ノードのローカル ディスクの保護に現在使用されている Cloud KMS CryptoKeyVersion。kms_key が設定されている場合にのみ適用されます。
kms_key_state

KmsKeyState

出力専用。Cloud KMS CryptoKey の可用性。KEY_AVAILABLE でない場合、ノードはローカルデータにアクセスできないため、オフラインになる可能性があります。これは、鍵を使用する権限がない場合、または鍵が無効になっているか削除されている場合に発生する可能性があります。
kms_status

Status

出力専用。この鍵を使用するときに Cloud KMS から返されるエラー ステータス。このフィールドは、kms_key_state が KMS_KEY_STATE_KEY_AVAILABLE でない場合にのみ入力できます。このフィールドに値が設定されている場合、Cloud KMS によって報告されたエラー ステータスが含まれます。
resource_state

ResourceState

出力専用。cmek に関連付けられている現在のリソースの状態。

NodeConfig

NodePool 内の各ノードの構成

フィールド
labels

map<string, string>

省略可。Kubernetes ノードのラベル
node_storage_schema

string

省略可。ワーカーノードのストレージ スキーマの名前。

OperationMetadata

Edge Container API メソッドの長時間実行オペレーションのメタデータ。

フィールド
create_time

Timestamp

オペレーションが作成された時刻。
end_time

Timestamp

オペレーションの実行が終了した時刻。
target

string

オペレーションのターゲットに対応するサーバー定義のリソースパス。
verb

string

オペレーションによって実行される動詞。
status_message

string

人が読める形式のオペレーションのステータス（存在する場合）。
requested_cancellation

bool

ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、google.rpc.Status.code が 1 の [Operation.error][] 値を持ちます。これは Code.CANCELLED に相当します。
api_version

string

オペレーションを開始するために使用された API のバージョン。
warnings[]

string

オペレーションをブロックしないが、エンドユーザーが受け取るべき関連情報を含む警告。
status_reason

StatusReason

マシンで読み取り可能な形式のオペレーションのステータス（存在する場合）。

StatusReason

オペレーションのステータスの理由を示します。

列挙型
STATUS_REASON_UNSPECIFIED 理由は不明です。
UPGRADE_PAUSED クラスタのアップグレードは現在一時停止しています。
RETRYABLE_ERROR リクエストでエラーが発生しましたが、再試行可能です。

割り当て

Edge コンテナ リソースの割り当てを表します。

フィールド
metric

string

割り当て指標の名前。
limit

double

この指標の割り当て上限。
usage

double

この指標の現在の使用状況。

RecurringTimeWindow

繰り返される任意の期間を表します。

フィールド
window

TimeWindow

最初の定期購入の期間。
recurrence

string

このウィンドウの繰り返し方法を示す RRULE（https://tools.ietf.org/html/rfc5545#section-3.8.5.3）。開始時刻から終了時刻までの期間にわたって実行されます。

ResourceState

リソースがロックダウン状態か保留中かを表します。

列挙型
RESOURCE_STATE_UNSPECIFIED デフォルト値。
RESOURCE_STATE_LOCK_DOWN リソースはロックダウン状態です。
RESOURCE_STATE_LOCK_DOWN_PENDING リソースはロックダウン保留中です。

ServerConfig

サポートされているバージョンとリリース チャンネルのサーバー構成。

フィールド
channels

map<string, ChannelConfig>

出力専用。リリース チャンネルからチャンネル構成へのマッピング。
versions[]

Version

出力専用。サポートされているバージョン（例）: ["1.4.0", "1.5.0"]。
default_version

string

出力専用。デフォルトのバージョン（例: "1.4.0"。
version_rollouts[]

VersionRollout

出力専用。サーバー構成のロールアウト情報。

TimeWindow

任意の期間を表します。

フィールド
start_time

Timestamp

ウィンドウが最初に開始される時刻。
end_time

Timestamp

ウィンドウの終了時刻。終了時間は開始時間より後にする必要があります。

UpdateClusterRequest

クラスタを更新します。

フィールド
update_mask

FieldMask

フィールド マスクは、更新によって Cluster リソース内で上書きされるフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。
cluster

Cluster

更新されたクラスタ。

認可には、指定されたリソース cluster に対する次の IAM の権限が必要です。

  • edgecontainer.clusters.update
request_id

string

このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、request_id が指定されている場合にのみべき等です。

UpdateNodePoolRequest

ノードプールを更新します。

フィールド
update_mask

FieldMask

フィールド マスクは、更新によって NodePool リソース内で上書きされるフィールドを指定するために使用されます。update_mask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。マスクに含まれるフィールドは上書きされます。ユーザーがマスクを指定しなければ、すべてのフィールドが上書きされます。
node_pool

NodePool

更新されたノードプール。

認可には、指定されたリソース nodePool に対する次の IAM の権限が必要です。

  • edgecontainer.nodePools.update
request_id

string

このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、request_id が指定されている場合にのみべき等です。

UpgradeClusterRequest

クラスタをアップグレードします。

フィールド
name

string

必須。クラスタのリソース名。

認可には、指定されたリソース name に対する次の IAM の権限が必要です。

  • edgecontainer.clusters.upgrade
target_version

string

必須。クラスタのアップグレード先のバージョン。
schedule

Schedule

アップグレードのスケジュール。
request_id

string

このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、request_id が指定されている場合にのみべき等です。

スケジュール

クラスタのアップグレードのスケジュールを表します。

列挙型
SCHEDULE_UNSPECIFIED 指定なし。デフォルトでは、クラスタはすぐにアップグレードされます。これは現在唯一のオプションです。
IMMEDIATELY クラスタはリクエストを受信した直後にアップグレードされます。

バージョン

クラスタのバージョン。

フィールド
name

string

出力専用。バージョンの名前（例:"1.4.0"。

VersionRollout

VersionRollout には、バージョンのロールアウト情報が含まれます。

フィールド
version

string

出力専用。セマンティック バージョン（例: "1.4.0"。
available_zones[]

string

出力専用。バージョンがロールアウトされたゾーンのリスト（例: ["us-central1", "us-west1"]。

VpnConnection

VPN 接続。

フィールド
name

string

必須。VPN 接続のリソース名
create_time

Timestamp

出力専用。VPN 接続が作成された時刻。
update_time

Timestamp

出力専用。VPN 接続が最後に更新された日時。
labels

map<string, string>

このリソースに関連付けられたラベル。
nat_gateway_ip

string

NAT ゲートウェイの IP アドレスまたは WAN IP アドレス。NAT IP が複数ある場合は、1 つの外部 IP のみが GMEC Anthos クラスタにマッピングされるように NAT を構成する必要があります。NAT が使用されていない場合は空になります。
bgp_routing_mode
(deprecated)

BgpRoutingMode

VPC ネットワークの動的ルーティング モード（regional または global）。
cluster

string

接続先の正規クラスタ名。形式は projects/{project}/locations/{location}/clusters/{cluster} です。
vpc

string

接続する VPC のネットワーク ID。
vpc_project

VpcProject

省略可。VPC ネットワークのプロジェクトの詳細。VPC がクラスタ プロジェクトとは異なるプロジェクトにある場合に必要です。
enable_high_availability

bool

この VPN 接続でクラスタ側で HA が有効になっているかどうか。有効にすると、VPN 接続の作成時に 2 つの ANG フローティング IP の使用が試行されます。
router

string

省略可。VPN 接続の Cloud Router 名。
details

Details

出力専用。作成された接続の詳細。

BgpRoutingMode

ルーティング モード。

列挙型
BGP_ROUTING_MODE_UNSPECIFIED 不明。
REGIONAL リージョン モード。
GLOBAL グローバル モード。

詳細

作成された接続の詳細。

フィールド
state

State

この接続の状態。
error

string

エラー メッセージ。これは、state=ERROR の場合にのみ入力されます。
cloud_router

CloudRouter

Cloud Router の情報。
cloud_vpns[]

CloudVpn

各接続には複数の Cloud VPN ゲートウェイがあります。

CloudRouter

Cloud Router の情報。

フィールド
name

string

関連付けられている Cloud Router の名前。

CloudVpn

Cloud VPN の情報。

フィールド
gateway

string

作成された Cloud VPN ゲートウェイの名前。

状態

現在の接続状態。

列挙型
STATE_UNSPECIFIED 不明。
STATE_CONNECTED 接続しました。
STATE_CONNECTING まだ接続中です。
STATE_ERROR エラーが発生しました。

VpcProject

VPC ネットワークのプロジェクトの詳細。

フィールド
project_id

string

接続する VPC のプロジェクト。指定しない場合は、クラスタ プロジェクトと同じになります。
service_account
(deprecated)

string

省略可。非推奨: 使用しないでください。

ZoneMetadata

エッジマシンが配置されている Google Distributed Cloud Edge ゾーン。

フィールド
quota[]

Quota

このゾーンのリソースの割り当て。
rack_types

map<string, RackType>

ラック名でキー付けされたマップ。値は RackType です。
config_data

ConfigData

ゾーンの構成データ。

RackType

ラックのタイプ。

列挙型
RACK_TYPE_UNSPECIFIED ラックタイプが指定されていません。シングル ラックもこのタイプに属します。
BASE 基本ラックタイプ。アグリゲーション スイッチを含む 2 つの変更された構成 1 ラックのペア。
EXPANSION お客様がオンデマンドで追加する拡張ラック タイプ（スタンドアロン ラックとも呼ばれます）。