Referensi resource Operator Apigee APIM untuk Kubernetes

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

apim.googleapis.com/v1
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 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 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 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/v1
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 penghitungan 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

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

Jenis: array

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

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

Mengidentifikasi lokasi Google Cloud tempat APIMExtensionPolicy diterapkan.
supportedEvents

Jenis: List acara

Menentukan daftar peristiwa pemroses ekstensi yang dikirim ke Apigee. Hal ini mencakup hal berikut:
  • "REQUEST_HEADERS"
  • "RESPONSE_HEADERS"
  • "REQUEST_BODY" (Pratinjau)
  • "RESPONSE_BODY" (Pratinjau)
  • "REQUEST_TRAILERS"
  • "RESPONSE_TRAILERS"

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/v1
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

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

apim.googleapis.com/v1
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 dieksekusi 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 mengeksekusi resource ini.

ConditionalParameterReference

Kolom Deskripsi
condition

Type: string

Menentukan kondisi untuk mengeksekusi resource ini.

ApimTemplateRule

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1
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 ada template APIM yang menggunakan aturan tersebut. Nilai yang valid adalah true atau false.

AssignMessage (penyisipan tokenGoogle )

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1
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 mengganti nilainya. Jika tidak, setActions akan menambahkan header atau parameter baru seperti yang ditentukan.

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

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

Array strings yang menentukan cakupan Google API yang valid. Untuk mengetahui 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 dibuat, seperti API atau akun layanan yang diberi akses oleh token.
IncludeEmail

Jenis: boolean

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

AudienceBean

Kolom Deskripsi
useTargetHost

Jenis: string

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

Secara default, useTargetUrl adalah false.

AssignToBean

Kolom Deskripsi
createNew

Jenis: boolean

Menentukan apakah kebijakan membuat pesan baru saat menetapkan nilai. Jika disetel 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.

JavaScript

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1
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.

KVM

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1
kind

Jenis: string

KVM
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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

Mengaktifkan kebijakan untuk mengidentifikasi KVM mana yang akan digunakan secara dinamis, saat runtime.
expiryTimeInSecs

Jenis: integer

Menentukan durasi dalam detik setelah Apigee memperbarui nilai yang di-cache dari KVM yang ditentukan.
initialEntries

Jenis: list

Nilai seed untuk KVM, yang diisi di KVM saat diinisialisasi.

OASValidation

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1
kind

Jenis: string

OASValidation
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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

Menentukan spesifikasi OpenAPI di yaml yang akan divalidasi. Karena ini adalah fragmen yaml multiline, gunakan pembatas "|".
source

Jenis: string

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

Lihat OASValidationOptions/td>

OASValidationOptions

Kolom Deskripsi
validateMessageBody

Jenis: boolean

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

Lihat StrictOptions

StrictOptions

Kolom Deskripsi
header

Jenis: boolean

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

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

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

Menampilkan status resource saat ini:
  • RUNNING = resource dalam status berjalan.
  • CREATING = resource sedang dibuat
  • CREATED = resource telah dibuat
  • UPDATING = resource sedang diperbarui
  • DELETING = resource sedang dihapus
  • CREATE_UPDATE_FAILED = operasi pembuatan atau pembaruan gagal
  • DELETE_FAILED = operasi penghapusan gagal
errorMessage

Jenis: string

Pesan error terkait salah satu status kegagalan kolom currentState.
operationResult

Jenis: string

String respons dari salah satu operasi yang berjalan lama terkait dengan pembuatan, update, atau penghapusan resource.

ServiceCallout

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1
kind

Jenis: string

ServiceCallout
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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

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

Menentukan variabel yang berisi pesan respons yang dikembalikan ke proxy API dari layanan eksternal.

HttpTargetConnection

Kolom Deskripsi
url

Jenis: string

URL layanan target.
properties

Jenis: Map of <string, string>

Properti transportasi HTTP ke layanan backend. Untuk mengetahui informasi selengkapnya, lihat Referensi properti endpoint.

CalloutRequest

Kolom Deskripsi
url

Jenis: string

URL layanan target.
properties

Jenis: Map of <string, string>

Properti transportasi HTTP ke layanan backend. Untuk mengetahui informasi selengkapnya, lihat Referensi properti endpoint.

SpikeArrest

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1
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 disetel ke truetrue, SpikeArrest didistribusikan di suatu region, dengan jumlah permintaan disinkronkan di seluruh pemroses pesan (MP) Apigee dalam suatu region.

Jika disetel ke false, SpikeArrest menggunakan algoritma token bucket secara lokal. Untuk mengetahui 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.

Kebijakan ResponseCache

Kolom Deskripsi
apiVersion

Jenis: string

apim.googleapis.com/v1
kind

Jenis: string

ResponseCache
metadata

Jenis: Kubernetes meta/v1.ObjectMeta

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

Jenis: APIExtensionPolicySpec

Menentukan status ResponseCache yang diinginkan.

ResponseCacheBean

Kolom Deskripsi
mode

Jenis: boolean

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

Menentukan periode waktu tunggu pencarian cache.
cacheResourceRef

jenis: string

Menentukan ID resource cache menggunakan referensi variabel.
excludeErrorResponse

jenis: boolean

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

Menentukan ekspresi yang, jika dievaluasi ke true saat runtime, menentukan bahwa pencarian cache harus dilewati dan cache harus di-refresh
skipCachePopulationCondition

jenis: string

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

Setel ke true untuk menambahkan nilai dari header respons Accept ke kunci cache entri cache respons.
useResponseCacheHeaders

jenis: boolean

Setel ke true agar header respons HTTP dipertimbangkan saat menyetel "time to live" (TTL) respons dalam cache.

cacheExpiry

Kolom Deskripsi
expiryDate

Jenis: object

Menentukan tanggal saat entri cache harus habis masa berlakunya.
timeOfDay

Jenis: object

Menentukan waktu dalam sehari saat entri cache harus habis masa berlakunya.
timeoutInSeconds

Jenis: object

Menentukan jumlah detik setelah entri cache harus berakhir.

cacheKey

Kolom Deskripsi
cacheKeyPrefix

Jenis: string

Menentukan nilai yang akan digunakan sebagai awalan kunci cache.
fragments

Jenis: object

Menentukan nilai yang akan disertakan dalam kunci cache untuk membuat ruang nama yang cocok dengan permintaan ke respons yang di-cache.