Mendaftarkan endpoint

Dengan Agent Registry, Anda dapat mendaftarkan URL target secara manual, seperti REST API eksternal, sebagai endpoint terkelola sehingga Anda dapat mengatur secara terpusat tujuan yang dapat dihubungkan oleh fleet agen Anda.

Pendaftaran endpoint tidak didukung di lokasi multi-region us dan eu; Anda harus menggunakan wilayah yang didukung atau lokasi global. Untuk mengetahui informasi selengkapnya, lihat Lokasi Agent Registry.

Sebelum memulai

  1. Menyiapkan Agent Registry.

  2. Dapatkan project ID untuk project tata kelola tempat Agent Registry diaktifkan.

  3. Untuk menggunakan perintah Google Cloud CLI dalam dokumen ini, siapkan lingkungan gcloud CLI Anda.

Peran yang diperlukan

Untuk mendapatkan izin yang diperlukan untuk mendaftarkan endpoint di Agent Registry, minta administrator untuk memberi Anda peran IAM Agent Registry API Editor (roles/agentregistry.editor) di project tata kelola tempat Agent Registry diaktifkan. 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.

Mendaftarkan endpoint

Karena endpoint adalah tujuan eksternal kustom, gunakan pendaftaran manual untuk menambahkannya ke Agent Registry:

Konsol

  1. Di konsol Google Cloud , buka Agent Registry:

    Buka Agent Registry

  2. Dari pemilih project, pilih project Google Cloud tempat Anda menyiapkan Agent Registry.

  3. Pilih tab Endpoints.

  4. Klik Add endpoint.

  5. Di panel Endpoint details, masukkan nama tampilan, deskripsi, wilayah geografis, dan URL tujuan.

    Jika ingin, klik Test connection di panel ini untuk menguji koneksi Anda ke URL tujuan.

  6. Klik Simpan.

gcloud

Flag spesifikasi yang Anda gunakan menentukan koleksi resource tempat komponen Anda berada. Untuk pemetaan lengkap flag ke koleksi resource, lihat [Resource layanan dan resource penemuan](/agent-registry/data-model#service-resources).

Untuk menambahkan endpoint ke Agent Registry, buat resource Service dengan perintah gcloud agent-registry services create dan flag --endpoint-spec-type yang ditetapkan ke no-spec:

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

Ganti kode berikut:

  • ENDPOINT_NAME: nama yang ingin Anda berikan ke endpoint, misalnya, my-external-api. Nama harus terdiri dari 4 hingga 63 karakter dan hanya boleh berisi huruf kecil, angka, dan tanda hubung.
  • PROJECT_ID: project ID.
  • REGION: region registry.
  • DISPLAY_NAME: nama endpoint yang dapat dibaca manusia, misalnya, My External API.
  • ENDPOINT_URL: URL target, misalnya, https://api.example.com/v1/data.
  • PROTOCOL: binding protokol untuk antarmuka. Nilai yang valid adalah http-json, grpc, atau jsonrpc.

Setelah resource Service dibuat, Agent Registry akan otomatis membuat resource Endpoint hanya baca yang dapat ditemukan dan digunakan oleh agen dan orchestrator.

Terraform

Blok spesifikasi yang Anda konfigurasi menentukan koleksi resource tempat komponen Anda berada. Untuk pemetaan lengkap spesifikasi ke koleksi resource, lihat [Resource layanan dan resource penemuan](/agent-registry/data-model#service-resources).

Untuk mendaftarkan endpoint eksternal, konfigurasikan resource google_agent_registry_service dengan blok endpoint_spec:

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
}

Ganti kode berikut:

  • REGION: region registry.
  • ENDPOINT_NAME: nama unik yang ingin Anda berikan ke endpoint, misalnya, my-external-api. Nama harus terdiri dari 4 hingga 63 karakter dan hanya boleh berisi huruf kecil, angka, dan tanda hubung.
  • DISPLAY_NAME: nama endpoint yang dapat dibaca manusia, misalnya, My External API.
  • ENDPOINT_URL: URL target, misalnya, https://api.example.com/v1/data.
  • PROTOCOL: binding protokol untuk antarmuka. Nilai yang valid adalah HTTP_JSON, GRPC, atau JSONRPC.

Mendaftarkan endpoint Google API gabungan

Dalam arsitektur lintas project, project tata kelola pusat menghosting infrastruktur bersama seperti Agent Registry dan Agent Gateway, dan project Google Cloud terpisah menghosting instance komputasi agen.

Saat Anda merutekan traffic agen melalui Agent Gateway dalam mode egress, traffic jaringan keluar akan diblokir secara default. Agar agen di project Google Cloud terpisah dapat berkomunikasi dengan API Google Cloud penting, Anda dapat mengelompokkan beberapa antarmuka API ke dalam satu resource Service gabungan di project tata kelola pusat.

Mengelompokkan antarmuka ke dalam satu endpoint akan menyederhanakan administrasi kebijakan dengan memungkinkan Anda mengelola satu binding kebijakan Identity-Aware Proxy (IAP) untuk seluruh rangkaian Google API inti.

Ikuti langkah-langkah berikut untuk mendaftarkan endpoint Google API gabungan:

gcloud

Daftarkan endpoint dengan beberapa URL antarmuka di project tata kelola pusat menggunakan perintah gcloud agent-registry services create:

gcloud agent-registry services create SERVICE_NAME \
    --project=CENTRAL_PROJECT_ID \
    --location=REGION \
    --display-name="DISPLAY_NAME" \
    --description="DESCRIPTION" \
    --endpoint-spec-type=no-spec \
    --interfaces=protocolBinding=jsonrpc,url=API_URL \
    --interfaces=protocolBinding=jsonrpc,url=ADDITIONAL_API_URL

Ganti kode berikut:

  • SERVICE_NAME: ID untuk layanan, misalnya, core-gapi-services. Nama harus terdiri dari 4 hingga 63 karakter dan hanya boleh berisi huruf kecil, angka, dan tanda hubung.
  • CENTRAL_PROJECT_ID: project ID dari project tata kelola pusat yang menghosting Agent Registry dan Agent Gateway.
  • REGION: region tempat gateway dan registry Anda berada.
  • DISPLAY_NAME: nama yang dapat dibaca manusia, misalnya, Core Google APIs.
  • DESCRIPTION: deskripsi singkat, misalnya, Essential Google APIs for agent operations.
  • API_URL: URL Google API utama, seperti https://telemetry.googleapis.com.
  • ADDITIONAL_API_URL: ulangi flag --interfaces untuk setiap URL atau varian Google API tambahan yang diperlukan oleh agen Anda, seperti https://cloudresourcemanager.googleapis.com, https://iamcredentials.googleapis.com, https://agentregistry.googleapis.com, atau varian regional dan mTLS seperti https://telemetry.mtls.googleapis.com.

Terraform

Untuk mendaftarkan endpoint Google API gabungan menggunakan Terraform, tentukan resource google_agent_registry_service dengan beberapa blok interfaces:

resource "google_agent_registry_service" "core_gapi_services" {
  project      = "CENTRAL_PROJECT_ID"
  location     = "REGION"
  service_id   = "SERVICE_NAME"
  display_name = "DISPLAY_NAME"
  description  = "DESCRIPTION"

  endpoint_spec {
    type = "NO_SPEC"
  }

  interfaces {
    url              = "API_URL"
    protocol_binding = "JSONRPC"
  }

  # Add an interfaces block for each additional Google API URL
  interfaces {
    url              = "ADDITIONAL_API_URL"
    protocol_binding = "JSONRPC"
  }
}

Ganti kode berikut:

  • CENTRAL_PROJECT_ID: project ID dari project tata kelola pusat.
  • REGION: region registry.
  • SERVICE_NAME: ID layanan, misalnya, core-gapi-services. Nama harus terdiri dari 4 hingga 63 karakter dan hanya boleh berisi huruf kecil, angka, dan tanda hubung.
  • DISPLAY_NAME: nama yang dapat dibaca manusia, misalnya, Core Google APIs.
  • DESCRIPTION: deskripsi endpoint.
  • API_URL: URL Google API utama, seperti https://telemetry.googleapis.com.
  • ADDITIONAL_API_URL: ulangi blok interfaces untuk setiap URL atau varian Google API tambahan yang diperlukan oleh agen Anda, seperti https://cloudresourcemanager.googleapis.com, https://iamcredentials.googleapis.com, https://agentregistry.googleapis.com, atau varian regional dan mTLS seperti https://telemetry.mtls.googleapis.com.

Langkah berikutnya