Halaman ini berlaku untuk Apigee, tetapi tidak untuk Apigee Hybrid.
Lihat dokumentasi
Apigee Edge.
Halaman ini adalah referensi untuk setiap resource Kubernetes yang didukung oleh Apigee APIM Operator untuk Kubernetes. Kecuali jika secara khusus ditandai sebagai Opsional, semua kolom wajib diisi.
APIProduct
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1
|
kind
Jenis: |
APIProduct
|
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: APIProductSpec |
spec menentukan status APIProductSet yang diinginkan.
|
APIProductSpec
Kolom | Deskripsi |
---|---|
name
Jenis: |
Nama Produk API. |
approvalType
Jenis: |
Flag yang menentukan cara kunci API disetujui untuk mengakses API yang ditentukan oleh produk API.
Jika disetel ke manual , kunci konsumen akan dibuat dan ditampilkan sebagai pending .
Dalam hal ini, kunci API tidak akan berfungsi hingga disetujui secara eksplisit.
Jika disetel ke |
description
Jenis: |
Deskripsi produk API. |
displayName
Jenis: |
Nama yang ditampilkan di UI atau portal developer kepada developer yang mendaftar untuk akses API. |
analytics
Jenis: Analytics |
Menentukan apakah analisis harus dikumpulkan untuk operasi yang terkait dengan produk ini. |
enforcementRefs
Jenis: |
Array resource EnforcementRef yang akan diterapkan ke produk API. |
attributes
Jenis: |
Array atribut yang dapat digunakan untuk memperluas profil produk API default dengan metadata khusus pelanggan. |
EnforcementRef
Kolom | Deskripsi |
---|---|
name
Jenis: |
Nama resource target. |
kind
Jenis: |
APIMExtensionPolicy
|
group
Jenis: |
APIGroup untuk Operator APIM Apigee, yaitu apim.googleapis.com .
|
namespace
Jenis: |
(Opsional) Namespace perujuk. Jika tidak ditentukan, namespace lokal akan disimpulkan. |
Atribut
Kolom | Deskripsi |
---|---|
name
Jenis: |
Kunci atribut. |
value
Jenis: |
Nilai atribut. |
APIOperationSet
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1
|
kind
Jenis: |
APIOperationSet
|
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: APIOperationSetSpec |
Menentukan status APIOperationSet yang diinginkan. |
APIOperationSetSpec
Kolom | Deskripsi |
---|---|
quota
Jenis: Kuota |
Definisi kuota. |
restOperations
Jenis: |
Array definisi RESTOperation. |
apiProductRefs
Jenis: |
Array resource APIProductRef, atau referensi ke Produk API tempat RESTOperations harus diterapkan. |
Kuota
Kolom | Deskripsi |
---|---|
limit
Jenis: |
Jumlah pesan permintaan yang diizinkan per aplikasi oleh produk API untuk interval
dan timeUnit yang ditentukan.
|
interval
Jenis: |
Interval waktu penghitungan jumlah pesan permintaan. |
timeUnit
Jenis: |
Unit waktu yang ditentukan untuk interval. Nilai yang valid mencakup minute , hour ,
day , atau month .
|
RESTOperation
Kolom | Deskripsi |
---|---|
name
Jenis: |
Nama operasi REST. |
path
Jenis: |
Jika digabungkan dengan methods , path adalah jalur HTTP yang akan dicocokkan untuk kuota
dan/atau untuk produk API.
|
methods
Jenis: |
Dalam kombinasi dengan path , methods adalah daftar (sebagai strings ) dari
metode http yang berlaku untuk dicocokkan dengan kuota
dan/atau untuk produk API.
|
APIProductRef
Kolom | Deskripsi |
---|---|
name
Jenis: |
Nama resource target. |
kind
Jenis: |
APIProduct
|
group
Jenis: |
APIGroup untuk Operator APIM Apigee, yaitu apim.googleapis.com .
|
namespace
Jenis: |
(Opsional) Namespace perujuk. Jika tidak ditentukan, namespace lokal akan disimpulkan. |
APIMExtensionPolicy
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1
|
kind
Jenis: |
APIMExtensionPolicy |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: APIMExtensionPolicySpec |
Menentukan status APIMExtensionPolicy yang diinginkan. |
APIMExtensionPolicySpec
Kolom | Deskripsi |
---|---|
apigeeEnv
|
(Opsional) Lingkungan Apigee.
Jika tidak diberikan, lingkungan baru akan dibuat dan dilampirkan ke semua instance yang tersedia. Jika disediakan, lingkungan ini harus dilampirkan ke semua instance yang tersedia saat menggunakan load balancer global eksternal. |
failOpen
Jenis: |
Menentukan apakah akan membuka saat gagal atau tidak saat runtime Apigee tidak dapat dijangkau.
Jika disetel ke true , panggilan ke runtime Apigee akan dianggap berhasil meskipun runtime tidak dapat dijangkau.
|
timeout
Jenis: |
Menentukan periode waktu tunggu sebelum panggilan ke runtime Apigee gagal, dalam detik atau milidetik.
Misalnya, 10s .
|
targetRef
Jenis: ExtensionServerRef |
Mengidentifikasi Gateway Google Kubernetes Engine tempat ekstensi harus diinstal. |
location
Jenis: |
Mengidentifikasi lokasi Google Cloud tempat APIMExtensionPolicy diterapkan. |
supportedEvents
Jenis: |
Menentukan daftar peristiwa pemroses ekstensi yang dikirim ke Apigee. Hal ini mencakup hal berikut:
|
ExtensionServerRef
Kolom | Deskripsi |
---|---|
name
Jenis: |
Nama resource target. |
kind
Jenis: |
Menentukan kind resource target, misalnya, Gateway atau Service .
|
group
Jenis: |
APIGroup untuk Operator APIM Apigee, yaitu apim.googleapis.com .
|
namespace
Jenis: |
(Opsional) Namespace perujuk. Jika tidak ditentukan, namespace lokal akan disimpulkan. |
ApigeeGatewayPolicy
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
ApigeeGatewayPolicy |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: ApigeeGatewayPolicySpec |
Menentukan status ApigeeGatewayPolicy yang diinginkan. |
ApigeeGatewayPolicySpec
Kolom | Deskripsi |
---|---|
ref Jenis: ExtensionServerRef |
Merujuk pada template APIM yang dibuat untuk mengatur kebijakan yang diterapkan ke GKE Gateway. |
targetRef
Jenis: ExtensionServerRef |
Merujuk pada kebijakan ekstensi APIM yang harus menerapkan kebijakan Gateway tertentu ini. Secara tidak langsung merujuk ke GKE Gateway. |
serviceAccount
|
(Opsional) Menentukan akun layanan yang digunakan untuk membuat token otorisasi Google di proxy Apigee ProApigee. |
ApimTemplate
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
ApimTemplate |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: ApimTemplateSpec |
Menentukan status ApimTemplate yang diinginkan. |
ApimTemplateSpec
Kolom | Deskripsi |
---|---|
templates
Jenis: |
Daftar resource ApimTemplateFlow yang menentukan kebijakan yang akan dieksekusi dalam alur permintaan. |
apimTemplateRule
Jenis: ExtensionServerRef |
Menentukan aturan template APIM yang harus digunakan untuk memvalidasi kebijakan yang diterapkan. |
ApimTemplateFlow
Kolom | Deskripsi |
---|---|
policies
Jenis: |
Daftar resource ConditionalParameterReference yang menentukan daftar kebijakan yang diurutkan untuk dieksekusi sebagai bagian dari alur permintaan. |
condition
Jenis: |
Menentukan kondisi untuk mengeksekusi resource ini. |
ConditionalParameterReference
Kolom | Deskripsi |
---|---|
condition
|
Menentukan kondisi untuk mengeksekusi resource ini. |
ApimTemplateRule
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
ApimTemplateRule |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: ApimTemplateRuleSpec |
Menentukan status ApimTemplateRule yang diinginkan. |
ApimTemplateRuleSpec
Kolom | Deskripsi |
---|---|
requiredList
|
Daftar kebijakan (sebagai strings ) yang harus ada di ApimTemplate.
|
denyList
|
Daftar kebijakan (sebagai strings ) yang tidak boleh ada di ApimTemplate.
|
allowList
|
Daftar kebijakan (sebagai strings ) yang mungkin ada di ApimTemplate, tetapi tidak diperlukan.
|
override
Jenis: |
Mengganti pembaruan pada aturan template APIM jika ada template APIM yang menggunakan aturan tersebut.
Nilai yang valid adalah true atau false .
|
AssignMessage (penyisipan tokenGoogle )
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
AssignMessage |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: AssignMessageBean |
Menentukan status kebijakan AssignMessage yang diinginkan. |
AssignMessageBean
Kolom | Deskripsi |
---|---|
setActions
Jenis: |
Array objek SetActionsBean . Mengganti nilai properti yang ada pada permintaan atau respons,
seperti yang ditentukan oleh elemen AssignTo .
Jika header atau parameter sudah ada dalam pesan asli, |
AssignTo
Jenis: AssignToBean |
Menentukan pesan mana yang dioperasikan oleh kebijakan AssignMessage. Opsi mencakup permintaan, respons, atau pesan kustom baru. |
SetActionsBean
Kolom | Deskripsi |
---|---|
Authentication
Jenis: AuthenticationBean |
Membuat token OAuth 2.0 atau OpenID Connect untuk melakukan panggilan yang diautentikasi ke Google layanan atau layanan kustom yang berjalan di produk Google Cloud tertentu, seperti fungsi Cloud Run dan Cloud Run. Google |
AuthenticationBean
Kolom | Deskripsi |
---|---|
GoogleAccessToken
Jenis: GoogleAccessTokenBean |
Membuat token Google OAuth 2.0 untuk melakukan panggilan yang diautentikasi ke layanan Google. |
GoogleIDToken
Jenis: GoogleIDTokenBean |
Konfigurasi untuk membuat Token OpenID Connect guna mengautentikasi permintaan target. |
headerName
Jenis: |
Secara default, jika konfigurasi Autentikasi ada, Apigee akan membuat token pembawa dan menyisipkannya ke header Otorisasi pesan yang dikirim ke sistem target.
Elemen headerName memungkinkan Anda menentukan nama header lain
untuk menyimpan token bearer.
|
GoogleAccessTokenBean
Kolom | Deskripsi |
---|---|
scopes
Jenis: |
Array strings yang menentukan cakupan Google API yang valid. Untuk mengetahui informasi selengkapnya, lihat Cakupan OAuth 2.0 untuk Google API.
|
LifetimeInSeconds
Jenis: |
Menentukan durasi masa aktif token akses dalam detik. |
GoogleIDTokenBean
Kolom | Deskripsi |
---|---|
Audience
Jenis: AudienceBean |
Audiens untuk token autentikasi yang dibuat, seperti API atau akun layanan yang diberi akses oleh token. |
IncludeEmail
Jenis: |
Jika disetel ke true , token autentikasi yang dibuat akan berisi klaim email dan email_verified akun layanan.
|
AudienceBean
Kolom | Deskripsi |
---|---|
useTargetHost
Jenis: |
Jika nilai Audience kosong atau variabel ref tidak diubah menjadi nilai yang valid, dan useTargetUrl adalah true , maka URL target (tidak termasuk parameter kueri) akan digunakan sebagai audiens.
|
useTargetUrl
Jenis: |
Secara default, useTargetUrl adalah false .
|
AssignToBean
Kolom | Deskripsi |
---|---|
createNew
Jenis: |
Menentukan apakah kebijakan membuat pesan baru saat menetapkan nilai. Jika disetel ke true , kebijakan akan membuat pesan baru.
|
type
Jenis: |
Menentukan jenis pesan baru, jika CreateNew disetel ke true true.
Nilai yang valid adalah request atau response.
|
JavaScript
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
JavaScript |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: JavascriptBean |
Menentukan status kebijakan JavaScript yang diinginkan. |
JavascriptBean
Kolom | Deskripsi |
---|---|
mode
Jenis: |
Array strings yang menentukan ProxyRequest atau ProxyResponse . Menentukan apakah kebijakan
dilampirkan ke alur permintaan atau alur respons.
|
source
Jenis: |
Kode JavaScript inline. |
timeLimit
Jenis: |
Menentukan waktu tunggu untuk eksekusi kode JavaScript. |
KVM
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
KVM |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: KeyValueMapOperationsBean |
Menentukan status kebijakan KVM yang diinginkan. |
KeyValueMapOperationsBean
Kolom | Deskripsi |
---|---|
MapName
Jenis: |
Mengaktifkan kebijakan untuk mengidentifikasi KVM mana yang akan digunakan secara dinamis, saat runtime. |
expiryTimeInSecs
Jenis: |
Menentukan durasi dalam detik setelah Apigee memperbarui nilai yang di-cache dari KVM yang ditentukan. |
initialEntries
Jenis: |
Nilai seed untuk KVM, yang diisi di KVM saat diinisialisasi. |
OASValidation
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
OASValidation |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: OASValidationBean |
Menentukan status yang diinginkan dari kebijakan OASValidation. |
OASValidationBean
Kolom | Deskripsi |
---|---|
openApiSpec
Jenis: |
Menentukan spesifikasi OpenAPI di yaml yang akan divalidasi. Karena ini adalah fragmen
yaml multiline, gunakan pembatas "|". |
source
Jenis: |
Salah satu dari message , request , atau response . Jika disetel ke request ,
permintaan masuk dari aplikasi klien akan dievaluasi; jika disetel ke response , respons dari server target akan dievaluasi. Jika disetel ke message , kebijakan akan otomatis mengevaluasi permintaan
atau respons, bergantung pada apakah kebijakan dilampirkan ke alur permintaan atau respons. |
options
Jenis: |
Lihat OASValidationOptions/td> |
OASValidationOptions
Kolom | Deskripsi |
---|---|
validateMessageBody
Jenis: |
Menentukan apakah kebijakan harus memvalidasi isi pesan terhadap skema isi permintaan operasi dalam Spesifikasi OpenAPI. Setel ke true untuk memvalidasi konten isi pesan. Setel
ke false untuk memvalidasi hanya keberadaan isi pesan. |
allowUnspecifiedParameters
Jenis: |
Lihat StrictOptions |
StrictOptions
Kolom | Deskripsi |
---|---|
header
Jenis: |
Untuk mengizinkan parameter header ditentukan dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI, tetapkan parameter ini ke true .
Jika tidak, tetapkan parameter ini ke false agar eksekusi kebijakan gagal. |
query
Jenis: |
Untuk mengizinkan parameter kueri ditentukan dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI,
tetapkan parameter ini ke true . Jika tidak, tetapkan parameter ini ke false
agar eksekusi kebijakan gagal. |
cookie
Jenis: |
Untuk mengizinkan parameter cookie ditentukan dalam permintaan yang tidak ditentukan dalam Spesifikasi OpenAPI,
tetapkan parameter ini ke true . Jika tidak, tetapkan parameter ini ke false agar eksekusi kebijakan gagal. |
APIMResourceStatus
Kolom | Deskripsi |
---|---|
currentState
Jenis: |
Menampilkan status resource saat ini:
|
errorMessage
Jenis: |
Pesan error terkait salah satu status kegagalan kolom currentState . |
operationResult
Jenis: |
String respons dari salah satu operasi yang berjalan lama terkait dengan pembuatan, update, atau penghapusan resource. |
ServiceCallout
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
ServiceCallout |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: ServiceCalloutBean |
Menentukan status yang diinginkan dari kebijakan ServiceCallout. |
ServiceCalloutBean
Kolom | Deskripsi |
---|---|
httpTargetConnection
Jenis: |
Menyediakan detail transportasi seperti URL, TLS/SSL, dan properti HTTP. |
request
Jenis: CalloutRequest |
Menentukan variabel yang berisi pesan permintaan yang dikirim dari proxy API ke layanan lain. |
Response
Jenis: |
Menentukan variabel yang berisi pesan respons yang dikembalikan ke proxy API dari layanan eksternal. |
HttpTargetConnection
Kolom | Deskripsi |
---|---|
url
Jenis: |
URL layanan target. |
properties
Jenis: |
Properti transportasi HTTP ke layanan backend. Untuk mengetahui informasi selengkapnya, lihat Referensi properti endpoint. |
CalloutRequest
Kolom | Deskripsi |
---|---|
url
Jenis: |
URL layanan target. |
properties
Jenis: |
Properti transportasi HTTP ke layanan backend. Untuk mengetahui informasi selengkapnya, lihat Referensi properti endpoint. |
SpikeArrest
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
SpikeArrest |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: SpikeArrestBean |
Menentukan status kebijakan SpikeArrest yang diinginkan. |
SpikeArrestBean
Kolom | Deskripsi |
---|---|
mode
Jenis: |
Array strings yang menentukan ProxyRequest atau ProxyResponse . Menentukan apakah kebijakan
dilampirkan ke alur permintaan atau alur respons.
|
peakMessageRate
Jenis: peakMessageRate |
Menentukan kecepatan pesan untuk SpikeArrest. |
useEffectiveCount
Jenis: |
Jika disetel ke true true, SpikeArrest didistribusikan di suatu region, dengan
jumlah permintaan disinkronkan di seluruh pemroses pesan (MP) Apigee dalam suatu region.
Jika disetel ke |
peakMessageRate
Kolom | Deskripsi |
---|---|
ref
Jenis: |
Variabel yang mereferensikan nilai rate .
|
value
Jenis: |
Nilai rate sebenarnya jika referensi tidak tersedia.
|
Kebijakan ResponseCache
Kolom | Deskripsi |
---|---|
apiVersion
Jenis: |
apim.googleapis.com/v1 |
kind
Jenis: |
ResponseCache |
metadata
|
Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata .
|
spec
Jenis: APIExtensionPolicySpec |
Menentukan status ResponseCache yang diinginkan. |
ResponseCacheBean
Kolom | Deskripsi | |
---|---|---|
mode
Jenis: |
Menentukan ProxyRequest atau ProxyResponse . Menentukan apakah kebijakan
dilampirkan ke alur permintaan atau alur respons.
|
|
cacheExpiry
Jenis: cacheExpiry |
Menyediakan objek cacheExpiry. | |
cacheKey
Jenis: cacheKey |
Menyediakan objek cacheKey. | |
cacheLookupTimeOut
jenis: |
Menentukan periode waktu tunggu pencarian cache. | |
cacheResourceRef
jenis: |
Menentukan ID resource cache menggunakan referensi variabel. | |
excludeErrorResponse
jenis: |
Kebijakan ini dapat menyimpan respons HTTP dalam cache dengan kode status apa pun. Artinya, respons berhasil dan error dapat di-cache, termasuk kode status 2xx dan 3xx .
|
|
skipCacheLookupCondition
jenis: |
Menentukan ekspresi yang, jika dievaluasi ke true saat runtime, menentukan bahwa pencarian cache harus dilewati dan cache harus di-refresh
|
|
skipCachePopulationCondition
jenis: |
Menentukan ekspresi yang, jika dievaluasi menjadi | Menentukan ekspresi yang, jika dievaluasi ke true saat runtime, menentukan bahwa pencarian cache harus dilewati dan cache harus di-refresh
saat runtime, menentukan bahwa penulisan ke cache harus dilewati.
|
useAcceptHeader
jenis: |
Setel ke true untuk menambahkan nilai dari header respons Accept ke kunci cache entri cache respons.
|
|
useResponseCacheHeaders
jenis: |
Setel ke true agar header respons HTTP dipertimbangkan saat menyetel "time to live" (TTL) respons dalam cache.
|
cacheExpiry
Kolom | Deskripsi |
---|---|
expiryDate
Jenis: |
Menentukan tanggal saat entri cache harus habis masa berlakunya. |
timeOfDay
Jenis: |
Menentukan waktu dalam sehari saat entri cache harus habis masa berlakunya. |
timeoutInSeconds
Jenis: |
Menentukan jumlah detik setelah entri cache harus berakhir. |
cacheKey
Kolom | Deskripsi |
---|---|
cacheKeyPrefix
Jenis: |
Menentukan nilai yang akan digunakan sebagai awalan kunci cache. |
fragments
Jenis: |
Menentukan nilai yang akan disertakan dalam kunci cache untuk membuat ruang nama yang cocok dengan permintaan ke respons yang di-cache. |