註冊端點

在代理程式登錄中,端點代表目標網址 (通常是 REST API),代理程式會存取該網址。在 Agent Registry 中將這些目的地註冊為受管理代理程式元件,即可集中控管代理程式群組可連線的外部端點。

本文說明如何在登錄檔中明確註冊外部端點。

事前準備

開始之前,請先設定代理程式登錄。您需要專案 ID 才能執行這些工作。

如要使用本文中的 Google Cloud CLI 指令,請務必設定 gcloud CLI 環境

必要的角色

如要取得在 Agent Registry 中註冊端點所需的權限,請要求管理員授予您專案的 Agent Registry API 編輯者 (roles/agentregistry.editor) IAM 角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

您或許也能透過自訂角色或其他預先定義的角色,取得必要權限。

註冊端點

由於端點是自訂的外部目的地,請使用手動註冊將端點新增至 Agent Registry:

控制台

  1. 前往 Google Cloud 控制台的「Agent Registry」

    前往 Agent Registry

  2. 在專案選擇工具中,選取 Google Cloud 您設定代理程式登錄的專案。

  3. 選取「端點」分頁標籤。

  4. 按一下「新增端點」

  5. 在「端點詳細資料」面板中,輸入顯示名稱、說明、地理區域和目的地網址。

    (選用) 按一下這個面板中的「測試連線」,測試與目標網址的連線。

  6. 按一下 [儲存]

gcloud

您可以使用 no-specendpoint-spec-type 建立 Service 資源。

註冊端點並定義介面連線詳細資料:

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

更改下列內容:

  • ENDPOINT_NAME:您要為端點指定的名稱,例如 my-external-api
  • PROJECT_ID:專案 ID。
  • REGION:登錄檔區域。
  • DISPLAY_NAME:端點的易讀名稱。
  • ENDPOINT_URL:目標網址,例如 https://api.example.com/v1/data
  • PROTOCOL:介面的通訊協定繫結。有效值為 HTTP_JSONGRPCJSONRPC

建立 Service 資源後,Agent Registry 會在消費者端自動產生唯讀的 Endpoint 資源,供代理程式和協調器探索及使用

Terraform

如要註冊外部端點,請使用 endpoint_spec 區塊設定 google_agent_registry_service 資源:

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
}

更改下列內容:

  • REGION:登錄檔區域。
  • ENDPOINT_NAME:您要為端點指定的專屬名稱,例如 my-external-api
  • DISPLAY_NAME:端點的易讀名稱。
  • ENDPOINT_URL:目標網址,例如 https://api.example.com/v1/data
  • PROTOCOL:介面的通訊協定繫結。有效值為 HTTP_JSONGRPCJSONRPC