Registrar endpoints

No Agent Registry, um endpoint representa um URL de destino, normalmente uma API REST, que seus agentes acessam. Ao registrar esses destinos como componentes de agente gerenciados no Agent Registry, você pode governar centralmente a quais endpoints externos sua frota de agentes pode se conectar.

Este documento explica como registrar explicitamente endpoints externos no registro.

Antes de começar

Antes de começar, configure o Agent Registry. Você precisa do ID do projeto para realizar essas tarefas.

Para usar os comandos da Google Cloud CLI neste documento, verifique se você configurou o ambiente da CLI gcloud.

Funções exigidas

Para receber as permissões necessárias para registrar endpoints no Agent Registry, peça ao administrador para conceder a você o papel do IAM de Editor da API do Agent Registry (roles/agentregistry.editor) no projeto. 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 com papéis personalizados ou outros papéis predefinidos.

Registrar um endpoint

Como os endpoints são destinos externos personalizados, use o registro manual para adicioná-los ao Agent Registry:

Console

  1. No Google Cloud console, acesse o Agent Registry:

    Acessar o Agent Registry

  2. No seletor de projetos, selecione o Google Cloud projeto em que você configurou o Agent Registry.

  3. Selecione a guia Endpoints.

  4. Clique em Adicionar endpoint.

  5. No painel Detalhes do endpoint , insira o nome de exibição, uma descrição, a região geográfica e o URL de destino.

    Opcionalmente, clique em Testar conexão neste painel para testar sua conexão com o URL de destino.

  6. Clique em Salvar.

gcloud

Você cria um recurso Service com um endpoint-spec-type de no-spec.

Registre o endpoint e defina os detalhes da conexão de interface:

gcloud agent-registry services create ENDPOINT_NAME \
  --project=PROJECT_ID \
  --location=REGION \
  --display-name="DISPLAY_NAME" \
  --endpoint-spec-type=no-spec \
  --interfaces=url=ENDPOINT_URL,protocolBinding=PROTOCOL

Substitua:

  • ENDPOINT_NAME: o nome que você quer dar ao endpoint, por exemplo, my-external-api.
  • PROJECT_ID: o ID do projeto.
  • REGION: a região do registro.
  • DISPLAY_NAME: o nome legível do endpoint.
  • ENDPOINT_URL: o URL de destino, por exemplo, https://api.example.com/v1/data.
  • PROTOCOL: a vinculação de protocolo para a interface. Os valores válidos são HTTP_JSON, GRPC ou JSONRPC.

Depois que o recurso Service é criado, o Agent Registry gera automaticamente um recurso Endpoint somente leitura no lado do consumidor que agentes e orquestradores podem descobrir e usar.

Terraform

Para registrar um endpoint externo, configure o recurso google_agent_registry_service com o bloco endpoint_spec:

resource "google_agent_registry_service" "endpoint" {
  location     = "REGION"
  service_id   = "ENDPOINT_NAME"
  display_name = "DISPLAY_NAME"
  description  = "An external REST API registered using Terraform."

  interfaces {
    url              = "ENDPOINT_URL"
    protocol_binding = "PROTOCOL"
  }

  endpoint_spec {
    type = "NO_SPEC"
  }
}

output "endpoint_resource_name" {
  description = "The generated read-only Endpoint resource name."
  value       = google_agent_registry_service.endpoint.registry_resource
}

Substitua:

  • REGION: a região do registro.
  • ENDPOINT_NAME: o nome exclusivo que você quer dar ao endpoint, por exemplo, my-external-api.
  • DISPLAY_NAME: o nome legível do endpoint.
  • ENDPOINT_URL: o URL de destino, por exemplo, https://api.example.com/v1/data.
  • PROTOCOL: a vinculação de protocolo para a interface. Os valores válidos são HTTP_JSON, GRPC ou JSONRPC.