Referensi resource Operator Apigee APIM untuk Kubernetes

Halaman ini berlaku untuk Apigee, tetapi tidak untuk Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Halaman ini adalah referensi untuk setiap resource Kubernetes yang didukung oleh Operator APIM Apigee untuk Kubernetes (Pratinjau). Semua kolom wajib diisi kecuali jika secara khusus dinyatakan sebagai Opsional.

APIProduct

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1alpha1
kind

Jenis: string

APIProduct
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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: string

Nama Produk API.
approvalType

Jenis: string

Flag yang menentukan cara kunci API disetujui untuk mengakses API yang ditentukan oleh produk API. Jika ditetapkan ke manual, kunci konsumen akan dibuat dan ditampilkan sebagai pending. Dalam hal ini, kunci API tidak akan berfungsi hingga disetujui secara eksplisit.

Jika ditetapkan ke auto, kunci konsumen akan dibuat dan ditampilkan sebagai approved dan dapat langsung digunakan.

description

Jenis: string

Deskripsi produk API.
displayName

Jenis: string

Nama yang ditampilkan di UI atau portal developer kepada developer yang mendaftar untuk mendapatkan akses API.
analytics

Jenis: Analytics

Menentukan apakah analisis harus dikumpulkan untuk operasi yang terkait dengan produk ini.
enforcementRefs

Jenis: Array

Array resource EnforcementRef yang akan diterapkan ke produk API.
attributes

Jenis: Array

Array atribut yang dapat digunakan untuk memperluas profil produk API default dengan metadata khusus pelanggan.

EnforcementRef

Kolom Deskripsi
name

Jenis: string

Nama resource target.
kind

Jenis: string

APIMExtensionPolicy
group

Jenis: string

APIGroup untuk Operator APIM Apigee, yaitu apim.googleapis.com.
namespace

Jenis: string

(Opsional) Namespace perujuk. Jika tidak ditentukan, namespace lokal akan disimpulkan.

Atribut

Kolom Deskripsi
name

Jenis: string

Kunci atribut.
value

Jenis: string

Nilai atribut.

APIOperationSet

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1alpha1
kind

Jenis: string

APIOperationSet
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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

Array definisi RESTOperation.
apiProductRefs

Jenis: Array

Array resource APIProductRef, atau referensi ke Produk API tempat RESTOperations harus diterapkan.

Kuota

Kolom Deskripsi
limit

Jenis: integer

Jumlah pesan permintaan yang diizinkan per aplikasi oleh produk API untuk interval dan timeUnit yang ditentukan.
interval

Jenis: integer

Interval waktu yang digunakan untuk menghitung jumlah pesan permintaan.
timeUnit

Jenis: string

Unit waktu yang ditentukan untuk interval. Nilai yang valid mencakup minute, hour, day, atau month.

RESTOperation

Kolom Deskripsi
name

Jenis: string

Nama operasi REST.
path

Jenis: string

Bersama dengan methods, path adalah jalur HTTP yang akan dicocokkan untuk kuota dan/atau untuk produk API.
methods

Jenis: array

Bersama dengan path, methods adalah daftar (seperti strings) metode http yang berlaku untuk dicocokkan dengan kuota dan/atau untuk produk API.

APIProductRef

Kolom Deskripsi
name

Jenis: string

Nama resource target.
kind

Jenis: string

APIProduct
group

Jenis: string

APIGroup untuk Operator APIM Apigee, yaitu apim.googleapis.com.
namespace

Jenis: string

(Opsional) Namespace perujuk. Jika tidak ditentukan, namespace lokal akan disimpulkan.

APIMExtensionPolicy

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1alpha1
kind

Jenis: string

APIMExtensionPolicy
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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: boolean

Menentukan apakah akan fail open atau tidak saat runtime Apigee tidak dapat dijangkau. Jika ditetapkan ke true, panggilan ke runtime Apigee akan diperlakukan sebagai berhasil meskipun runtime tidak dapat dijangkau.
timeout

Jenis: string

Menentukan periode waktu tunggu sebelum panggilan ke runtime Apigee gagal, dalam detik atau milidetik. Misalnya, 10s.
targetRef

Jenis: ExtensionServerRef

Mengidentifikasi Google Kubernetes Engine Gateway tempat ekstensi harus diinstal.
location

Jenis: string

Mengidentifikasi Google Cloud lokasi tempat APIMExtensionPolicy diterapkan.

ExtensionServerRef

Kolom Deskripsi
name

Jenis: string

Nama resource target.
kind

Jenis: string

Menentukan kind resource target, misalnya, Gateway atau Service.
group

Jenis: string

APIGroup untuk Operator APIM Apigee, yaitu apim.googleapis.com.
namespace

Jenis: string

(Opsional) Namespace perujuk. Jika tidak ditentukan, namespace lokal akan disimpulkan.

ApigeeGatewayPolicy

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1alpha1
kind

Jenis: string

ApigeeGatewayPolicy
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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

Mengacu pada template APIM yang dibuat untuk mengatur kebijakan yang diterapkan ke GKE Gateway.
targetRef

Jenis: ExtensionServerRef

Mengacu 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 Google token autentikasi di proxy Apigee ProApigee.

ApimTemplate

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1alpha1
kind

Jenis: string

ApimTemplate
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

Lihat dokumentasi Kubernetes API untuk mengetahui kolom yang tersedia di metadata.
spec

Jenis: ApimTemplateSpec

Menentukan status ApimTemplate yang diinginkan.

ApimTemplateSpec

Kolom Deskripsi
templates

Jenis: list

Daftar resource ApimTemplateFlow yang menentukan kebijakan yang akan dijalankan dalam alur permintaan.
apimTemplateRule

Jenis: ExtensionServerRef

Menentukan aturan template APIM yang harus digunakan untuk memvalidasi kebijakan yang diterapkan.

ApimTemplateFlow

Kolom Deskripsi
policies

Jenis: list ConditionalParameterReference

Daftar resource ConditionalParameterReference yang menentukan daftar kebijakan yang diurutkan untuk dieksekusi sebagai bagian dari alur permintaan.
condition

Jenis: string

Menentukan kondisi untuk menjalankan resource ini.

ConditionalParameterReference

Kolom Deskripsi
condition

Type: string

Menentukan kondisi untuk menjalankan resource ini.

ApimTemplateRule

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1alpha1
kind

Jenis: string

ApimTemplateRule
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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: boolean

Mengganti pembaruan pada aturan template APIM jika template APIM yang menggunakan aturan tersebut ada. Nilai yang valid adalah true atau false.

JavaScript

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1alpha1
kind

Jenis: string

JavaScript
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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

Array strings yang menentukan ProxyRequest atau ProxyResponse. Menentukan apakah kebijakan dilampirkan ke alur permintaan atau alur respons.
source

Jenis: string

Kode JavaScript inline.
timeLimit

Jenis: integer

Menentukan waktu tunggu untuk eksekusi kode JavaScript.

SpikeArrest

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1alpha1
kind

Jenis: string

SpikeArrest
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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

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: boolean

Jika ditetapkan ke truetrue, SpikeArrest akan didistribusikan di region, dengan jumlah permintaan disinkronkan di seluruh pemroses pesan (MP) Apigee di region.

Jika disetel ke false, SpikeArrest akan menggunakan algoritma token bucket secara lokal. Untuk informasi selengkapnya, lihat UseEffectiveCount.

peakMessageRate

Kolom Deskripsi
ref

Jenis: string

Variabel yang mereferensikan nilai rate.
value

Jenis: string

Nilai rate sebenarnya jika referensi tidak tersedia.

AssignMessage (injeksi tokenGoogle )

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1alpha1
kind

Jenis: string

AssignMessage
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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

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, setActions akan menimpa nilai. Jika tidak, setActions akan menambahkan header atau parameter baru seperti yang ditentukan.

AssignTo

Jenis: AssignToBean

Menentukan pesan yang dioperasikan oleh kebijakan AssignMessage. Opsi mencakup permintaan, respons, atau pesan kustom baru.

SetActionsBean

Kolom Deskripsi
Authentication

Jenis: AuthenticationBean

Membuat Google 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.

AuthenticationBean

Kolom Deskripsi
GoogleAccessToken

Jenis: GoogleAccessTokenBean

Menghasilkan 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: string

Secara default, jika konfigurasi Autentikasi ada, Apigee akan membuat token pembawa dan memasukkannya ke header Otorisasi pesan yang dikirim ke sistem target. Elemen headerName memungkinkan Anda menentukan nama header yang berbeda untuk menyimpan token pembawa.

GoogleAccessTokenBean

Kolom Deskripsi
scopes

Jenis: array

Array strings yang menentukan cakupan Google API yang valid. Untuk informasi selengkapnya, lihat Cakupan OAuth 2.0 untuk Google API.
LifetimeInSeconds

Jenis: integer

Menentukan durasi masa aktif token akses dalam detik.

GoogleIDTokenBean

Kolom Deskripsi
Audience

Jenis: AudienceBean

Audiens untuk token autentikasi yang dihasilkan, seperti API atau akun layanan yang diberi akses oleh token.
IncludeEmail

Jenis: boolean

Jika ditetapkan ke true, token autentikasi yang dihasilkan akan berisi klaim email dan email_verified akun layanan.

AudienceBean

Kolom Deskripsi
useTargetHost

Jenis: string

Jika nilai Audience kosong atau variabel ref tidak me-resolve ke nilai yang valid, dan useTargetUrl adalah true, URL target (tidak termasuk parameter kueri) akan digunakan sebagai audiens.
useTargetUrl

Jenis: boolean

Secara default, useTargetUrl adalah false.

AssignToBean

Kolom Deskripsi
createNew

Jenis: boolean

Menentukan apakah kebijakan membuat pesan baru saat menetapkan nilai. Jika ditetapkan ke true, kebijakan akan membuat pesan baru.
type

Jenis: string

Menentukan jenis pesan baru, jika CreateNew disetel ke true true. Nilai yang valid adalah request atau response.