如要有效管理代理程式機群,必須確保端點網路的準確性。本文詳細說明如何探索可用端點、更新連線詳細資料,或移除不再使用的端點。
事前準備
管理端點前,請先在 Agent Registry 註冊端點。您也需要專案 ID 才能執行這些工作。
如要使用本文中的 gcloud CLI 指令,請務必設定 Google Cloud CLI 環境。
必要的角色
如要取得管理 Agent Registry 端點所需的權限,請要求管理員在專案中授予您下列 IAM 角色:
-
探索端點:
Agent Registry API 檢視者 (
roles/agentregistry.viewer) -
更新及刪除端點:
Agent Registry API 編輯者 (
roles/agentregistry.editor)
如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。
探索端點
如要瀏覽環境中註冊的目標網址和 REST API,請列出可用的端點資源。
列出所有端點
列出環境中所有已註冊的端點:
控制台
前往 Google Cloud 控制台的「Agent Registry」:
在專案選擇工具中,選取 Google Cloud 您設定代理程式登錄的專案。
選取「端點」分頁標籤。
這個頁面會顯示所有已註冊端點的清單和詳細資料,例如名稱、說明和位置。
如要查看端點的完整連線詳細資料,請按一下端點名稱。
gcloud
如要列出特定位置的所有端點,請使用 endpoints list 指令:
gcloud agent-registry endpoints list \
--project=PROJECT_ID \
--location=REGION
更改下列內容:
PROJECT_ID:專案 ID。REGION:登錄檔區域。
篩選已註冊的端點
如果您有多個端點,可以依端點的中繼資料篩選清單:
控制台
前往 Google Cloud 控制台的「Agent Registry」:
在專案選擇工具中,選取 Google Cloud 您設定代理程式登錄的專案。
選取「端點」分頁標籤。
這個頁面會顯示所有已註冊端點的清單和詳細資料,例如名稱、說明和位置。
如要依地點篩選,請按一下「地點」選單,選取要篩選的地點,然後按一下「套用」。
頁面會顯示已註冊端點的篩選清單,這些端點符合您選取的條件。
gcloud
使用 --filter 標記篩選清單,只傳回符合特定中繼資料的資源:
gcloud agent-registry endpoints list \
--project=PROJECT_ID \
--location=REGION \
--filter="FILTER_EXPRESSION"
將 FILTER_EXPRESSION 替換為要篩選端點的篩選運算式。舉例來說,如要依顯示名稱篩選,請使用 displayName='DISPLAY_NAME'。
Terraform
如要根據中繼資料篩選,進而擷取特定已註冊的端點,請使用 filter 引數設定 google_agent_registry_endpoint 資料來源:
data "google_agent_registry_endpoint" "filtered_endpoint" {
location = "REGION"
filter = "displayName=\"DISPLAY_NAME\""
}
更改下列內容:
REGION:登錄檔區域。DISPLAY_NAME:要篩選的端點名稱,例如Example API Endpoint。
查看端點的詳細資料
查看特定端點的詳細資料,包括連線詳細資料和通訊協定繫結:
控制台
前往 Google Cloud 控制台的「Agent Registry」:
在專案選擇工具中,選取 Google Cloud 您設定代理程式登錄的專案。
選取「端點」分頁標籤。
這個頁面會顯示所有已註冊端點的清單和詳細資料,例如名稱、說明和位置。
按一下要查看的端點名稱。
「總覽」頁面會顯示端點的名稱、說明、位置和連線詳細資料,包括目的地網址和通訊協定繫結。
gcloud
擷取特定端點的詳細中繼資料,包括完整介面網址和通訊協定繫結:
gcloud agent-registry endpoints describe ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION
更改下列內容:
PROJECT_ID:專案 ID。REGION:登錄檔區域。ENDPOINT_NAME:端點名稱,例如my-external-api。
Terraform
如要使用特定已註冊端點的 ID 擷取詳細資料,請設定 google_agent_registry_endpoint 資料來源:
data "google_agent_registry_endpoint" "my_endpoint" {
location = "REGION"
endpoint_id = "ENDPOINT_NAME"
}
output "endpoint_create_time" {
description = "The timestamp when the endpoint was registered."
value = data.google_agent_registry_endpoint.my_endpoint.create_time
}
output "endpoint_update_time" {
description = "The timestamp when the endpoint was last updated."
value = data.google_agent_registry_endpoint.my_endpoint.update_time
}
更改下列內容:
REGION:登錄檔區域。ENDPOINT_NAME:端點的專屬 ID,例如my-external-api。
更新端點
如果外部目標端點的基礎網址有所變更,您可以更新端點介面詳細資料。
如要更新端點,請按照下列步驟操作:
控制台
前往 Google Cloud 控制台的「Agent Registry」:
在專案選擇工具中,選取 Google Cloud 您設定代理程式登錄的專案。
選取「端點」分頁標籤。
這個頁面會顯示所有已註冊端點的清單和詳細資料,例如名稱、說明和位置。
按一下要更新的端點名稱。
「總覽」頁面會顯示端點的名稱、說明、位置和連線詳細資料,包括目的地網址和通訊協定繫結。
按一下「Edit」(編輯)。
在「編輯服務」面板中,輸入端點的更新資訊,例如顯示名稱、說明和到達網頁網址。您可以在這個面板中測試端點連線。
按一下 [儲存]。
gcloud
對於 Agent Registry API,Endpoint 資源用於探索。因此,您必須直接更新已註冊的 Service 資源。
使用 --interfaces 旗標指定新的目標網址:
gcloud agent-registry services update ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION \
--interfaces=url=ENDPOINT_URL,protocolBinding=PROTOCOL
更改下列內容:
ENDPOINT_NAME:端點名稱,例如my-external-api。PROJECT_ID:專案 ID。REGION:登錄檔區域。ENDPOINT_URL:新的目標網址,例如https://new-api.example.com/v1/data。PROTOCOL:介面的通訊協定繫結。有效值為HTTP_JSON、GRPC或JSONRPC。
Terraform
如要使用 Terraform 更新端點網址或通訊協定繫結,請修改設定中現有 google_agent_registry_service 資源的 interfaces 區塊,然後執行 terraform apply:
resource "google_agent_registry_service" "endpoint" {
location = "REGION"
service_id = "ENDPOINT_NAME"
display_name = "DISPLAY_NAME"
interfaces {
url = "ENDPOINT_URL"
protocol_binding = "PROTOCOL"
}
endpoint_spec {
type = "NO_SPEC"
}
}
更改下列內容:
REGION:登錄檔區域。ENDPOINT_NAME:端點名稱。DISPLAY_NAME:端點的易讀名稱。ENDPOINT_URL:新的目標網址,例如https://new-api.example.com/v1/data。PROTOCOL:介面的通訊協定繫結。有效值為HTTP_JSON、GRPC或JSONRPC。
移除端點
如要從登錄檔中移除端點,必須刪除其基礎 Service 資源。這項操作會立即從探索搜尋結果中移除端點。
如要從登錄檔中移除端點,請按照下列步驟操作:
控制台
前往 Google Cloud 控制台的「Agent Registry」:
在專案選擇工具中,選取 Google Cloud 您設定代理程式登錄的專案。
選取「端點」分頁標籤。
這個頁面會顯示所有已註冊端點的清單和詳細資料,例如名稱、說明和位置。
按一下要移除的端點名稱。
「總覽」頁面會顯示端點的名稱、說明、位置和連線詳細資料,包括目的地網址和通訊協定繫結。
按一下「刪除」圖示 。
在「Delete endpoint」(刪除端點) 視窗中輸入 DELETE,確認要執行這項操作。
點選「刪除」。
gcloud
gcloud agent-registry services delete ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION
Terraform
從 Terraform 設定中移除代表端點的 google_agent_registry_service 資源,然後執行 terraform apply。