כדי לנהל ביעילות את צי הסוכנים שלכם, אתם צריכים לוודא שרשת נקודות הקצה שלכם מדויקת. במסמך הזה מוסבר איך לגלות נקודות קצה זמינות, לעדכן את פרטי החיבור שלהן או להסיר אותן כשכבר לא משתמשים בהן.
לפני שמתחילים
כדי לנהל נקודות קצה, צריך לרשום נקודות קצה במרשם הסוכנים. כדי לבצע את המשימות האלה, צריך גם מזהה פרויקט.
כדי להשתמש בפקודות של gcloud CLI שמופיעות במסמך הזה, צריך לוודא שהגדרתם את סביבת gcloud CLI.
התפקידים הנדרשים
כדי לקבל את ההרשאות שדרושות לניהול נקודות קצה במאגר סוכנים, צריך לבקש מהאדמין להקצות לכם את תפקידי ה-IAM הבאים בפרויקט:
-
גילוי נקודות קצה:
Agent Registry API Viewer (
roles/agentregistry.viewer) -
עדכון ומחיקה של נקודות קצה:
Agent Registry API Editor (
roles/agentregistry.editor)
להסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.
יכול להיות שאפשר לקבל את ההרשאות הנדרשות גם באמצעות תפקידים בהתאמה אישית או תפקידים מוגדרים מראש.
גילוי נקודות קצה
כדי לעיין בכתובות ה-URL של היעד ובממשקי ה-API של REST שרשומים בסביבה שלכם, מציגים את רשימת משאבי נקודות הקצה הזמינים.
הצגת רשימה של כל נקודות הקצה
כדי להציג רשימה של כל נקודות הקצה הרשומות בסביבה שלכם:
המסוף
במסוף Google Cloud , עוברים אל Agent Registry:
בבורר הפרויקטים, בוחרים את הפרויקט שבו הגדרתם את Agent Registry. Google Cloud
לוחצים על הכרטיסייה נקודות קצה.
בדף מוצגת רשימה של כל נקודות הקצה הרשומות והפרטים שלהן, כמו שם, תיאור ומיקום.
כדי לראות את פרטי החיבור המלאים של נקודת קצה, לוחצים על השם של נקודת הקצה.
gcloud
כדי לראות את רשימת כל נקודות הקצה במיקום מסוים, משתמשים בפקודה endpoints list:
gcloud agent-registry endpoints list \
--project=PROJECT_ID \
--location=REGION
מחליפים את מה שכתוב בשדות הבאים:
-
PROJECT_ID: מזהה הפרויקט. -
REGION: האזור של המאגר.
סינון נקודות קצה רשומות
אם יש לכם כמה נקודות קצה, אתם יכולים לסנן את הרשימה לפי המטא-נתונים של נקודת הקצה:
המסוף
במסוף Google Cloud , עוברים אל Agent Registry:
בבורר הפרויקטים, בוחרים את הפרויקט שבו הגדרתם את 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
כדי לאחזר נקודת קצה רשומה ספציפית על ידי סינון לפי המטא-נתונים שלה, מגדירים את מקור הנתונים google_agent_registry_endpoint עם הארגומנט filter:
data "google_agent_registry_endpoint" "filtered_endpoint" {
location = "REGION"
filter = "displayName=\"DISPLAY_NAME\""
}
מחליפים את מה שכתוב בשדות הבאים:
-
REGION: האזור של המאגר. -
DISPLAY_NAME: השם הקריא לאנשים של נקודת הקצה שרוצים לסנן לפיה, לדוגמה,Example API Endpoint.
צפייה בפרטים מנקודת קצה
הצגת פרטים מנקודת קצה ספציפית, כולל פרטי החיבור והקישורים לפרוטוקול:
המסוף
במסוף Google Cloud , עוברים אל Agent Registry:
בבורר הפרויקטים, בוחרים את הפרויקט שבו הגדרתם את Agent Registry. Google Cloud
לוחצים על הכרטיסייה נקודות קצה.
בדף מוצגת רשימה של כל נקודות הקצה הרשומות והפרטים שלהן, כמו שם, תיאור ומיקום.
לוחצים על שם נקודת הקצה שרוצים להציג.
בדף סקירה כללית מוצגים השם, התיאור, המיקום ופרטי החיבור של נקודת הקצה, כולל כתובת היעד וקישורי הפרוטוקול.
gcloud
אחזור מטא-נתונים מפורטים על נקודת קצה ספציפית, כולל כתובת ה-URL המלאה של הממשק והקישור לפרוטוקול:
gcloud agent-registry endpoints describe ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION
מחליפים את מה שכתוב בשדות הבאים:
-
PROJECT_ID: מזהה הפרויקט. -
REGION: האזור של המאגר. -
ENDPOINT_NAME: השם של נקודת הקצה, לדוגמה,my-external-api.
Terraform
כדי לאחזר פרטים על נקודת קצה רשומה ספציפית באמצעות המזהה שלה, מגדירים את מקור הנתונים 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: המזהה הייחודי של נקודת הקצה, לדוגמה,my-external-api.
עדכון נקודת קצה
אם כתובת ה-URL הבסיסית של נקודת קצה חיצונית לטירגוט משתנה, אפשר לעדכן את פרטי ממשק נקודת הקצה.
כדי לעדכן נקודת קצה:
המסוף
במסוף Google Cloud , עוברים אל Agent Registry:
בבורר הפרויקטים, בוחרים את הפרויקט שבו הגדרתם את Agent Registry. Google Cloud
לוחצים על הכרטיסייה נקודות קצה.
בדף מוצגת רשימה של כל נקודות הקצה הרשומות והפרטים שלהן, כמו שם, תיאור ומיקום.
לוחצים על השם של נקודת הקצה שרוצים לעדכן.
בדף סקירה כללית מוצגים השם, התיאור, המיקום ופרטי החיבור של נקודת הקצה, כולל כתובת היעד וקישורי הפרוטוקול.
לוחצים על עריכה.
בחלונית Edit service (עריכת שירות), מזינים את המידע המעודכן של נקודת הקצה, כמו השם לתצוגה, התיאור וכתובת היעד. אפשר לבדוק את החיבור לנקודת הקצה מהחלונית הזו.
לוחצים על Save.
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: מזהה הפרויקט. -
REGION: האזור של המאגר. -
ENDPOINT_URL: כתובת ה-URL החדשה של היעד, לדוגמה,https://new-api.example.com/v1/data. -
PROTOCOL: קישור הפרוטוקול לממשק. הערכים התקינים הםHTTP_JSON,GRPCאוJSONRPC.
Terraform
כדי לעדכן כתובת URL של נקודת קצה או קישור פרוטוקול באמצעות Terraform, משנים את הבלוק interfaces של משאב google_agent_registry_service הקיים בהגדרות, ואז מריצים את הפקודה 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: כתובת ה-URL החדשה של היעד, לדוגמה,https://new-api.example.com/v1/data. -
PROTOCOL: קישור הפרוטוקול לממשק. הערכים התקינים הםHTTP_JSON,GRPCאוJSONRPC.
הסרת נקודת קצה
כדי להסיר נקודת קצה מהמאגר, צריך למחוק את משאב Service הבסיסי שלה. הפעולה הזו מסירה באופן מיידי את נקודת הקצה מתוצאות החיפוש של הגילוי.
כדי להסיר נקודת קצה מהמאגר:
המסוף
במסוף Google Cloud , עוברים אל Agent Registry:
בבורר הפרויקטים, בוחרים את הפרויקט שבו הגדרתם את Agent Registry. Google Cloud
לוחצים על הכרטיסייה נקודות קצה.
בדף מוצגת רשימה של כל נקודות הקצה הרשומות והפרטים שלהן, כמו שם, תיאור ומיקום.
לוחצים על שם נקודת הקצה שרוצים להסיר.
בדף סקירה כללית מוצגים השם, התיאור, המיקום ופרטי החיבור של נקודת הקצה, כולל כתובת היעד וקישורי הפרוטוקול.
לוחצים על מחיקה.
בחלון מחיקת נקודת קצה, מזינים DELETE כדי לאשר את הפעולה.
לוחצים על Delete.
gcloud
gcloud agent-registry services delete ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION
Terraform
מסירים את המשאב google_agent_registry_service שמייצג את נקודת הקצה מההגדרות של Terraform, ואז מריצים את הפקודה terraform apply.