Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi
Apigee X. info
Bagian ini memberikan informasi referensi tentang variabel alur.
Apigee Edge menentukan variabel alur berikut:
apigee
loadbalancing
route
apiproxy
message
router
application
messageid
servicecallout
client
organization
system
current
proxy
target
environment
ratelimit
variable
error
request
virtualhost
is
response
Setiap variabel ini dijelaskan di bagian berikut.
apigee
Variabel bantuan 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 |
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 |
Untuk mengetahui informasi selengkapnya tentang cara menggunakan proxy API, lihat Memahami API dan proxy API.
application
Penampung untuk properti application.basepath
.
Tabel berikut menjelaskan properti variabel application
:
Properti | Jenis | Baca/Tulis | Deskripsi | Cakupan dimulai |
---|---|---|---|---|
application.basepath |
String | Hanya baca | Jalur dasar deployment (ditentukan selama deployment API). | Permintaan proxy |
client
Aplikasi atau sistem yang mengirim permintaan ke router Edge.
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 ditampilkan oleh aplikasi klien. |
Permintaan proxy |
client.country |
String | Hanya baca |
Negara di sertifikat TLS/SSL yang ditampilkan oleh aplikasi klien. |
Permintaan proxy |
client.email.address |
String | Hanya baca |
Alamat email di sertifikat TLS/SSL yang ditampilkan 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 router Edge. Misalnya, ini dapat berupa IP klien asli atau IP load balancer. |
Permintaan proxy |
client.locality |
String | Hanya baca |
Lokalitas (Kota) dalam sertifikat TLS/SSL yang ditampilkan oleh klien. |
Permintaan proxy |
client.organization |
String | Hanya baca | Organisasi dalam sertifikat TLS/SSL yang ditampilkan oleh klien. (Tidak selalu setara dengan organisasi di Apigee Edge.) | Permintaan proxy |
client.organization.unit |
String | Hanya baca |
Unit organisasi dalam sertifikat TLS/SSL yang ditampilkan 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: Rabu, 21 Agustus 2013 19.16.47 UTC. Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, 'Rabu, 21 Agustus 2013 19.16.47 UTC' sesuai dengan nilai stempel waktu 1377112607413. |
Permintaan proxy |
client.received.end.timestamp |
Panjang | Hanya baca |
Nilai stempel waktu yang menentukan kapan proxy selesai menerima permintaan dari klien asal di ProxyEndpoint. Nilai ini adalah bilangan bulat 64-bit (long) 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: Rabu, 21 Agustus 2013 19.16.47 UTC Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, 'Rabu, 21 Agustus 2013 19.16.47 UTC' sesuai dengan nilai stempel waktu 1377112607413. |
Permintaan proxy |
client.received.start.timestamp |
Panjang | Hanya baca |
Nilai stempel waktu yang menentukan kapan proxy mulai menerima permintaan dari klien asal di ProxyEndpoint. Nilai ini adalah bilangan bulat 64-bit (long) yang berisi jumlah milidetik yang telah berlalu sejak tengah malam, pada 1 Januari 1970 UTC. |
Permintaan proxy |
client.scheme |
String | Hanya baca |
Menampilkan http atau https bergantung pada transpor 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: "Rabu, 21 Agustus 2013 19.16.47 UTC". Nilai ini adalah representasi string dari |
PostClientFlow |
client.sent.end.timestamp |
Panjang | Hanya baca | Nilai stempel waktu yang menentukan kapan ProxyEndpoint selesai menampilkan respons ke aplikasi klien asal. Nilai ini adalah bilangan bulat 64-bit (panjang) yang berisi jumlah milidetik yang telah 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, "Rabu, 21 Agustus 2013 19.16.47 UTC".
Nilai ini adalah representasi string dari |
PostClientFlow |
client.sent.start.timestamp |
Panjang | Hanya baca | Saat proxy mulai mengirim respons ke klien dari ProxyEndpoint. Nilai ini dinyatakan sebagai bilangan bulat 64-bit (long) 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 dalam 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 saat ini dieksekusi (seperti "PreFlow", "PostFlow", atau nama alur kondisional). | 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 Rekaman Aktivitas UI Edge. Namun, properti ini tidak terlihat secara default di tampilan Rekaman Aktivitas UI Klasik.
environment
Penampung 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 mewakili 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 Alur error dieksekusi. |
Error |
error.status.code |
Bilangan Bulat | Hanya baca |
Kode status HTTP yang terkait dengan error. Misalnya, "400". |
Error |
error.reason.phrase |
String | Hanya baca |
Frasa alasan yang terkait dengan error. Misalnya: "Bad Request". |
Error |
error.transport.message |
TransportMessage | Hanya baca |
Error apa pun dari jenis TransportMessage. |
Error |
error.state |
Bilangan Bulat | Hanya baca |
Status dalam Flow tempat error terjadi. |
Error |
error.header.header_name |
String | Baca/Tulis |
Mendapatkan atau menetapkan header respons. |
Error |
fault
Variabel alur yang ditetapkan ke kode error runtime saat kebijakan menampilkan error. Nilai kode error bersifat spesifik untuk setiap kebijakan.
Properti | Jenis | Baca/Tulis | Deskripsi | Cakupan dimulai |
---|---|---|---|---|
fault.fault_name |
String | Hanya baca | fault_name adalah nama error, seperti yang dijelaskan dalam tabel Error runtime yang disertakan dalam setiap topik referensi kebijakan. | Error |
is
Penampung 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. Tetapkan hanya jika elemen |
Respons target |
message
Objek kontekstual, dengan nilai yang sama seperti request
dalam alur permintaan
atau sebagai response
dalam alur respons atau sebagai 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 |
Permintaan proxy |
message.content |
String | Baca/Tulis |
Konten 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. |
Koleksi | Hanya baca |
Semua nilai parameter formulir yang ditentukan dalam pesan. |
Permintaan proxy |
message.formparam.param_name. |
Bilangan Bulat | Hanya baca |
Jumlah nilai parameter formulir yang ditentukan dalam pesan./p> |
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.formstring |
String | Hanya baca |
Nilai string formulir dalam pesan. |
Permintaan proxy |
message.header.header_name |
String | Baca/Tulis |
Mendapatkan atau menetapkan nilai header HTTP yang ditentukan dalam pesan. Jika header
berisi koma, setelah dibaca, Anda hanya akan menerima segmen teks hingga koma
pertama. Jika Anda menginginkan seluruh header, gunakan formulir
|
Permintaan proxy |
message.header.header_name.N |
String | Baca/Tulis |
Nilai header tertentu Ke-N dalam pesan, baik permintaan maupun respons, bergantung pada status alur. Apigee Edge memisahkan nilai teks header dengan koma. Perhatikan bahwa indeks yang nilainya digunakan untuk N berbasis 1, bukan berbasis 0. Misalnya: jika header |
Permintaan proxy |
message.header.header_name. |
Koleksi | Hanya baca |
Semua nilai nama header HTTP yang ditentukan dalam pesan. |
Permintaan proxy |
message.header.header_name. |
Bilangan Bulat | Hanya baca |
Jumlah nilai nama header HTTP yang ditentukan dalam pesan. |
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.path |
String | Baca/Tulis |
Jalur pesan permintaan lengkap di URL, tidak termasuk parameter kueri apa pun. |
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 Ke-n dalam pesan. Misalnya, jika
Sebagai contoh penulisan beberapa nilai untuk satu nama parameter kueri, seperti "type=siteid:1&type=language:us-en&type=currency:USD", tetapkan hal berikut:
|
Permintaan proxy |
message.queryparam.param_name. |
Koleksi | Hanya baca |
Semua nilai parameter kueri tertentu dalam pesan, yang diformat sebagai daftar yang dipisahkan koma. Misalnya, jika string kueri adalah |
Permintaan proxy |
message.queryparam.param_name. |
Bilangan Bulat | Hanya baca |
Jumlah total parameter kueri yang ditentukan 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. Untuk melakukan iterasi pada nama parameter kueri menggunakan JavaScript, lihat postingan Komunitas Apigee berikut: Bagaimana cara melakukan iterasi Koleksi dari "request.queryparams.names" di JS? di Komunitas Apigee. |
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 |
Permintaan proxy |
message.reason.phrase |
String | Hanya baca |
ReasonPhrase pesan respons dari target. |
Respons target |
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 (mengikuti URL domain) termasuk parameter kueri. Misalnya, untuk permintaan "http://api.apifactory.com/inventors?name=nikola&surname=tesla", variabel ini akan menampilkan "inventors?name=nikola&surname=tesla". |
Permintaan proxy |
message.verb |
String | Hanya baca |
Kata kerja HTTP ( |
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 secara global untuk permintaan, yang mencakup nama host router. ID ini memungkinkan permintaan yang diterima di router dilacak setelah dikirim ke pemroses pesan. ID ini dicatat dalam log error Edge untuk mengaitkan |
Permintaan proxy |
organization
Penampung 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 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 proxy API Anda. Jalur dasar adalah fragmen URI yang mengikuti host di URL. URI alur kondisional mengikuti jalur dasar. Di URL "http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282":
Satu-satunya cara untuk mengetahuinya adalah dengan melihat definisi proxy API atau memeriksa nilai variabel proxy.basepath. Akhiran jalur proxy mengikuti jalur dasar ("/forecastrss"), beserta parameter kueri apa pun. Jika Anda menentukan Jalur Dasar dinamis dalam konfigurasi proxy API, seperti "/v2/*/weatherapi", variabel ini akan ditetapkan ke jalur dinamis ("/v2/*/weatherapi"), meskipun jalur dasar me-resolve ke nilai statis, seperti "/v2/foo/weatherapi". |
Permintaan proxy |
proxy.client.ip |
String | Hanya baca |
Alamat |
Permintaan proxy |
proxy.name |
String | Hanya baca |
Atribut nama yang dikonfigurasi untuk ProxyEndpoint. |
Permintaan proxy |
proxy.pathsuffix |
String | Hanya baca |
Nilai akhiran jalur dasar proxy API yang dikirim dari klien dan diterima di ProxyEndpoint. Jalur dasar ditentukan sebagai komponen jalur yang secara unik mengidentifikasi proxy API. URL yang ditampilkan ke publik dari proxy API terdiri dari nama organisasi Anda, lingkungan tempat proxy di-deploy, jalur dasar, akhiran jalur dasar, dan parameter kueri apa pun. Misalnya, dalam permintaan ke |
Permintaan proxy |
proxy.url |
String | Hanya baca |
Mendapatkan URL lengkap yang terkait dengan permintaan proxy yang diterima oleh ProxyEndpoint,
termasuk parameter kueri yang ada.
Host URL akan selalu berupa Untuk contoh yang membuat URL |
Permintaan proxy |
Untuk mengetahui informasi selengkapnya tentang cara menggunakan proxy API, lihat Memahami API dan proxy API.
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 | Panjang | Hanya baca | Menampilkan jumlah kuota yang diizinkan. | PostClientFlow |
ratelimit.policy_name.used.count | Panjang | Hanya baca | Menampilkan kuota saat ini yang digunakan dalam interval kuota. | PostClientFlow |
ratelimit.policy_name.available.count | Panjang | Hanya baca | Menampilkan jumlah kuota yang tersedia dalam interval kuota. | PostClientFlow |
ratelimit.policy_name.exceed.count | Panjang | Hanya baca | Menampilkan 1 setelah kuota terlampaui. | PostClientFlow |
ratelimit.policy_name.total.exceed.count | Panjang | Hanya baca | Menampilkan 1 setelah kuota terlampaui. | PostClientFlow |
ratelimit.policy_name.expiry.time | Panjang | Hanya baca |
Menampilkan waktu UTC (dalam milidetik), yang menentukan kapan kuota berakhir dan kapan interval kuota baru dimulai. Jika jenis kebijakan Kuota adalah |
PostClientFlow |
ratelimit.policy_name.identifier | String | Hanya baca | Menampilkan referensi ID (klien) yang dilampirkan ke kebijakan | PostClientFlow |
ratelimit.policy_name.class.allowed.count | Panjang | Hanya baca | Menampilkan jumlah kuota yang diizinkan yang ditentukan dalam class | PostClientFlow |
ratelimit.policy_name.class.used.count | Panjang | Hanya baca | Menampilkan kuota yang digunakan dalam class | PostClientFlow |
ratelimit.policy_name.class.available.count | Panjang | Hanya baca | Menampilkan jumlah kuota yang tersedia di class | PostClientFlow |
ratelimit.policy_name.class.exceed.count | Panjang | Hanya baca | Menampilkan jumlah permintaan yang melebihi batas di class dalam interval kuota saat ini | PostClientFlow |
ratelimit.policy_name.class.total.exceed.count | Panjang | Hanya baca | Menampilkan jumlah total permintaan yang melebihi batas di class 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:
- Pembatasan kapasitas
- Membandingkan kebijakan Quota dan SpikeArrest
- Kebijakan kuota
- Kebijakan SpikeArrest
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.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. |
Koleksi | Hanya baca |
Semua nilai parameter formulir tertentu dalam permintaan, yang diformat sebagai daftar yang dipisahkan koma. Misalnya, jika payload-nya adalah
"a=hello&x=greeting&a=world", nilai
|
Permintaan proxy |
request.formparam.param_name. |
Bilangan Bulat | Hanya baca |
Jumlah semua nilai untuk parameter formulir yang ditentukan dan terkait dengan permintaan. |
Permintaan proxy |
request.formparam.param_name.N |
String | Baca/Tulis |
Nilai parameter formulir tertentu Ke-N dalam pesan. Misalnya, jika
string formulir adalah "a=hello&a=world", nilai yang ditampilkan dari
|
Permintaan proxy |
request.formparams.count |
Bilangan Bulat | Hanya baca |
Jumlah semua parameter formulir yang terkait dengan permintaan yang dikirim dari aplikasi klien. |
Permintaan proxy |
request.formparams.names |
Koleksi | Hanya baca |
Daftar semua nama parameter formulir yang terkait dengan permintaan. |
Permintaan proxy |
request.formstring |
String | Hanya baca |
Misalnya, "name=test&type=first&group=A". |
Permintaan proxy |
request.header.header_name |
String | Baca/Tulis |
Mendapatkan atau menetapkan nilai header tertentu yang ditemukan dalam permintaan. Jika header berisi koma, setelah dibaca, Anda hanya akan menerima segmen teks hingga koma pertama. Jika Anda menginginkan seluruh header, gunakan bentuk
|
Permintaan proxy |
request.header.header_name.N |
String | Baca/Tulis |
Nilai header tertentu ke-N dalam permintaan. Apigee Edge memisahkan nilai teks header dengan koma. Perhatikan bahwa indeks yang nilainya digunakan untuk N berbasis 1, bukan berbasis 0. Misalnya, jika header |
Permintaan proxy |
request.header.header_name. |
Koleksi | Hanya baca |
Semua nilai header tertentu dalam permintaan. |
Permintaan proxy |
request.header.header_name. |
Bilangan Bulat | Hanya baca |
Jumlah semua nilai header tertentu dalam permintaan. |
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.path |
String | Hanya baca |
Jalur resource yang tidak di-proxy (tidak termasuk host) ke layanan backend, tidak termasuk parameter kueri. Misalnya, URI ke layanan backend adalah
"https://example.com/rest/api/latest", maka nilai
|
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 Ke-n dalam permintaan. Misalnya, jika Sebagai contoh penulisan beberapa nilai untuk satu nama parameter kueri, seperti "type=siteid:1&type=language:us-en&type=currency:USD", tetapkan hal berikut:
|
Permintaan proxy |
request.queryparam.param_name. |
Koleksi | Hanya baca |
Semua nilai parameter kueri tertentu dalam permintaan, yang diformat sebagai daftar yang dipisahkan koma. Misalnya, jika |
Permintaan proxy |
request.queryparam.param_name. |
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. Untuk melakukan iterasi pada nama parameter kueri menggunakan JavaScript, lihat Bagaimana cara melakukan iterasi pada Koleksi dari "request.queryparams.names" di JS? di Komunitas Apigee. |
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", variabel ini akan menampilkan "name=first&surname=second&place=address". |
Permintaan proxy |
request.transportid |
String | Hanya baca |
ID permintaan sebagai jenis TransportMessage yang merupakan objek kontekstual. |
Permintaan proxy |
request.transport.message |
Transport-Message | Hanya baca |
Permintaan jenis TransportMessage yang merupakan objek kontekstual. |
Permintaan proxy |
request.uri |
String | Hanya baca |
Di proxy API,
Mengarah ke
Dalam permintaan, Dalam respons, 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":
Dan panggilan proxy:
Yang menambahkan "/user?user=Dude" ke URL tersebut.
|
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 contoh "http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude", dan endpoint targetnya adalah "http://example.com:8080", nilainya adalah:
|
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.formparam.param_name |
String | Baca/Tulis |
Nilai parameter formulir dalam respons. |
Respons target |
response.formparam.param_name. |
Bilangan Bulat | Hanya baca |
Jumlah semua nilai parameter formulir yang ditentukan sebagai respons. |
Respons target |
response.formparams.count |
Bilangan Bulat | Hanya baca |
Jumlah semua parameter formulir dalam respons. |
Respons target |
response.formparams.names |
Koleksi | Hanya baca |
Nama semua parameter formulir dalam respons. |
Respons target |
response.header.header_name |
String | Baca/Tulis |
Mendapatkan atau menetapkan nilai header HTTP yang ditentukan dalam respons. Jika teks header menyertakan koma, Apigee Edge akan menyimpulkan beberapa nilai. Dalam hal ini,
Untuk membaca seluruh header, gunakan formulir |
Respons target |
response.header.header_name. |
Koleksi | Hanya baca |
Semua nilai header HTTP yang ditentukan sebagai respons. |
Respons target |
response.header.header_name. |
Bilangan Bulat | Hanya baca |
Jumlah semua nilai header HTTP yang ditentukan sebagai respons. |
Respons target |
response.header.header_name.N |
String | Baca/Tulis |
Nilai header tertentu Ke-N dalam respons. Apigee Edge memisahkan nilai teks header dengan koma. Perhatikan bahwa indeks yang nilainya digunakan untuk N berbasis 1, bukan berbasis 0. Misalnya, jika header |
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.reason.phrase |
String | Baca/Tulis |
Frasa alasan respons untuk permintaan tertentu. |
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 |
Respons target |
response.transport.message |
String | Hanya baca |
Respons dari 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 |
Permintaan target |
route.target |
String | Hanya baca |
Nama TargetEndpoint yang dieksekusi. Misalnya, "default". |
Permintaan target |
router
Penampung untuk properti router.uuid
, yang tidak digunakan lagi.
Tabel berikut menjelaskan properti variabel router
:
Properti | Jenis | Baca/Tulis | Deskripsi | Cakupan dimulai |
---|---|---|---|---|
router.uuid |
String | Hanya baca |
Tidak digunakan lagi dan menampilkan null. (Dulunya UUID router yang menangani proxy.) |
Permintaan proxy |
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 disebutkan dalam kebijakan kebijakan ServiceCallout. Hal ini hanya berlaku 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 policy. 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 region pusat data tempat proxy berjalan. |
Permintaan proxy |
system.time |
String | Hanya baca |
Waktu saat variabel ini dibaca. Misalnya, "Rabu, 21 Agustus 2013 19.16.47 UTC". Nilai ini adalah representasi string dari nilai |
Permintaan proxy |
system.time.year |
Bilangan Bulat | Hanya baca |
Bagian tahun dari |
Permintaan proxy |
system.time.month |
Bilangan Bulat | Hanya baca |
Bagian bulan dari |
Permintaan proxy |
system.time.day |
Bilangan Bulat | Hanya baca |
Bagian hari dalam sebulan dari |
Permintaan proxy |
system.time.dayofweek |
Bilangan Bulat | Hanya baca |
Bagian hari dalam seminggu dari |
Permintaan proxy |
system.time.hour |
Bilangan Bulat | Hanya baca |
Bagian jam dari |
Permintaan proxy |
system.time.minute |
Bilangan Bulat | Hanya baca |
Bagian menit dari |
Permintaan proxy |
system.time.second |
Bilangan Bulat | Hanya baca |
Bagian kedua |
Permintaan proxy |
system.time.millisecond |
Bilangan Bulat | Hanya baca |
Bagian milidetik dari |
Permintaan proxy |
system.time.zone |
String | Hanya baca |
Zona waktu sistem. |
Permintaan proxy |
system.timestamp |
Panjang | Hanya baca |
Bilangan bulat 64-bit (long) yang mewakili waktu saat variabel ini dibaca. Nilainya adalah jumlah milidetik yang telah 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:
Dalam contoh ini, Jika targetnya adalah:
|
Permintaan target |
target.copy.pathsuffix |
Boolean | Baca/Tulis |
Jika "true", permintaan yang diteruskan dari ProxyEndpoint ke TargetEndpoint akan 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 ditampilkan oleh server target |
Respons target |
target.cn |
String | Hanya baca |
Nama Umum TargetEndpoint. Hal ini hanya berlaku jika TargetEndpoint merujuk ke endpoint TLS/SSL. |
Permintaan target |
target.email.address |
String | Hanya baca |
Alamat email sertifikat TLS/SSL yang ditampilkan oleh server target |
Respons target |
target.expectedcn |
String | Baca/Tulis |
Nama Umum TargetEndpoint yang diharapkan. Hal ini hanya berlaku jika TargetEndpoint merujuk ke endpoint TLS/SSL. |
Permintaan proxy |
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 ditampilkan oleh server target |
Respons target |
target.name |
String | Hanya baca |
Target yang dijangkau pesan dari targetendpoint. |
Permintaan target |
target.organization |
String | Hanya baca |
Pengaturan sertifikat TLS/SSL yang ditampilkan oleh server target. |
Respons target |
target.organization.unit |
String | Hanya baca |
Unit organisasi sertifikat TLS/SSL yang ditampilkan 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, "Rabu, 21 Agustus 2013 19.16.47 UTC". Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, "Rabu, 21 Agustus 2013 19.16.47 UTC" sesuai dengan nilai stempel waktu "1377112607413". |
Respons target |
target.received.end. |
Panjang | Hanya baca |
Nilai stempel waktu yang menentukan kapan TargetEndpoint selesai menerima respons dari target. Misalnya, "1534783015000". Nilai ini adalah bilangan bulat 64-bit (long) 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, "Rabu, 21 Agustus 2013 19.16.47 UTC". Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, "Rabu, 21 Agustus 2013 19.16.47 UTC" sesuai dengan nilai stempel waktu "1377112607413". |
Respons target |
target.received.start. |
Panjang | Hanya baca |
Nilai stempel waktu yang menentukan kapan TargetEndpoint mulai menerima respons dari target. Misalnya, "1534783015000". Nilai ini adalah bilangan bulat 64-bit (long) yang menentukan jumlah milidetik yang telah berlalu sejak tengah malam, pada 1 Januari 1970 UTC. |
Respons target |
target.scheme |
String | Hanya baca |
Cakupan dimulai: Respons target 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, "Rabu, 21 Agustus 2013 19.16.47 UTC". Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, "Rabu, 21 Agustus 2013 19.16.47 UTC" sesuai dengan nilai stempel waktu "1377112607413". |
Permintaan target |
target.sent.end.timestamp |
Panjang | 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, "Rabu, 21 Agustus 2013 19.16.47 UTC". Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, "Rabu, 21 Agustus 2013 19.16.47 UTC" sesuai dengan nilai stempel waktu "1377112607413". |
Permintaan target |
target.sent.start.timestamp |
Panjang | 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 ditampilkan oleh server target. |
Respons target |
target.url |
String | Baca/Tulis |
URL yang dikonfigurasi dalam file XML TargetEndpoint atau URL target dinamis (jika
|
Permintaan target |
variable
Penampung untuk properti variable.expectedcn
.
Tabel berikut menjelaskan properti variabel variable
:
Properti | Jenis | Baca/Tulis | Deskripsi | Cakupan dimulai |
---|---|---|---|---|
variable.expectedcn |
String | Baca/Tulis |
Variabel yang ditampilkan untuk nama umum jika berjalan di TLS/SSL. |
Permintaan proxy |
Untuk informasi selengkapnya tentang cara menggunakan TLS, lihat pengantar TLS/SSL.
virtualhost
Menentukan detail tentang host virtual.
Tabel berikut menjelaskan properti variabel virtualhost
:
Properti | Jenis | Baca/Tulis | Deskripsi | Cakupan dimulai |
---|---|---|---|---|
virtualhost.aliases.values |
Array String | Hanya baca |
Alias host dari host virtual yang diakses selama permintaan tertentu. |
Permintaan proxy |
virtualhost.name |
String | Hanya baca |
Nama host virtual yang menayangkan permintaan klien asal. |
Permintaan proxy |
virtualhost.ssl.enabled |
Boolean | Hanya baca |
Menampilkan "true" jika TLS/SSL diaktifkan di konfigurasi host virtual. |
Permintaan proxy |
Untuk informasi selengkapnya tentang cara menggunakan host virtual, lihat Mengonfigurasi host virtual.