O gerenciamento eficaz da frota de agentes exige que a rede de endpoints seja precisa. Este documento detalha como descobrir endpoints disponíveis, atualizar os detalhes de conexão ou remover endpoints que não estão mais em uso.
Antes de começar
Antes de gerenciar endpoints, registre-os no Agent Registry. Você também precisa do ID do projeto para realizar essas tarefas.
Para usar os comandos da CLI gcloud neste documento, configure o ambiente da Google Cloud CLI.
Funções exigidas
Para ter as permissões necessárias para gerenciar endpoints no Agent Registry, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:
-
Descobrir endpoints:
leitor da API Agent Registry (
roles/agentregistry.viewer) -
Atualizar e excluir endpoints:
editor da API Agent Registry (
roles/agentregistry.editor)
Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.
Também é possível conseguir as permissões necessárias usando personalizados papéis ou outros predefinidos papéis.
Descobrir endpoints
Para navegar pelos URLs de destino e APIs REST registrados no seu ambiente, liste os recursos de endpoint disponíveis.
Listar todos os endpoints
Liste todos os endpoints registrados no seu ambiente:
Console
No Google Cloud console, acesse o Agent Registry:
No seletor de projetos, selecione o Google Cloud projeto em que você configurou o Agent Registry.
Selecione a guia Endpoints.
A página mostra uma lista de todos os endpoints registrados e os detalhes deles, como nome, descrição e local.
Para conferir os detalhes completos da conexão de um endpoint, clique no nome dele.
gcloud
Para listar todos os endpoints em um local específico, use o comando endpoints list:
gcloud alpha agent-registry endpoints list \
--project=PROJECT_ID \
--location=REGION
Substitua:
PROJECT_ID: o ID do projeto.REGION: a região do registro.
Filtrar endpoints registrados
Se você tiver vários endpoints, poderá filtrar a lista pelos metadados do endpoint:
Console
No Google Cloud console, acesse o Agent Registry:
No seletor de projetos, selecione o Google Cloud projeto em que você configurou o Agent Registry.
Selecione a guia Endpoints.
A página mostra uma lista de todos os endpoints registrados e os detalhes deles, como nome, descrição e local.
Para filtrar por local, clique no menu Local , selecione os locais que você quer filtrar e clique em Aplicar.
A página mostra uma lista filtrada dos endpoints registrados para as condições selecionadas.
gcloud
Filtre a lista para retornar apenas recursos que correspondam a metadados específicos usando a flag --filter:
gcloud alpha agent-registry endpoints list \
--project=PROJECT_ID \
--location=REGION \
--filter="FILTER_EXPRESSION"
Substitua FILTER_EXPRESSION pela expressão de filtro dos endpoints que você quer filtrar. Por exemplo, para filtrar por nome de exibição, use displayName='DISPLAY_NAME'.
Conferir detalhes de um endpoint
Confira os detalhes de um endpoint específico, incluindo os detalhes de conexão e as vinculações de protocolo:
Console
No Google Cloud console, acesse o Agent Registry:
No seletor de projetos, selecione o Google Cloud projeto em que você configurou o Agent Registry.
Selecione a guia Endpoints.
A página mostra uma lista de todos os endpoints registrados e os detalhes deles, como nome, descrição e local.
Clique no nome do endpoint que você quer conferir.
A página Visão geral mostra o nome, a descrição, o local e os detalhes de conexão do endpoint, incluindo o URL de destino e as vinculações de protocolo.
gcloud
Recupere metadados detalhados sobre um endpoint específico, incluindo o URL completo da interface e a vinculação de protocolo:
gcloud alpha agent-registry endpoints describe ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION
Substitua:
PROJECT_ID: o ID do projeto.REGION: a região do registro.ENDPOINT_NAME: o nome do endpoint, por exemplo,my-external-api.
Atualizar um endpoint
Se o URL subjacente de um endpoint de destino externo mudar, você poderá atualizar os detalhes da interface do endpoint.
Siga estas etapas para atualizar um endpoint:
Console
No Google Cloud console, acesse o Agent Registry:
No seletor de projetos, selecione o Google Cloud projeto em que você configurou o Agent Registry.
Selecione a guia Endpoints.
A página mostra uma lista de todos os endpoints registrados e os detalhes deles, como nome, descrição e local.
Clique no nome do endpoint que você quer atualizar.
A página Visão geral mostra o nome, a descrição, o local e os detalhes de conexão do endpoint, incluindo o URL de destino e as vinculações de protocolo.
Clique em Editar.
No painel Editar serviço , insira as informações atualizadas do endpoint, como o nome de exibição, a descrição e o URL de destino. Você pode testar a conexão com o endpoint nesse painel.
Clique em Salvar.
gcloud
Para a API Agent Registry, os recursos Endpoint são usados para descoberta. Portanto, é necessário atualizar o recurso Service registrado diretamente.
Use a flag --interfaces para especificar o novo URL de destino:
gcloud alpha agent-registry services update ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION \
--interfaces=url=ENDPOINT_URL,protocolBinding=PROTOCOL
Substitua:
ENDPOINT_NAME: o nome do endpoint, por exemplo,my-external-api.PROJECT_ID: o ID do projeto.REGION: a região do registro.ENDPOINT_URL: o novo URL de destino, por exemplo,https://new-api.example.com/v1/data.PROTOCOL: a vinculação de protocolo para a interface. Os valores válidos sãoHTTP_JSON,GRPCouJSONRPC.
Remover um endpoint
Para remover um endpoint do registro, é necessário excluir o recurso Service subjacente. Essa ação remove imediatamente o endpoint dos resultados da pesquisa de descoberta.
Siga estas etapas para remover um endpoint do registro:
Console
No Google Cloud console, acesse o Agent Registry:
No seletor de projetos, selecione o Google Cloud projeto em que você configurou o Agent Registry.
Selecione a guia Endpoints.
A página mostra uma lista de todos os endpoints registrados e os detalhes deles, como nome, descrição e local.
Clique no nome do endpoint que você quer remover.
A página Visão geral mostra o nome, a descrição, o local e os detalhes de conexão do endpoint, incluindo o URL de destino e as vinculações de protocolo.
Clique em Excluir.
Na janela Excluir endpoint, insira DELETE para confirmar a ação.
Clique em Excluir.
gcloud
gcloud alpha agent-registry services delete ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION