インデックス
EdgeContainer(インターフェース)Authorization(メッセージ)ChannelConfig(メッセージ)Cluster(メッセージ)Cluster.ConnectionState(メッセージ)Cluster.ConnectionState.State(列挙型)Cluster.ContainerRuntimeConfig(メッセージ)Cluster.ContainerRuntimeConfig.DefaultContainerRuntime(列挙型)Cluster.ControlPlane(メッセージ)Cluster.ControlPlane.Local(メッセージ)Cluster.ControlPlane.Remote(メッセージ)Cluster.ControlPlane.SharedDeploymentPolicy(列挙型)Cluster.ControlPlaneEncryption(メッセージ)Cluster.ExternalLoadBalancerPool(メッセージ)Cluster.GoogleGroupAuthenticationConfig(メッセージ)Cluster.MaintenanceEvent(メッセージ)Cluster.MaintenanceEvent.Schedule(列挙型)Cluster.MaintenanceEvent.State(列挙型)Cluster.MaintenanceEvent.Type(列挙型)Cluster.ReleaseChannel(列挙型)Cluster.Status(列挙型)Cluster.SurvivabilityConfig(メッセージ)Cluster.SystemAddonsConfig(メッセージ)Cluster.SystemAddonsConfig.Ingress(メッセージ)Cluster.SystemAddonsConfig.VMServiceConfig(メッセージ)Cluster.ZoneStorageEncryption(メッセージ)ClusterNetworking(メッセージ)ClusterUser(メッセージ)ConfigData(メッセージ)CreateClusterRequest(メッセージ)CreateNodePoolRequest(メッセージ)CreateVpnConnectionRequest(メッセージ)DeleteClusterRequest(メッセージ)DeleteNodePoolRequest(メッセージ)DeleteVpnConnectionRequest(メッセージ)Fleet(メッセージ)GenerateAccessTokenRequest(メッセージ)GenerateAccessTokenResponse(メッセージ)GenerateOfflineCredentialRequest(メッセージ)GenerateOfflineCredentialResponse(メッセージ)GetClusterRequest(メッセージ)GetMachineRequest(メッセージ)GetNodePoolRequest(メッセージ)GetServerConfigRequest(メッセージ)GetVpnConnectionRequest(メッセージ)KmsKeyState(列挙型)ListClustersRequest(メッセージ)ListClustersResponse(メッセージ)ListMachinesRequest(メッセージ)ListMachinesResponse(メッセージ)ListNodePoolsRequest(メッセージ)ListNodePoolsResponse(メッセージ)ListVpnConnectionsRequest(メッセージ)ListVpnConnectionsResponse(メッセージ)LocationMetadata(メッセージ)Machine(メッセージ)Machine.Purpose(列挙型)Machine.Status(列挙型)MaintenanceExclusionWindow(メッセージ)MaintenancePolicy(メッセージ)MaintenanceWindow(メッセージ)NodePool(メッセージ)NodePool.LocalDiskEncryption(メッセージ)NodePool.NodeConfig(メッセージ)OperationMetadata(メッセージ)OperationMetadata.StatusReason(列挙型)Quota(メッセージ)RecurringTimeWindow(メッセージ)ResourceState(列挙型)ServerConfig(メッセージ)SystemPartitionGiBSize(列挙型)TimeWindow(メッセージ)UpdateClusterRequest(メッセージ)UpdateNodePoolRequest(メッセージ)UpgradeClusterRequest(メッセージ)UpgradeClusterRequest.Schedule(列挙型)Version(メッセージ)VersionRollout(メッセージ)VpnConnection(メッセージ)VpnConnection.BgpRoutingMode(列挙型)VpnConnection.Details(メッセージ)VpnConnection.Details.CloudRouter(メッセージ)VpnConnection.Details.CloudVpn(メッセージ)VpnConnection.Details.State(列挙型)VpnConnection.VpcProject(メッセージ)ZoneMetadata(メッセージ)ZoneMetadata.RackType(列挙型)
EdgeContainer
EdgeContainer API は、Google Edge Cloud デプロイでの Kubernetes クラスタの管理を提供します。
| CreateCluster |
|---|
|
指定されたプロジェクトとロケーションに新しいクラスタを作成します。
|
| CreateNodePool |
|---|
|
指定されたプロジェクトとロケーションに新しい NodePool を作成します。
|
| CreateVpnConnection |
|---|
|
指定されたプロジェクトとロケーションに新しい VPN 接続を作成します。
|
| DeleteCluster |
|---|
|
1 つのクラスタを削除します。
|
| DeleteNodePool |
|---|
|
1 つの NodePool を削除します。
|
| DeleteVpnConnection |
|---|
|
単一の VPN 接続を削除します。
|
| GenerateAccessToken |
|---|
|
クラスタのアクセス トークンを生成します。
|
| GenerateOfflineCredential |
|---|
|
クラスタのオフライン認証情報を生成します。
|
| GetCluster |
|---|
|
1 つのクラスタの詳細を取得します。
|
| GetMachine |
|---|
|
1 つの Machine の詳細を取得します。
|
| GetNodePool |
|---|
|
1 つの NodePool の詳細を取得します。
|
| GetServerConfig |
|---|
|
サーバー構成を取得します。
|
| GetVpnConnection |
|---|
|
1 つの VPN 接続の詳細を取得します。
|
| ListClusters |
|---|
|
指定されたプロジェクトとロケーションのクラスタを一覧表示します。
|
| ListMachines |
|---|
|
指定されたプロジェクトとロケーションの Machine を一覧表示します。
|
| ListNodePools |
|---|
|
指定されたプロジェクトとロケーションの NodePool を一覧表示します。
|
| ListVpnConnections |
|---|
|
指定されたプロジェクトとロケーションの VPN 接続を一覧表示します。
|
| UpdateCluster |
|---|
|
単一のクラスタのパラメータを更新します。
|
| UpdateNodePool |
|---|
|
単一の NodePool のパラメータを更新します。
|
| UpgradeCluster |
|---|
|
単一のクラスタをアップグレードします。
|
承認
GEC によって適用および管理される RBAC ポリシー。
| フィールド | |
|---|---|
admin_users |
必須。クラスタへの完全アクセス権をもつクラスタ管理者ロールが付与されるユーザー。現在は単一のフィールドですが、将来的には複数の管理者を指定できるようになる予定です。 |
ChannelConfig
リリース チャンネルの構成。
| フィールド | |
|---|---|
default_version |
出力専用。このリリース チャンネルのデフォルト バージョン(例: "1.4.0"。 |
クラスタ
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 アドレス。 |
port |
出力専用。Kubernetes API サーバーのポート番号。 |
cluster_ca_certificate |
出力専用。クラスタの CA の PEM でエンコードされた公開証明書。 |
maintenance_policy |
省略可。クラスタ全体のメンテナンス ポリシー構成。 |
control_plane_version |
出力専用。コントロール プレーンのリリース バージョン |
node_version |
出力専用。すべてのワーカーノードの中で最も低いリリース バージョン。クラスタにワーカーノードがない場合、このフィールドは空にできます。 |
control_plane |
省略可。クラスタ コントロール プレーンの構成。 |
system_addons_config |
省略可。システム アドオンの構成。 |
external_load_balancer_ipv4_address_pools[] |
省略可。クラスタ データプレーンの外部ロード バランシング用の IPv4 アドレスプール。 |
control_plane_encryption |
省略可。リモート コントロール プレーンのディスク暗号化オプション。このフィールドは、CMEK サポートを有効にする場合にのみ使用されます。 |
status |
出力専用。クラスタの現在のステータス。 |
maintenance_events[] |
出力専用。クラスタでスケジュールされているすべてのメンテナンス イベント(進行中のもの、今後予定されているもの、過去に実施されたもの(最大 90 日間)を含む)。 |
target_version |
省略可。ターゲット クラスタのバージョン。例: 「1.5.0」。 |
release_channel |
省略可。クラスタが登録されているリリース チャンネル。 |
survivability_config |
省略可。ネットワーク接続が失われた場合など、クラスタの存続可能性の構成。注: これはローカル コントロール プレーン クラスタにのみ適用されます。 |
external_load_balancer_ipv6_address_pools[] |
省略可。クラスタ データプレーンの外部ロード バランシング用の IPv6 アドレスプール。 |
connection_state |
出力専用。クラスタの現在の接続状態。 |
external_load_balancer_address_pools[] |
省略可。クラスタの外部ロードバランサ プール。 |
zone_storage_encryption |
省略可。ゾーン ストレージの暗号化構成 |
container_runtime_config |
省略可。クラスタのコンテナ ランタイム構成。 |
enable_remote_backup |
省略可。true の場合、このクラスタでリモート バックアップ/復元機能が有効になります。 |
enable_cluster_isolation |
省略可。これは、クラスタを分離する必要があるかどうかを示します。go/cluster-isolation-in-gdcc-cluster |
google_group_authentication |
省略可。クラスタの Google グループ認証構成。 |
ConnectionState
ConnectionState は、クラスタから Google への現在の接続状態を保持します。
| フィールド | |
|---|---|
state |
出力専用。現在の接続状態。 |
update_time |
出力専用。接続状態が最後に変更された時刻。 |
状態
接続状態。
| 列挙型 | |
|---|---|
STATE_UNSPECIFIED |
接続状態が不明です。 |
DISCONNECTED |
このクラスタは現在 Google から切断されています。 |
CONNECTED |
このクラスタは現在 Google に接続されています。 |
CONNECTED_AND_SYNCING |
このクラスタは現在 Google に接続されていますが、最近接続が切断された後に再接続された可能性があります。まだ同期中です。 |
ContainerRuntimeConfig
クラスタのコンテナ ランタイム構成。
| フィールド | |
|---|---|
default_container_runtime |
省略可。クラスタで構成されるデフォルトのコンテナ ランタイム。 |
DefaultContainerRuntime
サポートされているコンテナ ランタイムのリスト。
| 列挙型 | |
|---|---|
DEFAULT_CONTAINER_RUNTIME_UNSPECIFIED |
コンテナ ランタイムが指定されていません。 |
RUNC |
クラスタでデフォルトのコンテナ ランタイムとして runc を使用します。 |
GVISOR |
クラスタで gVisor をデフォルトのコンテナ ランタイムとして使用します。 |
ControlPlane
クラスタ コントロール プレーンの構成。
| フィールド | |
|---|---|
共用体フィールド
|
|
remote |
リモート コントロール プレーンの構成。 |
local |
ローカル コントロール プレーンの構成。 警告: ローカル コントロール プレーン クラスタは、独自のプロジェクトに作成する必要があります。ローカル コントロール プレーン クラスタは、GDCE 以外のクラスタを含む他のタイプのクラスタと同じプロジェクトに共存できません。同じプロジェクトでローカル コントロール プレーン GDCE クラスタと他のタイプのクラスタを混在させると、データ損失が発生する可能性があります。 |
ローカル
コントロール プレーンがローカルでホストされているクラスタに固有の構成。
警告: ローカル コントロール プレーン クラスタは、独自のプロジェクトに作成する必要があります。ローカル コントロール プレーン クラスタは、GDCE 以外のクラスタを含む他のタイプのクラスタと同じプロジェクトに共存できません。同じプロジェクトでローカル コントロール プレーン GDCE クラスタと他のタイプのクラスタを混在させると、データ損失が発生する可能性があります。
| フィールド | |
|---|---|
node_location |
このノードプールが作成される Google Distributed Cloud Edge ゾーンの名前。例: |
node_count |
コントロール プレーンのレプリカとして機能するノードの数。 |
machine_filter |
このフィルタに一致するマシンのみがコントロール プレーン ノードをホストできます。フィルタリング言語は「name= |
shared_deployment_policy |
ユーザー アプリケーションのデプロイ方法に関するポリシー構成。 |
control_plane_node_storage_schema |
省略可。コントロール プレーン ノードのストレージ スキーマの名前。 |
control_plane_node_system_partition_size |
省略可。コントロール プレーン ノードのシステム パーティション サイズ(GiB)。 |
リモート
この型にはフィールドがありません。
コントロール プレーンがリモートでホストされているクラスタに固有の構成。
ControlPlaneEncryption
コントロール プレーン ノードの顧客管理 KMS 鍵のサポートの構成。
| フィールド | |
|---|---|
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 から返されるエラー ステータス。このフィールドは、 |
resource_state |
出力専用。cmek に関連付けられている現在のリソースの状態。 |
ExternalLoadBalancerPool
名前、手動/自動割り当て、重複しない IPv4、オプションの IPv6 アドレス範囲などのカスタム構成を持つ外部ロードバランサ プール。
| フィールド | |
|---|---|
address_pool |
省略可。外部ロードバランサ プールの名前。 |
ipv4_range[] |
必須。外部ロードバランサ プールの重複しない IPv4 アドレス範囲。 |
ipv6_range[] |
省略可。外部ロードバランサ プールの重複しない IPv6 アドレス範囲。 |
avoid_buggy_ips |
省略可。true の場合、末尾が .0 と .255 の IP アドレスがプールから除外されます。一部のネットワーク ハードウェアは、これらの特別なアドレスへのトラフィックをドロップします。デフォルト値は false です。 |
manual_assign |
省略可。true の場合、このプール内のアドレスは Kubernetes Service に自動的に割り当てられません。true の場合、このプール内の IP アドレスは、サービスによって明示的に指定された場合にのみ使用されます。デフォルト値は false です。 |
GoogleGroupAuthenticationConfig
クラスタの Google グループ認証構成。go/gdc-google-group-authentication
| フィールド | |
|---|---|
enable |
省略可。true の場合、クラスタは Google グループ認証を使用するように構成されます。 |
MaintenanceEvent
メンテナンス イベントとは、Google 主導またはユーザー主導のクラスタ アップグレード、ノードの再起動を必要とするユーザー主導のクラスタ構成の変更など、クラスタ ワークロードに一時的な中断を引き起こす可能性のあるオペレーションです。
| フィールド | |
|---|---|
uuid |
出力専用。メンテナンス イベントの UUID。 |
target_version |
出力専用。クラスタのターゲット バージョン。 |
operation |
出力専用。メンテナンス イベントを実行するオペレーション。projects/*/locations/*/operations/* の形式で指定します。メンテナンス イベントが複数のオペレーションに分割されている場合(メンテナンスの時間枠が原因など)、最新のオペレーションが記録されます。 |
type |
出力専用。メンテナンス イベントのタイプ。 |
schedule |
出力専用。メンテナンス イベントのスケジュール。 |
state |
出力専用。メンテナンス イベントの状態。 |
create_time |
出力専用。メンテナンス イベント リクエストが作成された時刻。 |
start_time |
出力専用。メンテナンス イベントが開始された時刻。 |
end_time |
出力専用。メンテナンス イベントが正常に終了したかどうかにかかわらず、終了した時間。メンテナンス イベントが複数のメンテナンス ウィンドウに分割されている場合、end_time はフロー全体が終了したときにのみ更新されます。 |
update_time |
出力専用。メンテナンス イベント メッセージが更新された日時。 |
スケジュール
メンテナンス イベントを実施するタイミングを示します。
| 列挙型 | |
|---|---|
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 |
省略可。クラスタノードを再起動して、Google へのネットワーク接続なしで機能させることができる期間。デフォルトの 0 は許可されないことを意味します。最長で 30 日です。 |
SystemAddonsConfig
お客様が GDCE システム アドオン用に定義できる構成。
| フィールド | |
|---|---|
ingress |
省略可。Ingress の構成。 |
vm_service_config |
省略可。VM Service の構成。 |
Ingress
クラスタ内のサーバーへの外部アクセスを管理する Ingress オブジェクトを作成できる Ingress アドオンの構成。アドオンは istiod と istio-ingress で構成されています。
| フィールド | |
|---|---|
disabled |
省略可。Ingress が無効かどうか。 |
ipv4_vip |
省略可。上り(内向き)VIP。 |
VMServiceConfig
VMServiceConfig は、GDCE VM Service の構成を定義します。
| フィールド | |
|---|---|
vmm_enabled |
省略可。VMM が有効かどうか。 |
ZoneStorageEncryption
ゾーン ストレージの CMEK サポートの構成
| フィールド | |
|---|---|
kms_key |
省略可。Cloud KMS 鍵 |
kms_key_active_version |
出力専用。現在暗号化/復号に使用されている Cloud KMS CryptoKeyVersion |
resource_state |
出力専用。CMEK の現在のリソース状態 |
ClusterNetworking
クラスタ全体のネットワーキング構成。
| フィールド | |
|---|---|
cluster_ipv4_cidr_blocks[] |
必須。クラスタ内のすべての Pod には、これらのブロックから RFC1918 IPv4 アドレスが割り当てられます。単一のブロックのみがサポートされます。作成後にこのフィールドを変更することはできません。 |
services_ipv4_cidr_blocks[] |
必須。クラスタ内のすべてのサービスには、これらのブロックから RFC1918 IPv4 アドレスが割り当てられます。単一のブロックのみがサポートされます。作成後にこのフィールドを変更することはできません。 |
ClusterUser
RBAC ポリシーのユーザー プリンシパル。
| フィールド | |
|---|---|
username |
必須。有効な Google ユーザー名。 |
ConfigData
構成データには、ゾーンに関連するすべての構成データが保持されます。
| フィールド | |
|---|---|
available_external_lb_pools_ipv4[] |
外部ロードバランサで使用可能な v4 IP プールのリスト |
available_external_lb_pools_ipv6[] |
外部ロードバランサで使用可能な v6 IP プールのリスト |
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 |
出力専用。トークンの有効期限を示すタイムスタンプ。 |
GenerateOfflineCredentialRequest
クラスタのオフライン認証情報(オフライン)を生成します。
| フィールド | |
|---|---|
cluster |
必須。クラスタのリソース名。 認可には、指定されたリソース
|
GenerateOfflineCredentialResponse
クラスタのオフライン認証情報。
| フィールド | |
|---|---|
client_certificate |
出力専用。k8s api-server での認証に使用するクライアント証明書。 |
client_key |
出力専用。k8s api-server での認証に使用するクライアントの秘密鍵。 |
user_id |
出力専用。クライアントの ID。 |
expire_time |
出力専用。この認証情報の有効期限を示すタイムスタンプ。 |
GetClusterRequest
クラスタを取得します。
| フィールド | |
|---|---|
name |
必須。クラスタのリソース名。 認可には、指定されたリソース
|
GetMachineRequest
マシンを取得します。
| フィールド | |
|---|---|
name |
必須。マシンのリソース名。 認可には、指定されたリソース
|
GetNodePoolRequest
ノードプールを取得します。
| フィールド | |
|---|---|
name |
必須。ノードプールのリソース名。 認可には、指定されたリソース
|
GetServerConfigRequest
サーバー構成を取得します。
| フィールド | |
|---|---|
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 |
出力専用。マシンが無効かどうか。無効にすると、マシンはサービスを開始できません。 |
status |
出力専用。マシンの現在のステータス。 |
purpose |
マシンが使用されるクラスタのタイプ。 |
目的
マシンの目的は、VIRTUALIZED_WORKLOAD または BAREMETAL_CLUSTER のいずれかです。
| 列挙型 | |
|---|---|
PURPOSE_UNSPECIFIED |
目的が指定されていません。 |
VIRTUALIZED_WORKLOAD |
マシンが仮想ワークロードに使用されている。 |
BAREMETAL_CLUSTER |
マシンはベアメタル ユーザー クラスタに使用されます。 |
ステータス
マシンのステータスを示します。
| 列挙型 | |
|---|---|
STATUS_UNSPECIFIED |
ステータスが不明です。 |
READY |
マシンはノードをホストする準備ができています。これがデフォルトです。 |
DISABLED_FOR_REPAIR |
1 つ以上の無効化申し立てを追加することで、修理のためにマシンが無効化されています。 |
MaintenanceExclusionWindow
メンテナンスの除外期間を表します。
| フィールド | |
|---|---|
window |
省略可。期間。 |
id |
省略可。ウィンドウの一意(クラスタごと)の ID。 |
MaintenancePolicy
メンテナンス ポリシーの構成。
| フィールド | |
|---|---|
window |
メンテナンスが実行されるメンテナンスの時間枠を指定します。 |
maintenance_exclusions[] |
省略可。自動メンテナンスの除外。緊急以外のメンテナンスは、これらの時間枠内で行わないでください。各除外には一意の名前が付けられ、有効または期限切れのいずれかの状態になります。一度に許可されるメンテナンスの除外の最大数は 3 です。 |
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 |
出力専用。すべてのワーカーノードの中で最も低いリリース バージョン。 |
node_config |
省略可。NodePool 内の各ノードの構成 |
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 から返されるエラー ステータス。このフィールドは、 |
resource_state |
出力専用。cmek に関連付けられている現在のリソースの状態。 |
NodeConfig
NodePool 内の各ノードの構成
| フィールド | |
|---|---|
labels |
省略可。Kubernetes ノードのラベル |
node_storage_schema |
省略可。ワーカーノードのストレージ スキーマの名前。 |
node_system_partition_size |
省略可。ワーカーノードのシステム パーティション サイズ(GiB)。 |
OperationMetadata
Edge Container API メソッドの長時間実行オペレーションのメタデータ。
| フィールド | |
|---|---|
create_time |
オペレーションが作成された時刻。 |
end_time |
オペレーションの実行が終了した時刻。 |
target |
オペレーションのターゲットに対応するサーバー定義のリソースパス。 |
verb |
オペレーションによって実行される動詞。 |
status_message |
人が読める形式のオペレーションのステータス(存在する場合)。 |
requested_cancellation |
ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、 |
api_version |
オペレーションを開始するために使用された API のバージョン。 |
warnings[] |
オペレーションをブロックしないが、エンドユーザーが受け取るべき関連情報を含む警告。 |
status_reason |
マシンで読み取り可能な形式のオペレーションのステータス(存在する場合)。 |
StatusReason
オペレーションのステータスの理由を示します。
| 列挙型 | |
|---|---|
STATUS_REASON_UNSPECIFIED |
理由は不明です。 |
UPGRADE_PAUSED |
クラスタのアップグレードは現在一時停止しています。 |
RETRYABLE_ERROR |
リクエストでエラーが発生しましたが、再試行可能です。 |
割り当て
Edge コンテナ リソースの割り当てを表します。
| フィールド | |
|---|---|
metric |
割り当て指標の名前。 |
limit |
この指標の割り当て上限。 |
usage |
この指標の現在の使用状況。 |
RecurringTimeWindow
繰り返される任意の期間を表します。
| フィールド | |
|---|---|
window |
最初の定期購入の期間。 |
recurrence |
このウィンドウの繰り返し方法を示す 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 |
出力専用。リリース チャンネルからチャンネル構成へのマッピング。 |
versions[] |
出力専用。サポートされているバージョン(例): ["1.4.0", "1.5.0"]。 |
default_version |
出力専用。デフォルトのバージョン(例: "1.4.0"。 |
version_rollouts[] |
出力専用。サーバー構成のロールアウト情報。 |
SystemPartitionGiBSize
SystemPartitionGiBSize は、許可されるシステム パーティション サイズを GiB で表します。
| 列挙型 | |
|---|---|
SYSTEM_PARTITION_GIB_SIZE_UNSPECIFIED |
システム パーティションのサイズがユーザーによって指定されていません。これにより、システム パーティション サイズは、そのノードに適用されるシステム ストレージ スキーマで指定されたサイズ(100 GiB)に設定されます。 |
SYSTEM_PARTITION_GIB_SIZE100 |
100 GiB のシステム パーティション サイズ(デフォルトのサイズ)。 |
SYSTEM_PARTITION_GIB_SIZE300 |
300GiB のシステム パーティション サイズ。100 GiB のデフォルトをオーバーライドするために使用できます。 |
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 をおすすめします。このリクエストは、 |
UpgradeClusterRequest
クラスタをアップグレードします。
| フィールド | |
|---|---|
name |
必須。クラスタのリソース名。 認可には、指定されたリソース
|
target_version |
必須。クラスタのアップグレード先のバージョン。 |
schedule |
アップグレードのスケジュール。 |
request_id |
このリクエストの一意の識別子。36 個の ASCII 文字に制限されています。ランダムな UUID をおすすめします。このリクエストは、 |
スケジュール
クラスタのアップグレードのスケジュールを表します。
| 列挙型 | |
|---|---|
SCHEDULE_UNSPECIFIED |
指定なし。デフォルトでは、クラスタはすぐにアップグレードされます。これは現在唯一のオプションです。 |
IMMEDIATELY |
クラスタはリクエストを受信した直後にアップグレードされます。 |
バージョン
クラスタのバージョン。
| フィールド | |
|---|---|
name |
出力専用。バージョンの名前(例:"1.4.0"。 |
VersionRollout
VersionRollout には、バージョンのロールアウト情報が含まれます。
| フィールド | |
|---|---|
version |
出力専用。セマンティック バージョン(例: "1.4.0"。 |
available_zones[] |
出力専用。バージョンがロールアウトされたゾーンのリスト(例: ["us-central1", "us-west1"]。 |
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 の使用が試行されます。 |
router |
省略可。VPN 接続の Cloud Router 名。 |
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 |
省略可。非推奨: 使用しないでください。 |
ZoneMetadata
エッジマシンが配置されている Google Distributed Cloud Edge ゾーン。
| フィールド | |
|---|---|
quota[] |
このゾーンのリソースの割り当て。 |
rack_types |
ラック名でキー付けされたマップ。値は RackType です。 |
config_data |
ゾーンの構成データ。 |
RackType
ラックのタイプ。
| 列挙型 | |
|---|---|
RACK_TYPE_UNSPECIFIED |
ラックタイプが指定されていません。シングル ラックもこのタイプに属します。 |
BASE |
基本ラックタイプ。アグリゲーション スイッチを含む 2 つの変更された構成 1 ラックのペア。 |
EXPANSION |
お客様がオンデマンドで追加する拡張ラック タイプ(スタンドアロン ラックとも呼ばれます)。 |