Índice
EdgeContainer(interface)Authorization(mensagem)Cluster(mensagem)ClusterNetworking(mensagem)ClusterUser(mensagem)CreateClusterRequest(mensagem)CreateNodePoolRequest(mensagem)CreateVpnConnectionRequest(mensagem)DeleteClusterRequest(mensagem)DeleteNodePoolRequest(mensagem)DeleteVpnConnectionRequest(mensagem)Fleet(mensagem)GenerateAccessTokenRequest(mensagem)GenerateAccessTokenResponse(mensagem)GetClusterRequest(mensagem)GetMachineRequest(mensagem)GetNodePoolRequest(mensagem)GetVpnConnectionRequest(mensagem)KmsKeyState(enum)ListClustersRequest(mensagem)ListClustersResponse(mensagem)ListMachinesRequest(mensagem)ListMachinesResponse(mensagem)ListNodePoolsRequest(mensagem)ListNodePoolsResponse(mensagem)ListVpnConnectionsRequest(mensagem)ListVpnConnectionsResponse(mensagem)LocationMetadata(mensagem)Machine(mensagem)MaintenancePolicy(mensagem)MaintenanceWindow(mensagem)NodePool(mensagem)NodePool.LocalDiskEncryption(mensagem)OperationMetadata(mensagem)Quota(mensagem)RecurringTimeWindow(mensagem)TimeWindow(mensagem)UpdateClusterRequest(mensagem)UpdateNodePoolRequest(mensagem)VpnConnection(mensagem)VpnConnection.BgpRoutingMode(enum)VpnConnection.Details(mensagem)VpnConnection.Details.CloudRouter(mensagem)VpnConnection.Details.CloudVpn(mensagem)VpnConnection.Details.State(enum)VpnConnection.VpcProject(mensagem)ZoneMetadata(mensagem)
EdgeContainer
A API EdgeContainer oferece gerenciamento de clusters do Kubernetes em implantações do Google Edge Cloud.
| CreateCluster |
|---|
|
Cria um novo cluster em determinado projeto e local.
|
| CreateNodePool |
|---|
|
Cria um novo NodePool em determinado projeto e local.
|
| CreateVpnConnection |
|---|
|
Cria uma conexão VPN em determinado projeto e local.
|
| DeleteCluster |
|---|
|
Exclui um único cluster.
|
| DeleteNodePool |
|---|
|
Exclui um único NodePool.
|
| DeleteVpnConnection |
|---|
|
Exclui uma única conexão VPN.
|
| GenerateAccessToken |
|---|
|
Gera um token de acesso para um cluster.
|
| GetCluster |
|---|
|
Recebe detalhes de um único cluster.
|
| GetMachine |
|---|
|
Recebe detalhes de uma única máquina.
|
| GetNodePool |
|---|
|
Recebe detalhes de um único NodePool.
|
| GetVpnConnection |
|---|
|
Recebe detalhes de uma única conexão VPN.
|
| ListClusters |
|---|
|
Lista os clusters em um determinado projeto e local.
|
| ListMachines |
|---|
|
Lista as máquinas em um determinado projeto e local.
|
| ListNodePools |
|---|
|
Lista os NodePools em determinado projeto e local.
|
| ListVpnConnections |
|---|
|
Lista as conexões VPN em um determinado projeto e local.
|
| UpdateCluster |
|---|
|
Atualiza os parâmetros de um único cluster.
|
| UpdateNodePool |
|---|
|
Atualiza os parâmetros de um único NodePool.
|
Autorização
Política de RBAC que será aplicada e gerenciada pelo GEC.
| Campos | |
|---|---|
admin_users |
Obrigatório. Usuário que receberá o papel de administrador do cluster e terá acesso total a ele. No momento, esse é um campo único, mas será expandido para permitir vários administradores no futuro. |
Cluster
Um cluster do Kubernetes do Google Distributed Cloud Edge.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso do cluster. |
create_time |
Apenas saída. O horário de criação do cluster. |
update_time |
Apenas saída. A hora em que o cluster foi atualizado pela última vez. |
labels |
Rótulos associados a este recurso. |
fleet |
Opcional. Configuração da frota. |
networking |
Obrigatório. Configuração de rede em todo o cluster. |
authorization |
Obrigatório. Imutável. Política de RBAC que será aplicada e gerenciada pelo GEC. |
default_max_pods_per_node |
Opcional. O número máximo padrão de pods por nó usado se um valor máximo não for especificado explicitamente para um pool de nós neste cluster. Se não for especificado, o valor padrão do Kubernetes será usado. |
endpoint |
Apenas saída. O endereço IP do servidor da API Kubernetes. |
cluster_ca_certificate |
Apenas saída. O certificado público codificado em PEM da CA do cluster. |
maintenance_policy |
Opcional. Configuração da política de manutenção em todo o cluster. |
control_plane_version |
Apenas saída. A versão de lançamento do plano de controle |
node_version |
Apenas saída. A versão de lançamento mais baixa entre todos os nós de trabalho. Esse campo pode ficar vazio se o cluster não tiver nós de trabalho. |
ClusterNetworking
Configuração de rede em todo o cluster.
| Campos | |
|---|---|
cluster_ipv4_cidr_blocks[] |
Obrigatório. Todos os pods no cluster recebem um endereço IPv4 RFC1918 desses blocos. Só é possível usar um bloco. Este campo não pode ser alterado após a criação. |
services_ipv4_cidr_blocks[] |
Obrigatório. Todos os serviços do cluster recebem um endereço IPv4 RFC1918 desses blocos. Só é possível usar um bloco. Este campo não pode ser alterado após a criação. |
ClusterUser
Um principal de usuário para uma política de RBAC.
| Campos | |
|---|---|
username |
Obrigatório. Um nome de usuário do Google ativo. |
CreateClusterRequest
Cria um cluster.
| Campos | |
|---|---|
parent |
Obrigatório. O local pai em que o cluster será criado. A autorização requer a seguinte permissão do IAM no recurso especificado
|
cluster_id |
Obrigatório. Um identificador exclusivo especificado pelo cliente para o cluster. |
cluster |
Obrigatório. O cluster a ser criado. |
request_id |
Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se |
CreateNodePoolRequest
Cria um pool de nós.
| Campos | |
|---|---|
parent |
Obrigatório. O cluster pai em que este pool de nós será criado. A autorização requer a seguinte permissão do IAM no recurso especificado
|
node_pool_id |
Obrigatório. Um identificador exclusivo especificado pelo cliente para o pool de nós. |
node_pool |
Obrigatório. O pool de nós a ser criado. |
request_id |
Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se |
CreateVpnConnectionRequest
Cria uma conexão VPN.
| Campos | |
|---|---|
parent |
Obrigatório. O local pai em que essa conexão VPN será criada. A autorização requer a seguinte permissão do IAM no recurso especificado
|
vpn_connection_id |
Obrigatório. O identificador da conexão VPN. |
vpn_connection |
Obrigatório. A conexão VPN a ser criada. |
request_id |
Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se |
DeleteClusterRequest
Exclui um cluster.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso do cluster. A autorização requer a seguinte permissão do IAM no recurso especificado
|
request_id |
Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se |
DeleteNodePoolRequest
Exclui um pool de nós.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso do pool de nós. A autorização requer a seguinte permissão do IAM no recurso especificado
|
request_id |
Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se |
DeleteVpnConnectionRequest
Exclui uma conexão VPN.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso da conexão VPN. A autorização requer a seguinte permissão do IAM no recurso especificado
|
request_id |
Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se |
Frota
Configuração relacionada à frota.
As frotas são um conceito do Google Cloud voltado à organização lógica de clusters. Com elas, é possível usar e gerenciar recursos de vários clusters e aplicar políticas consistentes em todos os sistemas.
| Campos | |
|---|---|
project |
Obrigatório. O número do projeto host da frota em que este cluster será registrado. Os nomes de projetos são formatados como |
membership |
Apenas saída. O nome do recurso de assinatura de hub gerenciado associado a esse cluster. Os nomes de assinaturas são formatados como |
GenerateAccessTokenRequest
Gera um token de acesso para um cluster.
| Campos | |
|---|---|
cluster |
Obrigatório. O nome do recurso do cluster. A autorização requer a seguinte permissão do IAM no recurso especificado
|
GenerateAccessTokenResponse
Um token de acesso para um cluster.
| Campos | |
|---|---|
access_token |
Apenas saída. Token de acesso para autenticação no api-server do K8s. |
expire_time |
Apenas saída. Carimbo de data/hora em que o token vai expirar. |
GetClusterRequest
Recebe um cluster.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso do cluster. A autorização requer a seguinte permissão do IAM no recurso especificado
|
GetMachineRequest
Recebe uma máquina.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso da máquina. A autorização requer a seguinte permissão do IAM no recurso especificado
|
GetNodePoolRequest
Recebe um pool de nós.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso do pool de nós. A autorização requer a seguinte permissão do IAM no recurso especificado
|
GetVpnConnectionRequest
Recebe uma conexão VPN.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso da conexão VPN. A autorização requer a seguinte permissão do IAM no recurso especificado
|
KmsKeyState
Representa o estado de acessibilidade de uma chave do KMS gerenciada pelo cliente usada para integração da CMEK.
| Tipos enumerados | |
|---|---|
KMS_KEY_STATE_UNSPECIFIED |
Não especificado. |
KMS_KEY_STATE_KEY_AVAILABLE |
A chave está disponível para uso, e os recursos dependentes precisam estar acessíveis. |
KMS_KEY_STATE_KEY_UNAVAILABLE |
A chave está indisponível por um motivo não especificado. Os recursos dependentes podem estar inacessíveis. |
ListClustersRequest
Lista os clusters em um local.
| Campos | |
|---|---|
parent |
Obrigatório. O local pai, que tem essa coleção de clusters. A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_size |
O número máximo de recursos a serem listados. |
page_token |
Um token de página recebido de uma solicitação de lista anterior. Um token de página recebido de uma solicitação de lista anterior. |
filter |
Somente os recursos que corresponderem a esse filtro serão listados. |
order_by |
Especifica a ordem em que os recursos serão listados. |
ListClustersResponse
Lista de clusters em um local.
| Campos | |
|---|---|
clusters[] |
Clusters no local. |
next_page_token |
Token para recuperar a próxima página de resultados. |
unreachable[] |
Locais que não puderam ser alcançados. |
ListMachinesRequest
Lista máquinas em um site.
| Campos | |
|---|---|
parent |
Obrigatório. O site principal, que é proprietário dessa coleção de máquinas. A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_size |
O número máximo de recursos a serem listados. |
page_token |
Um token de página recebido de uma solicitação de lista anterior. |
filter |
Somente os recursos que corresponderem a esse filtro serão listados. |
order_by |
Especifica a ordem em que os recursos serão listados. |
ListMachinesResponse
Lista de máquinas em um site.
| Campos | |
|---|---|
machines[] |
Máquinas no site. |
next_page_token |
Token para recuperar a próxima página de resultados. |
unreachable[] |
Locais que não puderam ser alcançados. |
ListNodePoolsRequest
Lista os pools de nós em um cluster.
| Campos | |
|---|---|
parent |
Obrigatório. O cluster pai, que tem essa coleção de pools de nós. A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_size |
O número máximo de recursos a serem listados. |
page_token |
Um token de página recebido de uma solicitação de lista anterior. |
filter |
Somente os recursos que corresponderem a esse filtro serão listados. |
order_by |
Especifica a ordem em que os recursos serão listados. |
ListNodePoolsResponse
Lista de pools de nós em um cluster.
| Campos | |
|---|---|
node_pools[] |
Pools de nós no cluster. |
next_page_token |
Token para recuperar a próxima página de resultados. |
unreachable[] |
Locais que não puderam ser alcançados. |
ListVpnConnectionsRequest
Lista as conexões VPN.
| Campos | |
|---|---|
parent |
Obrigatório. O local pai, que tem essa coleção de conexões VPN. A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_size |
O número máximo de recursos a serem listados. |
page_token |
Um token de página recebido de uma solicitação de lista anterior. |
filter |
Somente os recursos que corresponderem a esse filtro serão listados. |
order_by |
Especifica a ordem em que os recursos serão listados. |
ListVpnConnectionsResponse
Lista de conexões VPN em um local.
| Campos | |
|---|---|
vpn_connections[] |
VpnConnections no local. |
next_page_token |
Token para recuperar a próxima página de resultados. |
unreachable[] |
Locais que não puderam ser alcançados. |
LocationMetadata
Metadados para um determinado google.cloud.location.Location.
| Campos | |
|---|---|
available_zones |
O conjunto de zonas do Google Distributed Cloud Edge disponíveis no local. O mapa é indexado pelo ID em letras minúsculas de cada zona. |
Máquina
Uma máquina do Google Distributed Cloud Edge capaz de atuar como um nó do Kubernetes.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso da máquina. |
create_time |
Apenas saída. A hora em que o pool de nós foi criado. |
update_time |
Apenas saída. A hora em que o pool de nós foi atualizado pela última vez. |
labels |
Rótulos associados a este recurso. |
hosted_node |
Nome canônico do recurso do nó que esta máquina é responsável por hospedar, por exemplo, projects/{project}/locations/{location}/clusters/{cluster_id}/nodePools/{pool_id}/{node}, ou vazio se a máquina não estiver atribuída para assumir a função de um nó. Para nós do plano de controle hospedados em máquinas de borda, isso vai retornar o seguinte formato: "projects/{project}/locations/{location}/clusters/{cluster_id}/controlPlaneNodes/{node}". |
zone |
A zona do Google Distributed Cloud Edge desta máquina. |
version |
Apenas saída. A versão do software da máquina. |
disabled |
Apenas saída. Se a máquina está desativada. Se estiver desativada, a máquina não poderá entrar em serviço. |
MaintenancePolicy
Configuração da política de manutenção.
| Campos | |
|---|---|
window |
Especifica a janela de manutenção em que a manutenção pode ser realizada. |
MaintenanceWindow
Configuração da janela de manutenção
| Campos | |
|---|---|
recurring_window |
Configuração de uma janela de manutenção recorrente. |
NodePool
Um conjunto de nós do Kubernetes em um cluster com configuração e especificação comuns.
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso do pool de nós. |
create_time |
Apenas saída. A hora em que o pool de nós foi criado. |
update_time |
Apenas saída. A hora em que o pool de nós foi atualizado pela última vez. |
labels |
Rótulos associados a este recurso. |
node_location |
Nome da zona do Google Distributed Cloud Edge em que o pool de nós será criado. Por exemplo, |
node_count |
Obrigatório. O número de nós no pool. |
machine_filter |
Somente as máquinas que correspondem a esse filtro podem participar do pool de nós. A linguagem de filtragem aceita strings como "name= |
local_disk_encryption |
Opcional. Opções de criptografia de disco local. Esse campo só é usado ao ativar o suporte à CMEK. |
node_version |
Apenas saída. A versão de lançamento mais baixa entre todos os nós de trabalho. |
LocalDiskEncryption
Configuração para compatibilidade com CMEK para criptografia de disco local da máquina de borda.
| Campos | |
|---|---|
kms_key |
Imutável. A CryptoKey do Cloud KMS, por exemplo, projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}, a ser usada para proteger discos locais do nó. Se não for especificada, uma chave gerenciada pelo Google será usada. |
kms_key_active_version |
Apenas saída. A CryptoKeyVersion do Cloud KMS atualmente em uso para proteger discos locais do nó. Só é aplicável se kms_key estiver definido. |
kms_key_state |
Apenas saída. Disponibilidade da CryptoKey do Cloud KMS. Se não for |
kms_status |
Apenas saída. Status de erro retornado pelo Cloud KMS ao usar essa chave. Esse campo só pode ser preenchido se |
OperationMetadata
Metadados de operações de longa duração para métodos da API Edge Container.
| Campos | |
|---|---|
create_time |
A hora em que a operação foi criada. |
end_time |
O horário em que a operação terminou de ser executada. |
target |
Caminho do recurso definido pelo servidor para o destino da operação. |
verb |
O verbo executado pela operação. |
status_message |
Status legível da operação, caso haja um. |
requested_cancellation |
Identifica se o usuário solicitou o cancelamento da operação. As operações que foram canceladas com êxito têm o valor [Operation.error][] com um |
api_version |
Versão da API usada para iniciar a operação. |
warnings[] |
Avisos que não bloqueiam a operação, mas ainda contêm informações relevantes para o usuário final. |
Cota
Representa a cota para recursos de contêiner de borda.
| Campos | |
|---|---|
metric |
Nome da métrica de cota. |
limit |
Limite de cota para essa métrica. |
usage |
Uso atual dessa métrica. |
RecurringTimeWindow
Representa um período arbitrário que se repete.
| Campos | |
|---|---|
window |
O período da primeira recorrência. |
recurrence |
Uma RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) para a recorrência dessa janela. Eles duram o período entre o horário de início e término. |
TimeWindow
Representa um período arbitrário.
| Campos | |
|---|---|
start_time |
O horário em que a janela começa. |
end_time |
O horário em que a janela termina. O horário de término precisa ser posterior ao horário de início. |
UpdateClusterRequest
Atualiza um cluster.
| Campos | |
|---|---|
update_mask |
A máscara de campo é usada para especificar os campos a serem substituídos no recurso Cluster pela atualização. Os campos especificados em update_mask são relativos ao recurso, não à solicitação completa. Um campo será substituído se estiver na máscara. Se o usuário não fornecer uma máscara, todos os campos serão substituídos. |
cluster |
O cluster atualizado. A autorização requer a seguinte permissão do IAM no recurso especificado
|
request_id |
Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se |
UpdateNodePoolRequest
Atualiza um pool de nós.
| Campos | |
|---|---|
update_mask |
A máscara de campo é usada para especificar os campos a serem substituídos no recurso NodePool pela atualização. Os campos especificados em update_mask são relativos ao recurso, não à solicitação completa. Um campo será substituído se estiver na máscara. Se o usuário não fornecer uma máscara, todos os campos serão substituídos. |
node_pool |
O pool de nós atualizado. A autorização requer a seguinte permissão do IAM no recurso especificado
|
request_id |
Um identificador exclusivo para esta solicitação. Restrito a 36 caracteres ASCII. Recomendamos um UUID aleatório. Essa solicitação só será idempotente se |
VpnConnection
Uma conexão VPN .
| Campos | |
|---|---|
name |
Obrigatório. O nome do recurso da conexão VPN |
create_time |
Apenas saída. A hora em que a conexão VPN foi criada. |
update_time |
Apenas saída. A hora em que a conexão VPN foi atualizada pela última vez. |
labels |
Rótulos associados a este recurso. |
nat_gateway_ip |
IP do gateway NAT ou endereço IP WAN. Se um cliente tiver vários IPs NAT, ele precisará configurar o NAT para que apenas um IP externo seja mapeado para o cluster do Anthos do GMEC. Fica vazio se o NAT não for usado. |
bgp_routing_mode |
Modo de roteamento dinâmico da rede VPC, |
cluster |
O nome canônico do cluster a ser conectado. Ele está no formato projects/{project}/locations/{location}/clusters/{cluster}. |
vpc |
O ID da rede VPC a ser conectada. |
vpc_project |
Opcional. Detalhes do projeto da rede VPC. Obrigatório se a VPC estiver em um projeto diferente do projeto do cluster. |
enable_high_availability |
Indica se essa conexão VPN tem alta disponibilidade ativada no lado do cluster. Se ativada, ao criar uma conexão VPN, tentaremos usar dois IPs flutuantes do ANG. |
details |
Apenas saída. Os detalhes da conexão criada. |
BgpRoutingMode
Modo de roteamento.
| Tipos enumerados | |
|---|---|
BGP_ROUTING_MODE_UNSPECIFIED |
Desconhecido. |
REGIONAL |
Modo regional. |
GLOBAL |
Modo global. |
Detalhes
Os detalhes da conexão criada.
| Campos | |
|---|---|
state |
O estado desta conexão. |
error |
A mensagem de erro. Isso só é preenchido quando state=ERROR. |
cloud_router |
As informações do Cloud Router. |
cloud_vpns[] |
Cada conexão tem vários gateways do Cloud VPN. |
CloudRouter
As informações do Cloud Router.
| Campos | |
|---|---|
name |
O nome do Cloud Router associado. |
CloudVpn
As informações do Cloud VPN.
| Campos | |
|---|---|
gateway |
O nome do gateway do Cloud VPN criado. |
Estado
O estado atual da conexão.
| Tipos enumerados | |
|---|---|
STATE_UNSPECIFIED |
Desconhecido. |
STATE_CONNECTED |
Conectado. |
STATE_CONNECTING |
Ainda conectando. |
STATE_ERROR |
Ocorreu um erro. |
VpcProject
Detalhes do projeto da rede VPC.
| Campos | |
|---|---|
project_id |
O projeto da VPC a ser conectada. Se não for especificado, será o mesmo que o projeto do cluster. |
service_account |
Opcional. A conta de serviço no projeto da VPC configurada pelo usuário. Ele é usado para criar/excluir Cloud Router e VPNs de alta disponibilidade do Cloud para conexão VPN. Se essa SA for alterada durante ou depois da criação de uma conexão VPN, remova os recursos do Cloud Router e do Cloud VPN em |project_id|. Ela está no formato service-{project_number}@gcp-sa-edgecontainer.iam.gserviceaccount.com. |
ZoneMetadata
Uma zona do Google Distributed Cloud Edge onde as máquinas de borda estão localizadas.
| Campos | |
|---|---|
quota[] |
Cota para recursos nessa zona. |