Agent Registry memungkinkan Anda menemukan, memperbarui, dan menghapus endpoint terdaftar sehingga agen Anda merutekan traffic ke URL target yang valid. Anda dapat memeriksa endpoint yang tersedia di seluruh project, memperbarui detail koneksinya seiring perubahan infrastruktur, dan menghapus endpoint yang tidak lagi digunakan.
Sebelum memulai
- Menyiapkan Agent Registry.
Untuk penyiapan project tunggal, dapatkan project ID dari project tata kelola tempat Agent Registry diaktifkan. Jika Anda mengonfigurasi batas pengelolaan untuk beberapa project, gunakan ID project pengelolaan Anda untuk penemuan dan pendaftaran di seluruh batas, atau tentukan ID project anggota untuk operasi project tunggal.
Daftarkan endpoint di Agent Registry.
Untuk menggunakan perintah Google Cloud CLI dalam dokumen ini, siapkan lingkungan gcloud CLI Anda.
Peran yang diperlukan
Untuk mendapatkan izin yang Anda perlukan untuk mengelola endpoint di Agent Registry, minta administrator untuk memberi Anda peran IAM berikut pada project tata kelola tempat Agent Registry diaktifkan:
-
Menemukan endpoint:
Agent Registry API Viewer (
roles/agentregistry.viewer) -
Mengupdate dan menghapus endpoint:
Agent Registry API Editor (
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, cantumkan
resource Endpoint yang tersedia.
Mencantumkan semua endpoint
Cantumkan semua endpoint terdaftar di lingkungan Anda:
Konsol
Di konsol Google Cloud , buka Agent Registry:
Dari pemilih project, pilih project Google Cloud tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint yang terdaftar dan detailnya, seperti nama, deskripsi, dan lokasi.
Untuk melihat detail koneksi lengkap endpoint, klik nama endpoint.
gcloud
Untuk mencantumkan semua endpoint di lokasi tertentu, jalankan perintah
gcloud agent-registry 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 konsol Google Cloud , buka Agent Registry:
Dari pemilih project, pilih project Google Cloud tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint yang terdaftar dan detailnya, seperti nama, deskripsi, dan lokasi.
Untuk memfilter menurut lokasi, klik menu Lokasi, pilih lokasi yang ingin Anda filter, lalu klik Terapkan.
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 dengan
meneruskan flag --filter ke
perintah
gcloud agent-registry endpoints list:
gcloud agent-registry endpoints list \
--project=PROJECT_ID \
--location=REGION \
--filter="FILTER_EXPRESSION"
Ganti kode berikut:
PROJECT_ID: project ID.REGION: region registry.FILTER_EXPRESSION: ekspresi filter untuk endpoint yang ingin Anda filter. Misalnya, untuk memfilter menurut nama tampilan, gunakandisplayName='DISPLAY_NAME'. Untuk memfilter menurut ID endpoint unik global (URN), gunakanendpointId='urn:endpoint:ENDPOINT_URN'.
Terraform
Untuk mengambil endpoint terdaftar tertentu dengan memfilter metadatanya, konfigurasikan 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 konsol Google Cloud , buka Agent Registry:
Dari pemilih project, pilih project Google Cloud tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint yang 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, dengan menjalankan perintah gcloud agent-registry endpoints describe:
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,
konfigurasikan 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.
Di Registry Agen, resource Endpoint adalah resource penemuan hanya baca.
Oleh karena itu, untuk mengupdate endpoint terdaftar, Anda harus mengupdate resource Service yang dapat ditulis secara langsung.
Ikuti langkah-langkah berikut untuk memperbarui endpoint:
Konsol
Di konsol Google Cloud , buka Agent Registry:
Dari pemilih project, pilih project Google Cloud tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint yang 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 Simpan.
gcloud
Jalankan perintah
gcloud agent-registry services update
dengan 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 tempat resourceServicedibuat.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-nya. Tindakan ini akan segera menghapus endpoint dari hasil penelusuran penemuan.
Ikuti langkah-langkah berikut untuk menghapus endpoint dari registry Anda:
Konsol
Di konsol Google Cloud , buka Agent Registry:
Dari pemilih project, pilih project Google Cloud tempat Anda menyiapkan Agent Registry.
Pilih tab Endpoints.
Halaman ini menampilkan daftar semua endpoint yang 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
DELETEuntuk mengonfirmasi tindakan.Klik Hapus.
gcloud
Jalankan perintah gcloud agent-registry services delete:
gcloud agent-registry services delete ENDPOINT_NAME \
--project=PROJECT_ID \
--location=REGION
Ganti kode berikut:
ENDPOINT_NAME: nama endpoint yang ingin Anda hapus, misalnya,my-external-api.PROJECT_ID: project ID tempat resourceServicedibuat.REGION: region registry.
Terraform
Hapus resource google_agent_registry_service yang mewakili endpoint
dari konfigurasi Terraform Anda, lalu jalankan terraform apply.