Referensi variabel alur

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

Bagian ini memberikan informasi referensi tentang variabel alur.

Apigee menentukan variabel alur berikut:

apigee                 is                       request
apiproduct             loadbalancing            response
apiproxy               message                  route
client                 messageid                servicecallout
current                mint                     system
environment            organization             target
error                  proxy                    variable
fault                  publishmessage           
graphql                ratelimit

Setiap variabel ini dijelaskan di bagian selanjutnya.

apigee

Variabel pembantu yang memberikan informasi tentang waktu eksekusi kebijakan.

Tabel berikut menjelaskan properti variabel apigee:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
apigee.metrics.policy.policy_name.timeTaken Bilangan bulat Hanya baca Waktu, dalam nanodetik, yang diperlukan kebijakan untuk dieksekusi. Kebijakan

apiproduct

Variabel helper yang memberikan informasi tentang produk API.

Tabel berikut menjelaskan properti variabel apiproduct:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
apiproduct.operation String Hanya baca

Nama operasi produk API. Variabel ini membantu Anda membedakan antara setelan Kebijakan kuota dan setelan kuota pada operasi produk API.

Misalnya, my-operation.

 Permintaan proxy
apiproduct.operation.resource String Hanya baca

Nama resource operasi yang cocok dengan permintaan.

 Permintaan proxy
apiproduct.operation.methods Array Hanya baca

Array metode HTTP yang diizinkan oleh operasi yang dicocokkan.

 Permintaan proxy
apiproduct.operation.attributes.key_name Array Hanya baca

Mendapatkan nilai atribut kustom yang cocok dengan key_name.

 Permintaan proxy

Untuk informasi selengkapnya, lihat referensi berikut:

apiproxy

Menjelaskan proxy API.

Tabel berikut menjelaskan properti variabel apiproxy:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
apiproxy.name String Hanya baca Nama proxy API. Misalnya, My Proxy. Permintaan proxy
apiproxy.revision String Hanya baca Nomor revisi proxy API. Misalnya, 6. Permintaan proxy
apiproxy.basepath String Hanya baca Jalur dasar deployment (ditentukan selama deployment API). Permintaan proxy

Untuk mengetahui informasi selengkapnya tentang cara menggunakan proxy API, lihat Memahami API dan proxy API.

client

Aplikasi atau sistem yang mengirim permintaan ke load balancer.

Tabel berikut menjelaskan properti variabel client:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
client.cn String Hanya baca

Nama umum yang ditentukan dalam sertifikat TLS/SSL yang diberikan oleh aplikasi klien.

 Permintaan proxy
client.country String Hanya baca

Negara dalam sertifikat TLS/SSL yang diberikan oleh aplikasi klien.

 Permintaan proxy
client.email.address String Hanya baca

Alamat email dalam sertifikat TLS/SSL yang diberikan oleh aplikasi klien.

 Permintaan proxy
client.host String Hanya baca

IP host HTTP yang terkait dengan permintaan yang diterima oleh ProxyEndpoint.

 Permintaan proxy
client.ip String Hanya baca

Alamat IP klien atau sistem yang mengirim pesan ke load balancer. Misalnya, ini bisa berupa IP klien asli atau IP load balancer.

 Permintaan proxy
client.locality String Hanya baca

Lokalitas (Kota) dalam sertifikat TLS/SSL yang diberikan oleh klien.

 Permintaan proxy
client.organization String Hanya baca Organisasi dalam sertifikat TLS/SSL yang diberikan oleh klien. (Tidak harus sama dengan organisasi di Apigee.) Permintaan proxy
client.organization.unit String Hanya baca

Unit organisasi dalam sertifikat TLS/SSL yang diberikan oleh klien.

 Permintaan proxy
client.port Bilangan bulat Hanya baca

Port HTTP yang terkait dengan permintaan klien asal ke ProxyEndpoint.

 Permintaan proxy
client.received.end.time String Hanya baca

Waktu, yang dinyatakan dalam bentuk string, saat proxy selesai menerima permintaan dari klien asal di ProxyEndpoint. Misalnya: Wed, 21 Aug 2013 19:16:47 UTC.

Nilai waktu ini adalah representasi string dari jumlah stempel waktu 32-bit yang sesuai. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC sesuai dengan nilai stempel waktu 1377112607413.

 Permintaan proxy
client.received.end.timestamp Long Hanya baca

Nilai stempel waktu yang menentukan kapan proxy selesai menerima permintaan dari klien asal di ProxyEndpoint. Nilai ini adalah bilangan bulat 64-bit (panjang) yang berisi jumlah milidetik yang telah berlalu sejak tengah malam, pada 1 Januari 1970 UTC.

 Permintaan proxy
client.received.start.time String Hanya baca

Waktu, yang dinyatakan dalam bentuk string, saat proxy mulai menerima permintaan dari klien asal di ProxyEndpoint. Misalnya: Wed, 21 Aug 2013 19:16:47 UTC

Nilai waktu ini adalah representasi string dari jumlah stempel waktu 32-bit yang sesuai. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC sesuai dengan nilai stempel waktu 1377112607413.

 Permintaan proxy
client.received.start.timestamp Long Hanya baca

Nilai stempel waktu yang menentukan kapan proxy mulai menerima permintaan dari klien asal di ProxyEndpoint. Nilai ini adalah bilangan bulat 64-bit (panjang) yang berisi jumlah milidetik yang telah berlalu sejak tengah malam, pada 1 Januari 1970 UTC.

 Permintaan proxy
client.resolved.ip String Hanya baca

Alamat IP klien yang telah di-resolve. Nilai ini adalah nilai yang ditentukan dari setelan penyelesaian IP klien yang dikonfigurasi atau dari algoritma default, jika setelan penyelesaian IP klien tidak ditentukan. Lihat Resolusi IP klien untuk mengetahui informasinya.

 Permintaan proxy
client.scheme String Hanya baca

Menampilkan HTTP atau HTTPS, bergantung pada transport yang digunakan oleh aplikasi klien untuk mengirim pesan permintaan.

 Permintaan proxy
client.sent.end.time String Hanya baca

Waktu, yang dinyatakan dalam bentuk string, saat proxy selesai mengirim respons dari ProxyEndpoint ke klien. Misalnya: Wed, 21 Aug 2013 19:16:47 UTC.

Nilai ini adalah representasi string dari client.sent.end.timestamp 32-bit yang sesuai. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC sesuai dengan nilai stempel waktu 1377112607413.

 PostClientFlow
client.sent.end.timestamp Long Hanya baca Nilai stempel waktu yang menentukan kapan ProxyEndpoint selesai menampilkan respons ke aplikasi klien asal. Nilai ini adalah bilangan bulat 64-bit (long) yang berisi jumlah milidetik yang berlalu sejak tengah malam, pada 1 Januari 1970 UTC. PostClientFlow
client.sent.start.time String Hanya baca Waktu, yang dinyatakan dalam bentuk string, saat ProxyEndpoint mulai menampilkan respons ke aplikasi klien asal. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC.

Nilai ini adalah representasi string dari client.sent.start.timestamp 32-bit yang sesuai. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC sesuai dengan nilai stempel waktu 1377112607413.

 PostClientFlow
client.sent.start.timestamp Long Hanya baca Saat proxy mulai mengirim respons ke klien dari ProxyEndpoint. Nilai ini dinyatakan sebagai bilangan bulat 64-bit (panjang) yang berisi jumlah milidetik yang telah berlalu sejak tengah malam, pada 1 Januari 1970 UTC. PostClientFlow
client.ssl.enabled String Hanya baca

true jika ProxyEndpoint dikonfigurasi untuk TLS/SSL; jika tidak, false.

 Permintaan proxy
client.state String Hanya baca

Status di sertifikat TLS/SSL yang ditampilkan oleh klien.

 Permintaan proxy

current

Berisi informasi tentang alur proxy API saat ini.

Tabel berikut menjelaskan properti variabel current:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
current.flow.name String Hanya baca Nama alur yang sedang dieksekusi (seperti PreFlow, PostFlow, atau nama alur bersyarat). Permintaan proxy
current.flow.description String Hanya baca Deskripsi alur yang sedang dieksekusi. Nilai ini sama dengan nilai elemen <Description> dalam konfigurasi XML alur. Permintaan proxy

Anda dapat melihat properti ini di tampilan Trace UI Apigee.

environment

Container untuk properti environment.name.

Tabel berikut menjelaskan properti variabel environment:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
environment.name String Hanya baca Nama lingkungan tempat transaksi berjalan. Permintaan proxy

error

Objek kontekstual yang merepresentasikan pesan error dalam alur error.

Tabel berikut menjelaskan properti variabel error:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
error message Baca/Tulis Error jenis message, yang merupakan objek kontekstual dalam alur error. Error
error.content String Baca/Tulis Konten error. Error
error.message String Hanya baca

Pesan yang terkait dengan error, yang nilainya hanya tersedia sebelum Flow error dieksekusi.

 Error
error.status.code Bilangan bulat Hanya baca

Kode status HTTP yang terkait dengan error. Misalnya, 400.

 Error
error.transport.message TransportMessage Hanya baca

Error jenis TransportMessage.

 Error
error.state Bilangan bulat Hanya baca

Status dalam Alur tempat terjadinya error.

 Error
error.header.header_name String Baca/Tulis

Mendapatkan atau menetapkan header respons.

 Error

fault

Memberikan informasi tentang sumber, alasan, dan detail error runtime. Apigee menetapkan variabel ini saat kebijakan memunculkan error, dan nilainya khusus untuk setiap kebijakan. Untuk memahami kapan variabel fault ditetapkan, lihat Tentang error kebijakan.

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
fault.name String Hanya baca Nama kesalahan, seperti yang dijelaskan dalam tabel Error runtime yang disertakan dalam setiap topik referensi kebijakan. Variabel ini dapat berguna dalam Kondisi yang diterapkan ke FaultRules. Error
fault.reason String Hanya baca Alasan kesalahan. Misalnya, saat kebijakan OASValidation mendeteksi bahwa permintaan masuk tidak divalidasi terhadap Spesifikasi OpenAPI, kebijakan tersebut akan menetapkan variabel ini ke string yang menjelaskan nama kebijakan, nama spesifikasi, dan detail yang menjelaskan alasan permintaan tidak divalidasi terhadap spesifikasi. Kebijakan lain akan menyetel variabel ini ke pesan yang sesuai untuk kesalahan mereka. Error
fault.category String Hanya baca Kategori. Misalnya, jika kesalahan terjadi pada langkah kebijakan, variabel ini mungkin berisi nilai "Step". Variabel ini dapat berguna dalam Kondisi yang diterapkan ke FaultRules. Error
fault.subcategory String Hanya baca Subkategori. Misalnya, jika kebijakan OASValidation mendeteksi bahwa permintaan tidak memvalidasi Spesifikasi OpenAPI, kebijakan ini akan menetapkan variabel ini ke "OASValidationFailure". Variabel ini dapat berguna dalam Kondisi yang diterapkan ke FaultRules. Error

graphql

Memberi Anda akses ke hasil kueri GraphQL saat runtime. Untuk mengetahui informasi selengkapnya, lihat Kebijakan GraphQL.

Tabel berikut menjelaskan properti variabel graphql:

Properti Jenis Baca/Tulis Deskripsi
graphql Jenis kompleks HANYA BACA/BACA TULIS Kueri GraphQL root. CAKUPAN
graphql.fragment Jenis kompleks HANYA BACA/BACA TULIS Referensi ke fragmen default untuk kueri ini. CAKUPAN
graphql.fragment.count Bilangan bulat Hanya Baca Jumlah fragmen yang dihasilkan oleh kueri GraqhQL ini. CAKUPAN
graphql.fragment.INDEX.selectionSet.INDEX JENIS HANYA BACA/BACA TULIS Referensi ke set pilihan pada indeks yang ditentukan. CAKUPAN
graphql.fragment.INDEX.selectionSet.INDEX.name String HANYA BACA/BACA TULIS Nama set pilihan pada indeks yang ditentukan. CAKUPAN
graphql.fragment.INDEX.selectionSet.count Bilangan bulat Hanya Baca Jumlah set pilihan dalam fragmen ini. CAKUPAN
graphql.fragment.INDEX.selectionSet.name String HANYA BACA/BACA TULIS Nama set pilihan default dalam fragmen. CAKUPAN
graphql.operation Jenis kompleks HANYA BACA/BACA TULIS Referensi ke operasi default kueri.

Anda tidak dapat menetapkan kuota di tingkat operasi. Sebagai gantinya, tetapkan di tingkat lingkungan.

 CAKUPAN
graphql.operation.name String Hanya Baca Nama operasi default kueri. CAKUPAN
graphql.operation.operationType Enumerasi Hanya Baca Jenis operasi default kueri yang dapat dijalankan terhadap proxy API ini. Nilai yang mungkin adalah query, mutation, atau all. CAKUPAN
graphql.operation.selectionSet Jenis Kompleks Set pilihan default untuk operasi default kueri. CAKUPAN
graphql.operation.selectionSet.count Bilangan bulat Hanya Baca Jumlah set pilihan dalam operasi default kueri. CAKUPAN
graphql.operation.selectionSet.name String Hanya Baca Nama set pilihan default operasi default kueri. CAKUPAN
graphql.operation.selectionSet.INDEX Bilangan bulat Hanya Baca Referensi ke set pilihan pada indeks yang ditentukan dalam daftar set pilihan. CAKUPAN
graphql.operation.selectionSet.INDEX.name String Hanya Baca Nama pilihan pada indeks yang ditentukan dalam daftar set pilihan untuk operasi ini. CAKUPAN
graphql.operation.selectionSet.INDEX.[selectionSet] Jenis kompleks HANYA BACA/BACA TULIS Satu atau beberapa objek set pilihan tambahan.

Set pilihan dapat diakses secara rekursif. Misalnya, setelah selectionSet.index, Anda dapat memiliki selectionSet.index lain, bukan properti name. Setelah itu, Anda dapat menambahkan satu per satu hingga mencapai nilai <MaxCount> yang Anda tetapkan di kebijakan GraphQL.

CAKUPAN
graphql.operation.selectionSet.INDEX.directive Jenis kompleks Referensi ke direktif default dalam set pilihan yang ditentukan. CAKUPAN
graphql.operation.selectionSet.INDEX.directive.count Jenis kompleks CAKUPAN
graphql.operation.selectionSet.INDEX.directive.INDEX Bilangan bulat Hanya Baca Referensi ke direktif pada indeks yang ditentukan. CAKUPAN
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX Bilangan bulat Hanya Baca Referensi ke argumen pada indeks yang ditentukan. CAKUPAN
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.name String Nama argumen pada indeks yang ditentukan. CAKUPAN
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.value String Nilai argumen pada indeks yang ditentukan. CAKUPAN
graphql.operation.selectionSet.INDEX.directive.name String CAKUPAN
graphql.operation.variableDefinitions Jenis kompleks Referensi ke daftar definisi variabel untuk operasi default kueri. CAKUPAN
graphql.operation.variableDefinitions.count Bilangan bulat Jumlah definisi variabel untuk operasi default kueri. CAKUPAN
graphql.operation.variableDefinitions.INDEX Bilangan bulat Referensi ke definisi variabel pada indeks yang ditentukan. CAKUPAN
graphql.operation.variableDefinitions.INDEX.name String Nama definisi variabel pada indeks yang ditentukan. CAKUPAN
graphql.operation.variableDefinitions.INDEX.type Jenis nilai definisi variabel pada indeks yang ditentukan. CAKUPAN

is

Container untuk properti is.error.

Tabel berikut menjelaskan properti variabel is:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
is.error Boolean Hanya baca

Tanda error.

 Permintaan proxy

loadbalancing

Memberikan informasi tentang status load balancing TargetEndpoint.

Tabel berikut menjelaskan properti variabel loadbalancing:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
loadbalancing.failedservers Array String Hanya baca

Daftar TargetServer yang gagal selama load balancing di TargetEndpoint.

 Respons target
loadbalancing.isfallback Boolean Hanya baca

true jika penggantian diaktifkan untuk TargetServer yang dipanggil selama load balancing di TargetEndpoint.

 Respons target
loadbalancing.targetserver String Hanya baca

TargetServer dipanggil selama load balancing di TargetEndpoint. Hanya disetel jika elemen <Path> disetel saat menentukan elemen load balancer.

 Respons target

message

Objek kontekstual, dengan nilai yang sama seperti request dalam alur permintaan atau seperti response dalam alur respons atau seperti error dalam alur error.

Tabel berikut menjelaskan properti variabel message:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
message message Baca/Tulis

Objek kontekstual, dengan nilai yang sama seperti request dalam Flow permintaan atau seperti response dalam Flow respons atau seperti error dalam Flow Error.

 Permintaan proxy
message.content String Baca/Tulis

Konten permintaan, respons, atau pesan error.

 Permintaan proxy
message.content.as.base64 String Hanya baca

Konten payload berenkode base64 dari permintaan, respons, atau pesan error.

 Permintaan proxy
message.content.as.url.safe.base64 String Hanya baca

Konten payload berenkode base64 yang aman untuk URL dari permintaan, respons, atau pesan error.

 Permintaan proxy
message.formparam.param_name String Baca/Tulis

Nilai parameter formulir yang ditentukan.

 Permintaan proxy
message.formparam.param_name.
 values		 Koleksi Hanya baca

Semua nilai parameter formulir yang ditentukan dalam pesan.

 Permintaan proxy
message.formparam.param_name.
 values.count		 Bilangan bulat Hanya baca

Jumlah nilai parameter formulir yang ditentukan dalam pesan.

 Permintaan proxy
message.formparams.count Bilangan bulat Hanya baca

Jumlah semua parameter formulir dalam pesan.

 Permintaan proxy
message.formparams.names Koleksi Hanya baca

Nilai semua parameter formulir dalam pesan.

 Permintaan proxy
message.formparams.names.string String Hanya baca

Daftar nama semua parameter formulir dalam pesan yang dipisahkan koma.

 Permintaan proxy
message.formstring String Hanya baca

Nilai string formulir dalam pesan.

 Permintaan proxy
message.header.header_name String Baca/Tulis

Mendapatkan atau menetapkan nilai header tertentu yang ditemukan dalam permintaan. Jika header berisi koma, saat dibaca, Anda hanya akan menerima segmen teks hingga koma pertama.

Misalnya, jika header Cache-control adalah public, maxage=16544, maka nilai yang ditampilkan dari message.header.cache-control adalah public.

Jika Anda menginginkan seluruh header sebagai string, gunakan variabel seperti message.header.header_name.values.string.

 Permintaan proxy
message.header.header_name.N String Baca/Tulis

Nilai header tertentu Nth dalam pesan, baik permintaan maupun respons, bergantung pada status alur. Apigee memisahkan nilai teks header dengan koma. Indeks dimulai dari 1 untuk nilai paling kiri.

Misalnya, jika header Cache-control adalah public,maxage=16544, maka nilai yang ditampilkan dari message.header.cache-control.2 adalah maxage=16544.

 Permintaan proxy
message.header.header_name.
 values		 Koleksi Hanya baca

Semua nilai nama header HTTP yang ditentukan dalam pesan.

 Permintaan proxy
message.header.header_name.
 values.count		 Bilangan bulat Hanya baca

Jumlah nilai nama header HTTP yang ditentukan dalam pesan.

 Permintaan proxy
message.header.header_name.
 values.string		 String Hanya baca

Semua nilai header tertentu dalam pesan, dalam bentuk string tunggal.

Misalnya, jika header Cache-control adalah public,maxage=16544, maka nilai yang ditampilkan dari message.header.cache-control.values.string adalah public,maxage=16544.

 Permintaan proxy
message.headers.count Bilangan bulat Hanya baca

Jumlah semua header HTTP dalam pesan.

 Permintaan proxy
message.headers.names Koleksi Hanya baca

Nilai semua header HTTP dalam pesan.

 Permintaan proxy
message.headers.names.string String Hanya baca

Daftar nama semua header dalam pesan yang dipisahkan koma.

 Permintaan proxy
message.path String Baca/Tulis

Jalur pesan permintaan lengkap di URL, tidak termasuk parameter kueri.

Permintaan proxy
message.queryparam.param_name String Hanya baca

Menampilkan parameter kueri pesan yang ditentukan.

 Permintaan proxy
message.queryparam.param_name.N String Baca/Tulis

Nilai parameter kueri Nth dalam pesan. Misalnya, jika request.querystring adalah a=hello&a=world, maka nilai yang ditampilkan dari message.queryparam.a.1 adalah hello.

Sebagai contoh penulisan beberapa nilai untuk satu nama parameter kueri, seperti type=siteid:1&type=language:us-en&type=currency:USD, tetapkan berikut ini:

  • message.queryparam.type.1 ke siteid:1
  • message.queryparam.type.2 ke language:en-us
  • message.queryparam.type.3 ke currency:USD
 Permintaan proxy
message.queryparam.param_name.
 values		 Koleksi Hanya baca

Semua nilai parameter kueri tertentu dalam pesan, diformat sebagai daftar yang dipisahkan koma.

Misalnya, jika string kueri adalah a=hello&a=world, maka nilai message.queryparam.a.values adalah ['hello', 'world']code>.

 Permintaan proxy
message.queryparam.param_name.
 values.count		 Bilangan bulat Hanya baca

Jumlah total parameter kueri tertentu yang terkait dengan permintaan yang dikirim ke ProxyEndpoint dari aplikasi klien.

 Permintaan proxy
message.queryparams.count Bilangan bulat Hanya baca

Jumlah total semua parameter kueri yang terkait dengan permintaan yang dikirim ke ProxyEndpoint dari aplikasi klien.

 Permintaan proxy
message.queryparams.names Koleksi Hanya baca

Daftar semua nama parameter kueri yang terkait dengan permintaan yang dikirim ke ProxyEndpoint dari aplikasi klien.

 Permintaan proxy
message.queryparams.names.string String Hanya baca

Daftar nama semua parameter kueri dalam pesan yang dipisahkan koma.

 Permintaan proxy
message.querystring String Hanya baca

String yang berisi semua nama dan nilai parameter kueri yang terkait dengan permintaan yang dikirim ke ProxyEndpoint dari aplikasi klien.

Misalnya, untuk permintaan http://api.apifactory.com/inventors?name=nick&surname=danger, nilai message.querystring adalah name=nick&surname=danger.

 Permintaan proxy
message.status.code Bilangan bulat Hanya baca

Kode status HTTP pesan respons dari target.

 Respons target
message.transport.message TransportMessage Hanya baca

Pesan berjenis TransportMessage yang merupakan objek kontekstual.

 Permintaan proxy
message.uri String Hanya baca

Jalur URI lengkap (setelah URL domain) termasuk parameter kueri.

Misalnya, untuk permintaan http://api.apifactory.com/inventors?name=nikola&surname=tesla, variabel ini menampilkan inventors?name=nikola&surname=tesla.

 Permintaan proxy
message.verb String Hanya baca

Kata kerja HTTP (GET, PUT, POST, DELETE, dll.) yang terkait dengan permintaan.

 Permintaan proxy
message.version String Baca/Tulis

Versi HTTP yang terkait dengan permintaan yang dikirim ke ProxyEndpoint dari aplikasi klien.

 Permintaan proxy

Untuk mengetahui informasi selengkapnya tentang pesan, lihat Referensi fungsi template pesan.

messageid

Penampung untuk ID unik global untuk permintaan.

Tabel berikut menjelaskan properti variabel messageid:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
messageid String Hanya baca

Menyimpan ID unik global untuk permintaan, yang mencakup nama host load balancer. ID ini memungkinkan permintaan yang diterima di load balancer dilacak setelah dikirim ke pemroses pesan.

ID ini dicatat dalam log error Apigee untuk mengorelasikan messageid dengan error.

 Permintaan proxy

mint

Variabel pembantu yang memberikan informasi tentang monetisasi.

Tabel berikut menjelaskan properti variabel mint:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
mint.limitscheck.is_request_blocked Boolean Hanya baca

Flag yang menentukan apakah permintaan API diblokir. Disetel ke true jika is_subscription_found adalah false.

Variabel alur ini tersedia jika kebijakan MonetizationLimitsCheck dilampirkan ke proxy API. Lihat Variabel alur MonetizationLimitsChecks.

 Permintaan proxy
mint.limitscheck.is_subscription_found Boolean Hanya baca

Flag yang menentukan apakah developer memiliki langganan aktif ke produk API. Tetapkan ke true jika developer memiliki langganan.

Variabel alur ini tersedia jika kebijakan MonetizationLimitsCheck dilampirkan ke proxy API. Lihat Variabel alur MonetizationLimitsChecks.

 Permintaan proxy
mint.limitscheck.prepaid_developer_balance Angka Hanya baca

Saldo saat ini di e-wallet akun prabayar developer yang terkait dengan mata uang paket tarif.

 Permintaan proxy
mint.limitscheck.prepaid_developer_currency String Hanya baca

Mata uang saldo yang tersedia dalam variabel mint.limitscheck.prepaid_developer_balance.

 Permintaan proxy
mint.limitscheck.purchased_product_name String Hanya baca

Nama produk API terkait.

Variabel alur ini tersedia jika kebijakan MonetizationLimitsCheck dilampirkan ke proxy API. Lihat Variabel alur MonetizationLimitsChecks.

 Permintaan proxy
mint.limitscheck.status_message String Hanya baca

Informasi tambahan tentang eksekusi kebijakan MonetizationLimitsCheck untuk tujuan proses debug.

Variabel alur ini tersedia jika kebijakan MonetizationLimitsCheck dilampirkan ke proxy API. Lihat Variabel alur MonetizationLimitsChecks.

 Permintaan proxy
mint.mintng_consumption_pricing_rates String Hanya baca

Biaya berbasis konsumsi.

Tetapkan biaya saat membuat paket tarif.

 PostClientFlow
mint.mintng_consumption_pricing_type String Hanya baca

Jenis harga berdasarkan pemakaian. Contoh: FIXED_PER_UNIT

Tetapkan biaya berbasis penggunaan saat membuat paket tarif.

 PostClientFlow
mint.mintng_currency String Hanya baca

Mata uang untuk menghitung pendapatan.

Variabel alur ini memiliki nilai variabel monetisasi currency.

 Kebijakan DataCapture
mint.mintng_dev_share Angka Hanya baca

Pendapatan yang akan dibagikan kepada developer.

Tetapkan pendapatan yang akan dibagikan kepada developer saat membuat paket tarif.

 PostClientFlow
mint.mintng_is_apiproduct_monetized Boolean Hanya baca

Flag yang menentukan apakah produk API saat ini dimonetisasi (yaitu, jika ada paket tarif aktif yang berlaku).

Variabel alur ini ditambahkan oleh kebijakan VerifyAPIKey atau VerifyAccessToken yang dilampirkan ke proxy API. Lihat Menambahkan kebijakan autentikasi.

 Permintaan proxy
mint.mintng_price Angka Hanya baca

Pendapatan untuk menghitung bagian developer.

Variabel alur memiliki nilai variabel monetisasi revShareGrossPrice.

 Kebijakan DataCapture dan PostClientFlow
mint.mintng_price_multiplier Angka Hanya baca

Faktor (pengali) yang digunakan untuk mengalikan biaya per transaksi.

Variabel alur memiliki nilai variabel monetisasi perUnitPriceMultiplier.

 Kebijakan DataCapture dan PostClientFlow
mint.mintng_rate Angka Hanya baca

Tarif yang dikenakan untuk panggilan API.

Variabel alur ini menunjukkan biaya berbasis penggunaan per panggilan API. Tetapkan biaya berbasis penggunaan saat membuat paket tarif. Jika Anda telah mengonfigurasi perUnitPriceMultiplier variabel monetisasi dalam kebijakan DataCapture, Apigee menghitung biaya transaksi setelah mempertimbangkan nilai variabel perUnitPriceMultiplier. Untuk mengetahui informasi selengkapnya, lihat Api price multiplier di Metrik.

 PostClientFlow
mint.mintng_rate_before_multipliers Angka Hanya baca

Tarif yang dikenakan untuk panggilan API tanpa penghitungan perUnitPriceMultiplier.

Jika kebijakan DataCapture mengambil perUnitPriceMultiplier variabel monetisasi, variabel alur ini menunjukkan biaya transaksi sebelum mengalikan biaya dengan perUnitPriceMultiplier.

 PostClientFlow
mint.mintng_rate_plan_id String Hanya baca

ID paket tarif.

Variabel alur ini ditambahkan oleh kebijakan VerifyAPIKey atau VerifyAccessToken yang dilampirkan ke proxy API. Lihat Menambahkan kebijakan autentikasi.

 Permintaan proxy
mint.mintng_revenue_share_rates String Hanya baca

Rasio pembagian keuntungan.

Tetapkan rasio pembagian keuntungan saat membuat paket tarif.

 PostClientFlow
mint.mintng_revenue_share_type String Hanya baca

Jenis pembagian keuntungan. Contoh: FIXED

Tetapkan jenis pembagian keuntungan saat membuat paket tarif.

 PostClientFlow
mint.mintng_tx_success Boolean Hanya baca

Menentukan apakah transaksi dimonetisasi.

Variabel alur ini memiliki nilai variabel monetisasi transactionSuccess.

 Kebijakan DataCapture
mint.prepaid_updated_developer_usage Angka Hanya baca

Penggunaan saat ini oleh developer prabayar.

Penggunaan dihitung berdasarkan konfigurasi paket tarif dan nilai variabel monetisasi perUnitPriceMultiplier.

 PostClientFlow
mint.rateplan_end_time_ms Angka Hanya baca

Waktu habis masa berlaku paket tarif dalam milidetik sejak epoch.

Variabel alur ini ditambahkan oleh kebijakan VerifyAPIKey atau VerifyAccessToken yang dilampirkan ke proxy API. Lihat Menambahkan kebijakan autentikasi.

 Permintaan proxy
mint.rateplan_start_time_ms Angka Hanya baca

Waktu aktivasi paket tarif dalam milidetik sejak epoch.

Variabel alur ini ditambahkan oleh kebijakan VerifyAPIKey atau VerifyAccessToken yang dilampirkan ke proxy API. Lihat Menambahkan kebijakan autentikasi.

 Permintaan proxy
mint.status String Hanya baca

Status panggilan yang dimonetisasi. Diisi hanya jika terjadi error.

 PostClientFlow
mint.status_code Angka Hanya baca

Kode status HTTP panggilan yang dimonetisasi. Diisi hanya jika terjadi error.

 PostClientFlow
mint.subscription_end_time_ms Angka Hanya baca

Waktu habis masa berlaku untuk langganan produk API dalam milidetik sejak epoch.

Variabel alur ini tersedia jika kebijakan MonetizationLimitsCheck dilampirkan ke proxy API. Lihat Variabel alur MonetizationLimitsChecks.

 Permintaan proxy
mint.subscription_start_time_ms Angka Hanya baca

Waktu aktivasi untuk langganan produk API dalam milidetik sejak epoch.

Variabel alur ini tersedia jika kebijakan MonetizationLimitsCheck dilampirkan ke proxy API. Lihat Variabel alur MonetizationLimitsChecks.

 Permintaan proxy
mint.tx_success_result Boolean Hanya baca

Menunjukkan apakah monetisasi berhasil untuk transaksi.

Variabel mint.tx_success_result dapat memiliki nilai berikut:

  • tx_success ditetapkan ke benar (true): Variabel transactionSuccess adalah true, dan transaksi dimonetisasi. Karena transaksi dimonetisasi, nilai variabel mint.mintng_rate dan mint.mintng_dev_share dihitung.
  • tx_success ditetapkan ke salah (false): Variabel transactionSuccess adalah false, dan transaksi tidak dimonetisasi. Karena transaksi tidak dimonetisasi, nilai variabel mint.mintng_rate dan mint.mintng_dev_share tidak dihitung.
  • tx_success tidak ditemukan. Kode status pesan bukan 2xx: Variabel transactionSuccess tidak diambil dan kode status HTTP (message.status.code) transaksi bukan 2xx. Transaksi tidak dimonetisasi.
  • tx_success tidak ditemukan. Kode status pesan adalah 2xx: Variabel transactionSuccess tidak diambil dan kode status HTTP (message.status.code) transaksi adalah 2xx. Transaksi dimonetisasi.
 PostClientFlow

Untuk informasi selengkapnya, lihat referensi berikut:

organization

Container untuk properti organization.name.

Tabel berikut menjelaskan properti variabel organization:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
organization.name String Hanya baca

Nama organisasi.

 Permintaan proxy

Untuk mengetahui informasi selengkapnya tentang organisasi, lihat Memahami organisasi.

proxy

Konfigurasi proxy API.

Tabel berikut menjelaskan properti variabel proxy:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
proxy.basepath String Hanya baca

Nilai Jalur Dasar dalam konfigurasi endpoint proxy API Anda. Jalur dasar adalah fragmen URI paling kiri yang mengikuti host di URL. URI alur bersyarat mengikuti jalur dasar.

Misalkan Anda telah mengonfigurasi Endpoint Proxy API dengan basepath /v2/weatherapi. (Lihat konfigurasi Endpoint Proxy untuk mengetahui detailnya.) Dalam hal ini, jika permintaan masuk menggunakan URL https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, maka:

  • Nama hostnya adalah myhost.example.net. Anda dapat mengambilnya dengan membaca variabel request.header.host.
  • Jalur dasarnya adalah /v2/weatherapi. Ambil ini dengan membaca variabel proxy.basepath.
  • Akhiran jalur adalah /forecastrss. Ambil ini dengan membaca variabel proxy.pathsuffix.

Jika Anda menentukan Jalur Dasar dinamis dalam konfigurasi proxy API, seperti /v2/*/weatherapicode>, maka variabel proxy.basepath disetel ke jalur dinamis. Untuk mengambil URL sebenarnya untuk permintaan, baca dan parsing variabel proxy.url.

 Permintaan proxy
proxy.client.ip String Hanya baca

Alamat X-Forwarded-For panggilan masuk, yang merupakan alamat IP yang diterima Apigee dari handshake TCP eksternal terakhir. Hal ini dapat berupa klien yang memanggil atau load balancer.

 Permintaan proxy
proxy.name String Hanya baca

Atribut nama yang dikonfigurasi untuk ProxyEndpoint.

 Permintaan proxy
proxy.pathsuffix String Hanya baca

Nilai akhiran jalur di URL yang dikirim dari klien dan diterima di ProxyEndpoint.

Basepath adalah komponen jalur paling kiri yang secara unik mengidentifikasi proxy API dalam Grup Lingkungan. Misalkan Anda telah mengonfigurasi endpoint Proxy API dengan basepath /v2/weatherapi. Dalam hal ini, permintaan yang dikirim ke https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, variabel proxy.pathsuffix akan menyimpan string /forecastrss.

 Permintaan proxy
proxy.url String Hanya baca

Mendapatkan URL lengkap yang terkait dengan permintaan proxy yang diterima oleh ProxyEndpoint, termasuk parameter kueri yang ada.

 Permintaan proxy

Untuk mengetahui informasi selengkapnya tentang cara menggunakan proxy API, lihat Memahami API dan proxy API.

publishmessage

Diisi saat kebijakan PublishMessage dijalankan.

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
publishmessage.message.id String Hanya Baca Menampilkan messageId (ID pesan yang dipublikasikan) dari server Pub/Sub.

Apigee menetapkan variabel alur ini hanya jika permintaan publikasi berhasil.

 Permintaan proxy

ratelimit

Diisi saat kebijakan Quota atau SpikeArrest dijalankan.

Tabel berikut menjelaskan properti variabel ratelimit:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
ratelimit.policy_name.allowed.count Long Hanya Baca Menampilkan jumlah kuota yang diizinkan. PostClientFlow
ratelimit.policy_name.used.count Long Hanya Baca Menampilkan kuota saat ini yang digunakan dalam interval kuota. PostClientFlow
ratelimit.policy_name.available.count Long Hanya Baca Menampilkan jumlah kuota yang tersedia dalam interval kuota. PostClientFlow
ratelimit.policy_name.exceed.count Long Hanya Baca Menampilkan 1 setelah kuota terlampaui. PostClientFlow
ratelimit.policy_name.total.exceed.count Long Hanya Baca Menampilkan 1 setelah kuota terlampaui. PostClientFlow
ratelimit.policy_name.expiry.time Long Hanya Baca

Menampilkan waktu UTC (dalam milidetik), yang menentukan kapan kuota berakhir dan kapan interval kuota baru dimulai.

Jika jenis kebijakan Kuota adalah rollingwindow, nilai ini tidak valid karena interval kuota tidak pernah berakhir.

 PostClientFlow
ratelimit.policy_name.identifier String Hanya Baca Menampilkan referensi ID (klien) yang dilampirkan ke kebijakan PostClientFlow
ratelimit.policy_name.class String Hanya Baca Menampilkan class yang terkait dengan ID klien PostClientFlow
ratelimit.policy_name.class.allowed.count Long Hanya Baca Menampilkan jumlah kuota yang diizinkan yang ditentukan dalam class PostClientFlow
ratelimit.policy_name.class.used.count Long Hanya Baca Menampilkan kuota yang digunakan dalam kelas PostClientFlow
ratelimit.policy_name.class.available.count Long Hanya Baca Menampilkan jumlah kuota yang tersedia di class PostClientFlow
ratelimit.policy_name.class.exceed.count Long Hanya Baca Menampilkan jumlah permintaan yang melebihi batas di kelas dalam interval kuota saat ini PostClientFlow
ratelimit.policy_name.class.total.exceed.count Long Hanya Baca Menampilkan jumlah total permintaan yang melampaui batas di kelas di semua interval kuota, sehingga merupakan jumlah class.exceed.count untuk semua interval kuota. PostClientFlow
ratelimit.policy_name.failed Boolean Hanya Baca

Menunjukkan apakah kebijakan gagal atau tidak (benar atau salah).

 PostClientFlow

Untuk informasi selengkapnya, lihat referensi berikut:

request

Permintaan lengkap, termasuk payload yang ada.

Untuk mengetahui informasi selengkapnya tentang data permintaan, lihat Bagaimana data permintaan diteruskan ke server backend?

Tabel berikut menjelaskan properti variabel request:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
request message Hanya baca

Permintaan lengkap, termasuk payload yang ada.

 Permintaan proxy
request.content String Baca/Tulis

Mendapatkan atau menetapkan payload pesan permintaan.

 Permintaan proxy
request.content.as.base64 String Hanya baca

Konten payload berenkode base64 dari pesan permintaan.

 Permintaan proxy
request.content.as.url.safe.base64 String Hanya baca

Konten payload berenkode base64 yang aman untuk URL dari pesan permintaan.

 Permintaan proxy
request.formparam.param_name String Baca/Tulis

Mendapatkan atau menetapkan nilai parameter formulir yang ditentukan dalam permintaan yang dikirim dari aplikasi klien.

 Permintaan proxy
request.formparam.param_name.
 values		 Koleksi Hanya baca

Semua nilai parameter formulir tertentu dalam permintaan, diformat sebagai daftar yang dipisahkan koma.

Misalnya, jika payloadnya adalah a=hello&x=greeting&a=world, maka nilai request.formparam.a.values adalah ['hello', 'world'].

 Permintaan proxy
request.formparam.param_name.
 values.count		 Bilangan bulat Hanya baca

Jumlah semua nilai untuk parameter formulir tertentu yang terkait dengan permintaan.

 Permintaan proxy
request.formparam.param_name.N String Baca/Tulis

Nilai parameter formulir tertentu Nth dalam pesan. Misalnya, jika string formulir adalah a=hello&a=world, maka nilai yang ditampilkan dari request.formparam.a.1 adalah hello.

 Permintaan proxy
request.formparams.count Bilangan bulat Hanya baca

Jumlah semua parameter yang terkait dengan permintaan yang dikirim dari aplikasi klien.

 Permintaan proxy
request.formparams.names Koleksi Hanya baca

Daftar semua nama parameter yang terkait dengan permintaan.

 Permintaan proxy
request.formparams.names.string String Hanya baca

Daftar yang dipisahkan koma dari semua nama parameter formulir yang terkait dengan permintaan.

 Permintaan proxy
request.formstring String Hanya baca

formparam lengkap dalam permintaan yang dikirim dari aplikasi klien.

Misalnya, name=test&type=first&group=A.

 Permintaan proxy
request.grpc.rpc.name String Hanya baca

Hanya berlaku saat menggunakan server target gRPC. Nama RPC. Untuk mengetahui informasi tentang proxy gRPC, lihat Membuat proxy API gRPC.

Permintaan proxy
request.grpc.service.name String Hanya baca

Hanya berlaku saat menggunakan server target gRPC. Nama layanan status gRPC. Untuk mengetahui informasi tentang proxy gRPC, lihat Membuat proxy API gRPC.

Permintaan proxy
request.header.header_name String Baca/Tulis

Mendapatkan atau menetapkan nilai header tertentu yang ditemukan dalam permintaan. Jika header berisi koma, saat dibaca, Anda hanya akan menerima segmen teks hingga koma pertama.

Misalnya, jika header Cache-control adalah public, maxage=16544, maka nilai yang ditampilkan dari request.header.cache-control adalah public.

Jika Anda menginginkan seluruh header sebagai string, gunakan variabel seperti request.header.header_name.values.string.

 Permintaan proxy
request.header.header_name.N String Baca/Tulis

Nilai header tertentu Nth dalam permintaan. Apigee memisahkan nilai teks header dengan koma. Indeks dimulai dari 1 untuk nilai paling kiri.

Misalnya, jika header Cache-control adalah public, maxage=16544, maka nilai yang ditampilkan dari request.header.cache-control.2 adalah maxage=16544.

 Permintaan proxy
request.header.header_name.
 values		 Koleksi Hanya baca

Semua nilai header tertentu dalam permintaan.

 Permintaan proxy
request.header.header_name.
 values.count		 Bilangan bulat Hanya baca

Jumlah semua nilai header tertentu dalam permintaan.

 Permintaan proxy
request.header.header_name.
 values.string		 String Hanya baca

Semua nilai header tertentu dalam permintaan, dalam bentuk satu string.

Misalnya, jika header Cache-control adalah public, maxage=16544, maka nilai yang ditampilkan dari request.header.cache-control.values.string adalah public, maxage=16544.

 Permintaan proxy
request.headers.count Bilangan bulat Hanya baca

Jumlah semua header dalam permintaan.

 Permintaan proxy
request.headers.names Koleksi Hanya baca

Nama semua header dalam permintaan.

 Permintaan proxy
request.headers.names.string String Hanya baca

Daftar nama semua header dalam permintaan yang dipisahkan koma.

 Permintaan proxy
request.path String Hanya baca

Jalur resource yang tidak di-proxy (tidak termasuk host) ke layanan backend, tidak termasuk parameter kueri.

Misalnya, jika URI ke layanan backend adalah https://example.com/rest/api/latest, maka nilai request.path adalah /rest/api/latest.

 Permintaan proxy
request.queryparam.param_name String Baca/Tulis

Nilai parameter kueri tertentu yang ditemukan dalam permintaan.

 Permintaan proxy
request.queryparam.param_name.N String Baca/Tulis

Nilai parameter kueri Nth dalam permintaan.

Misalnya, jika request.querystring adalah a=hello&a=world, maka nilai yang ditampilkan dari request.queryparam.a.1 adalah hello.

Sebagai contoh penulisan beberapa nilai untuk satu nama parameter kueri, seperti type=siteid:1&type=language:us-en&type=currency:USD, tetapkan berikut ini:

  • request.queryparam.type.1 ke siteid:1
  • request.queryparam.type.2 ke language:en-us
  • request.queryparam.type.3 ke currency:USD
 Permintaan proxy
request.queryparam.param_name.
 values		 Koleksi Hanya baca

Semua nilai parameter kueri tertentu dalam permintaan, diformat sebagai daftar yang dipisahkan koma.

Misalnya, jika request.querystring adalah a=hello&b=lovely&a=world, maka nilai request.queryparam.a.values adalah ['hello', 'world'].

 Permintaan proxy
request.queryparam.param_name.
 values.count		 Bilangan bulat Hanya baca

Jumlah semua nilai parameter kueri tertentu dalam permintaan.

 Permintaan proxy
request.queryparams.count Bilangan bulat Hanya baca

Jumlah semua parameter kueri dalam permintaan.

 Permintaan proxy
request.queryparams.names Koleksi Hanya baca

Nama semua parameter kueri dalam permintaan.

 Permintaan proxy
request.queryparams.names.string String Hanya baca

Daftar yang dipisahkan koma berisi nama semua parameter kueri dalam permintaan.

 Permintaan proxy
request.querystring String Hanya baca

Daftar lengkap parameter kueri dalam permintaan yang dikirim dari aplikasi klien.

Misalnya, jika permintaannya adalah http://host.com/123?name=first&surname=second&place=address, maka variabel ini akan menampilkan name=first&surname=second&place=address.

 Permintaan proxy
request.transportid String Hanya baca

ID permintaan sebagai jenis TransportMessage yang bersifat kontekstual.

 Permintaan proxy
request.transport.message Transport-Message Hanya baca

Permintaan jenis TransportMessage yang bersifat kontekstual.

 Permintaan proxy
request.uri String Hanya baca

Dalam proxy API, proxy <BasePath> di ProxyEndpoint (selain URL dasar proxy) dipetakan ke URL layanan target di TargetEndpoint. Contoh:

<ProxyEndpoint>
...
  <BasePath>/my-mock-proxy</BasePath>

Mengarah ke

<TargetEndpoint>
...
  <HTTPTargetConnection>
    http://mocktarget.apigee.net
  </HTTPTargetConnection>

Dalam permintaan, request.uri adalah jalur dasar proxy + sisa alamat, termasuk parameter kueri.

Dalam respons, request.uri adalah sisa alamat, termasuk parameter kueri, setelah HTTPTargetConnection.

Perbedaannya adalah karena permintaan asli masuk ke proxy, tetapi kemudian proxy membuat permintaan lain ke layanan target.

Misalnya, panggilan berikut dilakukan ke proxy contoh kita, yang memiliki jalur dasar /my-mock-proxy:

http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude

Dan panggilan proxy:

http://mocktarget.apigee.net

Yang menambahkan /user?user=Dude ke URL tersebut.

  • Permintaan: request.uri = /my-mock-proxy/user?user=Dude
  • Respons: request.uri = /user?user=Dude
 Permintaan proxy (berbeda dalam respons)
request.url String Hanya baca

URL lengkap permintaan yang dibuat ke endpoint target, termasuk parameter string kueri, tetapi tidak termasuk nomor port (jika ditentukan).

Misalnya, jika Anda melakukan panggilan ke proxy sampel http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude, dan endpoint target adalah http://example.com:8080, maka nilainya adalah:

  • Permintaan: t/a
  • Respons: http://example.com/user?user=Dude
 Respons target
request.verb String Hanya baca

Kata kerja HTTP yang digunakan untuk permintaan. Misalnya, GET, PUT, dan DELETE.

 Permintaan proxy
request.version String Hanya baca

Versi HTTP permintaan. Misalnya, 1.1.

 Permintaan proxy

response

Respons lengkap, termasuk payload yang ada.

Tabel berikut menjelaskan properti variabel response:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
response message Baca/Tulis

Pesan respons lengkap yang ditampilkan oleh target.

 Respons target
response.content String Baca/Tulis

Konten payload pesan respons yang ditampilkan oleh target.

 Respons target
response.content.as.base64 String Hanya baca

Konten payload berenkode base64 dari pesan respons.

 Respons target
response.content.as.url.safe.base64 String Hanya baca

Konten payload berenkode base64 yang aman untuk URL dari pesan respons.

 Respons target
response.event.current.content String Baca/Tulis

Konten yang ditampilkan dalam respons streaming EventFlow. Lihat Streaming peristiwa yang dikirim server untuk mengetahui informasi selengkapnya.

 Respons EventFlow
response.event.current.count Bilangan bulat Baca

Menghitung jumlah peristiwa respons yang dikirim secara inkremental. Nilai ini diperbarui untuk setiap peristiwa yang diterima. Lihat Streaming peristiwa yang dikirim server untuk mengetahui informasi selengkapnya.

. 		Respons EventFlow
response.header.header_name String Baca/Tulis

Mendapatkan atau menetapkan nilai header HTTP tertentu dalam respons.

Jika teks header menyertakan koma, Apigee menyimpulkan beberapa nilai. Dalam hal ini, response.header.header_name hanya menampilkan nilai pertama.

Misalnya, jika header Cache-control adalah public,maxage=16544, maka nilai yang ditampilkan dari response.header.cache-control adalah public.

Jika Anda menginginkan seluruh header sebagai string, gunakan variabel seperti response.header.header_name.values.string.

 Respons target
response.header.header_name.
 values		 Koleksi Hanya baca

Semua nilai header HTTP tertentu dalam respons.

 Respons target
response.header.header_name.
 values.count		 Bilangan bulat Hanya baca

Jumlah semua nilai header HTTP yang ditentukan dalam respons.

 Respons target
response.header.header_name.
 values.string		 String Hanya baca

Semua nilai header tertentu dalam respons, dalam bentuk satu string.

Misalnya, jika header Cache-control adalah public,maxage=16544, maka nilai yang ditampilkan dari response.header.cache-control.values.string adalah public,maxage=16544.

 Respons target
response.header.header_name.N String Baca/Tulis

Nilai header tertentu Nth dalam respons. Apigee memisahkan nilai teks header dengan koma. Indeks dimulai dari 1 untuk nilai paling kiri.

Misalnya, jika header Cache-control adalah public,maxage=16544, maka response.header.cache-control.2 akan menampilkan maxage=16544.

 Respons target
response.headers.count Bilangan bulat Hanya baca

Jumlah semua header dalam respons.

 Respons target
response.headers.names Koleksi Hanya baca

Nama semua header dalam respons.

 Respons target
response.headers.names.string String Hanya baca

Daftar yang dipisahkan koma berisi nama semua header dalam respons.

 Respons target
response.status.code Bilangan bulat Baca/Tulis

Kode respons yang ditampilkan untuk permintaan. Anda dapat menggunakan variabel ini untuk mengganti kode status respons, yang disimpan di message.status.code. Untuk mengetahui informasi selengkapnya, lihat message.

 Respons target
response.transport.message String Hanya baca

Respons jenis TransportMessage yang merupakan objek kontekstual.

 Respons target

route

Menentukan nama <RouteRule> dan TargetEndpoint.

Tabel berikut menjelaskan properti variabel route:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
route.name String Hanya baca

Nama <RouteRule> yang dijalankan di ProxyEndpoint. Misalnya, default. RouteRule mereferensikan TargetEndpoint proxy API untuk dieksekusi.

 Permintaan target
route.target String Hanya baca

Nama TargetEndpoint yang dieksekusi. Misalnya, default.

 Permintaan target

servicecallout

Menjelaskan TargetEndpoint untuk kebijakan ServiceCallout.

Tabel berikut menjelaskan properti variabel servicecallout:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
servicecallout.policy_name.expectedcn String Baca/Tulis

Nama Umum TargetEndpoint yang diharapkan seperti yang dirujuk dalam kebijakan ServiceCallout. Ini hanya bermakna jika TargetEndpoint merujuk ke endpoint TLS/SSL.

 Permintaan proxy
servicecallout.policy_name.target.url String Baca/Tulis

URL TargetEndpoint untuk kebijakan ServiceCallout tertentu.

 Permintaan proxy
servicecallout.requesturi String Baca/Tulis

URI TargetEndpoint untuk kebijakan ServiceCallout. URI adalah URL TargetEndpoint tanpa spesifikasi protokol dan domain.

 Permintaan proxy

system

Menentukan alamat IP sistem, serta detail tentang proxy.

Tabel berikut menjelaskan properti variabel system:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
system.interface.interface_name String Hanya baca

Alamat IP sistem.

 Permintaan proxy
system.pod.name String Hanya baca

Nama pod tempat proxy berjalan.

 Permintaan proxy
system.region.name String Hanya baca

Nama pusat data region tempat proxy berjalan.

 Permintaan proxy
system.time String Hanya baca

Waktu saat variabel ini dibaca. Misalnya, Wed, 21 Aug 2013 19:16:47 GMT.

Nilai ini adalah representasi string dari nilai system.timestamp yang sesuai. Misalnya, Wed, 21 Aug 2013 19:16:47 GMT sesuai dengan nilai stempel waktu 1377112607413.

 Permintaan proxy
system.time.year Bilangan bulat Hanya baca

Bagian tahun system.time.

 Permintaan proxy
system.time.month Bilangan bulat Hanya baca

Bagian bulan dari system.time.

 Permintaan proxy
system.time.day Bilangan bulat Hanya baca

Bagian hari dalam bulan dari system.time.

 Permintaan proxy
system.time.dayofweek Bilangan bulat Hanya baca

Bagian hari dalam seminggu dari system.time.

 Permintaan proxy
system.time.hour Bilangan bulat Hanya baca

Bagian jam dari system.time.

 Permintaan proxy
system.time.minute Bilangan bulat Hanya baca

Bagian menit dari system.time.

 Permintaan proxy
system.time.second Bilangan bulat Hanya baca

Bagian kedua dari system.time.

 Permintaan proxy
system.time.millisecond Bilangan bulat Hanya baca

Bagian milidetik dari system.time.

 Permintaan proxy
system.time.zone String Hanya baca

Zona waktu sistem.

 Permintaan proxy
system.timestamp Long Hanya baca

Bilangan bulat 64-bit (long) yang merepresentasikan waktu saat variabel ini dibaca. Nilainya adalah jumlah milidetik yang berlalu sejak tengah malam, pada 1 Januari 1970 UTC. Misalnya, 1534783015000.

 Permintaan proxy
system.uuid String Hanya baca

UUID pemroses pesan yang menangani proxy.

 Permintaan proxy

target

Menjelaskan target permintaan.

Tabel berikut menjelaskan properti variabel target:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
target.basepath String Hanya baca

Jalur resource (tidak termasuk domain) ke layanan target, tidak termasuk parameter kueri, yang ditentukan di TargetEndpoint proxy.

Misalnya, proxy API memanggil target berikut:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
  </HTTPTargetConnection>

Dalam contoh ini, target.basepath adalah /user.

Jika targetnya adalah ini:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>

target.basepath akan berupa null.

 Permintaan target
target.copy.pathsuffix Boolean Baca/Tulis

Jika true, permintaan yang diteruskan dari ProxyEndpoint ke TargetEndpoint mempertahankan akhiran jalur (fragmen jalur URI yang mengikuti URI yang ditentukan di jalur dasar ProxyEndpoint).

 Permintaan target
target.copy.queryparams Boolean Baca/Tulis

Jika true, permintaan yang diteruskan dari ProxyEndpoint ke TargetEndpoint akan mempertahankan parameter kueri.

 Permintaan target
target.country String Hanya baca

Negara sertifikat TLS/SSL yang diberikan oleh server target

 Respons target
target.cn String Hanya baca

Nama Umum TargetEndpoint. Ini hanya bermakna jika TargetEndpoint merujuk ke endpoint TLS/SSL.

 Permintaan target
target.email.address String Hanya baca

Alamat email sertifikat TLS/SSL yang diberikan oleh server target

 Respons target
target.expectedcn String Baca/Tulis

Nama Umum TargetEndpoint yang diharapkan. Ini hanya berguna jika TargetEndpoint merujuk ke endpoint TLS/SSL.

 Permintaan proxy
target.header.host String Baca/Tulis

Variabel alur yang digunakan oleh Apigee untuk menetapkan nilai header Host untuk permintaan keluar ke target. Digunakan untuk menetapkan nilai ke nama host dalam situasi saat alamat IP digunakan di URL Target atau Server Target, seperti yang akan terjadi dengan target berbasis Endpoint PSC.

 Permintaan target
target.host String Hanya baca

Nama domain layanan target yang menampilkan respons ke proxy API.

 Respons target
target.ip String Hanya baca

Alamat IP layanan target yang menampilkan respons ke proxy API.

 Respons target
target.locality String Hanya baca

Lokalitas (kota) sertifikat TLS/SSL yang diberikan oleh server target

 Respons target
target.name String Hanya baca

Target yang menerima pesan dari targetendpoint.

 Permintaan target
target.organization String Hanya baca

Organisasi sertifikat TLS/SSL yang diberikan oleh server target.

 Respons target
target.organization.unit String Hanya baca

Unit organisasi sertifikat TLS/SSL yang diberikan oleh server target.

 Respons target
target.port Bilangan bulat Hanya baca

Nomor port layanan target yang menampilkan respons ke proxy API.

 Respons target
target.received.end.time String Hanya baca

Waktu, yang dinyatakan dalam bentuk string, saat TargetEndpoint selesai menerima respons dari target. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC.

Nilai waktu ini adalah representasi string dari jumlah stempel waktu 32-bit yang sesuai. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC sesuai dengan nilai stempel waktu 1377112607413.

 Respons target
target.received.end.
  timestamp		 Long Hanya baca

Nilai stempel waktu yang menentukan kapan TargetEndpoint selesai menerima respons dari target. Misalnya, 1534783015000. Nilai ini adalah bilangan bulat 64-bit (panjang) yang menentukan jumlah milidetik yang telah berlalu sejak tengah malam, pada 1 Januari 1970 UTC.

 Respons target
target.received.start.time String Hanya baca

Waktu, yang dinyatakan dalam bentuk string, saat TargetEndpoint mulai menerima respons dari target. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC.

Nilai waktu ini adalah representasi string dari jumlah stempel waktu 32-bit yang sesuai. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC sesuai dengan nilai stempel waktu 1377112607413.

 Respons target
target.received.start.
  timestamp		 Long Hanya baca

Nilai stempel waktu yang menentukan kapan TargetEndpoint mulai menerima respons dari target. Misalnya, 1534783015000. Nilai ini adalah bilangan bulat 64-bit (panjang) yang menentukan jumlah milidetik yang telah berlalu sejak tengah malam, pada 1 Januari 1970 UTC.

 Respons target
target.scheme String Hanya baca

Awal cakupan: Respons target
Jenis: String
Izin: Baca/Tulis

Menampilkan http atau https, bergantung pada pesan permintaan.

 Permintaan target
target.sent.end.time String Hanya baca

Waktu, yang dinyatakan dalam bentuk string, saat proxy berhenti mengirim permintaan ke URL yang ditentukan di TargetEndpoint. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC.

Nilai waktu ini adalah representasi string dari jumlah stempel waktu 32-bit yang sesuai. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC sesuai dengan nilai stempel waktu 1377112607413.

 Permintaan target
target.sent.end.timestamp Long Hanya baca

Nilai stempel waktu yang menentukan kapan proxy selesai mengirim permintaan ke URL yang ditentukan di TargetEndpoint. Misalnya, 1377112607413. Nilai ini adalah bilangan bulat (long) 64-bit yang berisi jumlah milidetik yang telah berlalu sejak tengah malam, pada 1 Januari, 1970 UTC.

 Permintaan target
target.sent.start.time String Hanya baca

Waktu, yang dinyatakan dalam bentuk string, saat proxy mulai mengirim permintaan ke URL yang ditentukan di TargetEndpoint. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC.

Nilai waktu ini adalah representasi string dari jumlah stempel waktu 32-bit yang sesuai. Misalnya, Wed, 21 Aug 2013 19:16:47 UTC sesuai dengan nilai stempel waktu 1377112607413.

 Permintaan target
target.sent.start.timestamp Long Hanya baca

Nilai stempel waktu yang menentukan kapan proxy mulai mengirim permintaan ke URL yang ditentukan di TargetEndpoint. Misalnya, 1534783015000. Nilai ini adalah bilangan bulat (long) 64-bit yang menentukan jumlah milidetik yang telah berlalu sejak tengah malam, pada 1 Januari 1970 UTC.

 Permintaan target
target.ssl.enabled Boolean Hanya baca

Apakah TargetEndpoint berjalan di TLS/SSL.

 Permintaan proxy
target.state String Hanya baca

Status sertifikat TLS/SSL yang diberikan oleh server target.

 Respons target
target.url String Baca/Tulis

URL yang dikonfigurasi dalam file XML TargetEndpoint atau URL target dinamis (jika target.url ditetapkan selama alur pesan). Variabel tidak menyertakan elemen jalur atau parameter kueri tambahan. Menampilkan null jika dipanggil di luar cakupan atau tidak disetel.

 Permintaan target

variable

Container untuk properti variable.expectedcn.

Tabel berikut menjelaskan properti variabel variable:

Properti Jenis Baca/Tulis Deskripsi Cakupan dimulai
variable.expectedcn String Baca/Tulis

Variabel yang diekspos untuk nama umum jika berjalan di TLS/SSL.

 Permintaan proxy

Untuk mengetahui informasi selengkapnya tentang cara menggunakan TLS, lihat Opsi untuk mengonfigurasi TLS.