全部产品
Search

搜索本产品

    API Gateway：Referensi kunci

    文档中心

    API Gateway：Referensi kunci

    更新时间：Dec 13, 2025

    Anda dapat menggunakan kunci untuk sumber daya seperti konsumen, layanan AI, layanan Agent, layanan MCP, dan Plugin. Kunci menggantikan kredensial teks biasa guna mencegah kebocoran kredensial. Topik ini menjelaskan cara mereferensikan kunci pada sumber daya tersebut.

    Prasyarat

    Kunci harus telah dibuat. Untuk informasi selengkapnya tentang pembuatan kunci, lihat Create a key.

    Penting

    Pemetaan referensi kunci didukung di AI Gateway 2.1.11 dan versi yang lebih baru.

    Referensi kunci dalam konsumen

    1. Buka AI Gateway console. Di panel navigasi sebelah kiri, pilih Consumers. Di bilah menu atas, pilih wilayah.

    2. Klik Create Consumer. Di panel Create Consumer, masukkan nama untuk konsumen tersebut. Atur Authentication Method ke API Key dan Generation Method ke Reference Key. Lalu, atur API-KEY ke kunci yang sudah ada.

      Catatan

      Referensi kunci untuk kredensial konsumen hanya didukung saat Anda menggunakan metode autentikasi kunci API.

    Referensi kunci dalam layanan AI

    1. Buka AI Gateway console. Di panel navigasi sebelah kiri, pilih Instance. Di bilah menu atas, pilih wilayah.

    2. Klik ID instans target. Di panel navigasi sebelah kiri, pilih Service, lalu klik Create Service.

    3. Di panel Create Service, atur Service Source ke AI Services. Di bagian Large Model Configuration, atur Generation Method ke Reference Key. Lalu, atur API-KEY ke kunci yang sudah ada.

    Referensi kunci dalam layanan Agent

    1. Buka AI Gateway console. Di panel navigasi sebelah kiri, pilih Instance. Di bilah menu atas, pilih wilayah.

    2. Klik ID instans target. Di panel navigasi sebelah kiri, pilih Service, lalu klik Create Service.

    3. Di panel Create Service, atur Service Sourc ke Agent Services. Atur Generation Method ke Reference Key. Lalu, atur API-KEY ke kunci yang sudah ada.

    Referensi kunci dalam layanan MCP

    Layanan MCP yang diproksi langsung oleh AI Gateway mendukung autentikasi backend. Dalam konfigurasi autentikasi, Anda dapat menentukan kunci yang sudah ada sebagai kredensial.

    1. Buka AI Gateway console. Di panel navigasi sebelah kiri, pilih Instance. Di bilah menu atas, pilih wilayah.

    2. Klik ID instans target. Klik MCP Management. Lalu, buat layanan MCP untuk skenario proxy langsung. Untuk informasi selengkapnya, lihat Create a gateway-hosted MCP service.

    3. Buka halaman detail layanan MCP. Di halaman Basic Information, klik Configure Backend Service Authentication dan konfigurasikan pengaturan berikut untuk mengaktifkan autentikasi.

      1. Authentication Method: Pilih API Key.

      2. Credential Source: Custom HTTP Header.

      3. Header: Nama header yang membawa kredensial.

      4. Generation Method: Pilih Reference Key.

      5. Credential: Pilih kunci yang sudah ada.

    Referensi kunci dalam Plugin

    Dalam konfigurasi Plugin, Anda dapat menggunakan sintaks $ref{secretName} untuk mereferensikan kunci, dengan secretName adalah nama kunci tersebut. Kode berikut memberikan contoh konfigurasi untuk Plugin Key-Auth:

    credentials: 
# Referensikan kunci bernama secretName
- $ref{secretName}
keys:
- apikey
- x-api-key

    Dengan konfigurasi ini, Anda dapat menggunakan kunci secretName untuk mengakses AI Gateway. Baik Plugin resmi maupun kustom mendukung referensi kunci.

    Lihat detail referensi kunci

    Buka AI Gateway console. Di panel navigasi sebelah kiri, pilih Key. Di kolom Referenced, klik angka untuk suatu kunci guna melihat sumber daya yang mereferensikannya.