Pengelolaan fleet agen Anda secara efektif memerlukan akurasi jaringan endpoint. Dokumen ini menjelaskan cara menemukan endpoint yang tersedia, memperbarui detail koneksinya, atau menghapusnya jika tidak lagi digunakan.
Sebelum memulai
Sebelum dapat mengelola endpoint, daftarkan endpoint di Agent Registry. Anda juga memerlukan project ID Anda untuk melakukan tugas ini.
Untuk menggunakan perintah gcloud CLI dalam dokumen ini, pastikan Anda telah menyiapkan lingkungan Google Cloud CLI.
Peran yang diperlukan
Untuk mendapatkan izin yang Anda perlukan untuk mengelola endpoint di Agent Registry, minta administrator Anda untuk memberi Anda peran IAM berikut di project:
-
Menemukan endpoint:
Penampil Agent Registry API (
roles/agentregistry.viewer) -
Memperbarui dan menghapus endpoint:
Editor Agent Registry API (
roles/agentregistry.editor)
Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.
Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.
Menemukan endpoint
Untuk menjelajahi URL target dan REST API yang terdaftar di lingkungan Anda, buat daftar resource endpoint yang tersedia.
Membuat daftar semua endpoint
Buat daftar semua endpoint terdaftar di lingkungan Anda:
Konsol
Di Google Cloud konsol, buka Agent Registry:
Dari pemilih project, pilih Google Cloud project tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint terdaftar dan detailnya, seperti nama, deskripsi, dan lokasi.
Untuk melihat detail koneksi lengkap endpoint, klik nama endpoint.
gcloud
Untuk membuat daftar semua endpoint di lokasi tertentu, gunakan perintah endpoints list:
gcloud agent-registry endpoints list \
--project=PROJECT_ID \
--location=REGION
Ganti kode berikut:
PROJECT_ID: Project ID.REGION: Region registry.
Memfilter endpoint terdaftar
Jika memiliki beberapa endpoint, Anda dapat memfilter daftar berdasarkan metadata endpoint:
Konsol
Di Google Cloud konsol, buka Agent Registry:
Dari pemilih project, pilih Google Cloud project tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint terdaftar dan detailnya, seperti nama, deskripsi, dan lokasi.
Untuk memfilter menurut lokasi, klik menu Location, pilih lokasi yang ingin Anda filter, lalu klik Apply.
Halaman ini menampilkan daftar endpoint terdaftar yang difilter untuk kondisi yang Anda pilih.
gcloud
Filter daftar Anda agar hanya menampilkan resource yang cocok dengan metadata tertentu, menggunakan flag --filter:
gcloud agent-registry endpoints list \
--project=PROJECT_ID \
--location=REGION \
--filter="FILTER_EXPRESSION"
Ganti FILTER_EXPRESSION dengan ekspresi filter untuk endpoint yang ingin Anda filter. Misalnya, untuk memfilter menurut nama tampilan, gunakan displayName='DISPLAY_NAME'.
Terraform
Untuk mengambil endpoint terdaftar tertentu dengan memfilter metadata-nya, konfigurasi sumber data google_agent_registry_endpoint dengan argumen filter:
data "google_agent_registry_endpoint" "filtered_endpoint" {
location = "REGION"
filter = "displayName=\"DISPLAY_NAME\""
}
Ganti kode berikut:
REGION: Region registry.DISPLAY_NAME: Nama endpoint yang dapat dibaca manusia untuk difilter, misalnya,Example API Endpoint.
Melihat detail dari endpoint
Lihat detail dari endpoint tertentu, termasuk detail koneksi dan binding protokolnya:
Konsol
Di Google Cloud konsol, buka Agent Registry:
Dari pemilih project, pilih Google Cloud project tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint terdaftar dan detailnya, seperti nama, deskripsi, dan lokasi.
Klik nama endpoint yang ingin Anda lihat.
Halaman Overview menampilkan nama, deskripsi, lokasi, dan detail koneksi endpoint, termasuk URL tujuan dan binding protokol.
gcloud
Ambil metadata mendetail tentang endpoint tertentu, termasuk URL antarmuka lengkap dan binding protokolnya:
gcloud agent-registry endpoints describe ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION
Ganti kode berikut:
PROJECT_ID: Project ID.REGION: Region registry.ENDPOINT_NAME: Nama endpoint Anda, misalnya,my-external-api.
Terraform
Untuk mengambil detail tentang endpoint terdaftar tertentu menggunakan ID-nya, konfigurasi sumber data 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
}
Ganti kode berikut:
REGION: Region registry.ENDPOINT_NAME: ID unik endpoint Anda, misalnya,my-external-api.
Memperbarui endpoint
Jika URL dasar endpoint target eksternal berubah, Anda dapat memperbarui detail antarmuka endpoint.
Ikuti langkah-langkah berikut untuk memperbarui endpoint:
Konsol
Di Google Cloud konsol, buka Agent Registry:
Dari pemilih project, pilih Google Cloud project tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint terdaftar dan detailnya, seperti nama, deskripsi, dan lokasi.
Klik nama endpoint yang ingin Anda perbarui.
Halaman Overview menampilkan nama, deskripsi, lokasi, dan detail koneksi endpoint, termasuk URL tujuan dan binding protokol.
Klik Edit.
Di panel Edit service, masukkan informasi yang diperbarui untuk endpoint, seperti nama tampilan, deskripsi, dan URL tujuan. Anda dapat menguji koneksi ke endpoint dari panel ini.
Klik Save.
gcloud
Untuk Agent Registry API, resource Endpoint digunakan untuk penemuan. Oleh karena itu, Anda harus memperbarui resource Service terdaftar secara langsung.
Gunakan flag --interfaces untuk menentukan URL target baru:
gcloud agent-registry services update ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION \
--interfaces=url=ENDPOINT_URL,protocolBinding=PROTOCOL
Ganti kode berikut:
ENDPOINT_NAME: Nama endpoint Anda, misalnya,my-external-api.PROJECT_ID: Project ID.REGION: Region registry.ENDPOINT_URL: URL target baru, misalnya,https://new-api.example.com/v1/data.PROTOCOL: Binding protokol untuk antarmuka. Nilai yang valid adalahHTTP_JSON,GRPC, atauJSONRPC.
Terraform
Untuk memperbarui URL endpoint atau binding protokol menggunakan Terraform, ubah blok interfaces dari resource google_agent_registry_service yang ada dalam konfigurasi Anda, lalu jalankan 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"
}
}
Ganti kode berikut:
REGION: Region registry.ENDPOINT_NAME: Nama endpoint Anda.DISPLAY_NAME: Nama endpoint yang dapat dibaca manusia.ENDPOINT_URL: URL target baru, misalnya,https://new-api.example.com/v1/data.PROTOCOL: Binding protokol untuk antarmuka. Nilai yang valid adalahHTTP_JSON,GRPC, atauJSONRPC.
Menghapus endpoint
Untuk menghapus endpoint dari registry, Anda harus menghapus resource Service dasarnya. Tindakan ini akan segera menghapus endpoint dari hasil penelusuran penemuan.
Ikuti langkah-langkah berikut untuk menghapus endpoint dari registry Anda:
Konsol
Di Google Cloud konsol, buka Agent Registry:
Dari pemilih project, pilih Google Cloud project tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint terdaftar dan detailnya, seperti nama, deskripsi, dan lokasi.
Klik nama endpoint yang ingin Anda hapus.
Halaman Overview menampilkan nama, deskripsi, lokasi, dan detail koneksi endpoint, termasuk URL tujuan dan binding protokol.
Klik Delete.
Di jendela Delete endpoint, masukkan DELETE untuk mengonfirmasi tindakan.
Klik Delete.
gcloud
gcloud agent-registry services delete ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION
Terraform
Hapus resource google_agent_registry_service yang mewakili endpoint dari konfigurasi Terraform Anda, lalu jalankan terraform apply.