Referensi variabel alur

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Bagian ini menyediakan 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 berikutnya.

apigee

Variabel helper 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, saat kebijakan dijalankan. 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 khusus 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 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 ditampilkan oleh aplikasi klien.

 Permintaan proxy
client.country String Hanya baca

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

 Permintaan proxy
client.email.address String Hanya baca

Alamat email di sertifikat TLS/SSL yang disediakan 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, IP ini bisa berupa IP klien asli atau IP load balancer.

 Permintaan proxy
client.locality String Hanya baca

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

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

Unit organisasi di 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: Rab, 21 Agu 2013 19:16:47 UTC.

Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, Rab, 21 Agustus 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: Rab, 21 Agu 2013 19:16:47 UTC

Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, Rab, 21 Agustus 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.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: Rab, 21 Aug 2013 19:16:47 UTC.

Nilai ini adalah representasi string dari client.sent.end.timestamp 32-bit yang sesuai. Misalnya, Rab, 21 Agustus 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 (panjang) 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, Rab, 21 Agu 2013 19:16:47 UTC.

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

 PostClientFlow
client.sent.start.timestamp Long Hanya baca Saat proxy mulai mengirimkan 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 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 flow yang sedang dijalankan (seperti PreFlow, PostFlow, atau nama flow bersyarat). Permintaan proxy
current.flow.description String Hanya baca Deskripsi alur yang sedang dijalankan. Ini sama dengan nilai elemen <Description> dalam konfigurasi XML flow. Permintaan proxy

Anda dapat menampilkan properti ini di tampilan Trace UI Apigee.

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 dijalankan.

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

Memberikan informasi tentang sumber, alasan, dan detail error runtime. Apigee menetapkan variabel ini jika kebijakan menampilkan error, dan nilai bersifat spesifik 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 terjadinya kesalahan. Misalnya, saat kebijakan OASValidation mendeteksi bahwa permintaan masuk tidak memvalidasi Spesifikasi OpenAPI, variabel ini akan ditetapkan ke string yang menjelaskan nama kebijakan, nama spesifikasi, dan detail yang menjelaskan alasan permintaan tidak memvalidasi dengan spesifikasi tersebut. Kebijakan lain akan menetapkan variabel ini ke pesan yang sesuai dengan kesalahannya. Error
fault.category String Hanya baca Kategori. Misalnya, jika terjadi kesalahan dalam langkah kebijakan, variabel ini mungkin menyimpan 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, variabel ini akan ditetapkan 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/TULIS BACA Kueri GraphQL root. CAKUPAN
graphql.fragment Jenis kompleks HANYA BACA/TULIS BACA Referensi ke fragmen default untuk kueri ini. CAKUPAN
graphql.fragment.count Bilangan bulat Hanya Baca Jumlah frame yang dihasilkan oleh kueri GraqhQL ini. CAKUPAN
graphql.fragment.INDEX.selectionSet.INDEX JENIS HANYA BACA/TULIS BACA Referensi ke set pilihan pada indeks yang ditentukan. CAKUPAN
graphql.fragment.INDEX.selectionSet.INDEX.name String HANYA BACA/TULIS BACA Nama pilihan yang ditetapkan pada indeks yang ditentukan. CAKUPAN
graphql.fragment.INDEX.selectionSet.count Bilangan bulat Hanya Baca Jumlah set pemilihan dalam fragmen ini. CAKUPAN
graphql.fragment.INDEX.selectionSet.name String HANYA BACA/TULIS BACA Nama pilihan default yang ditetapkan dalam fragmen. CAKUPAN
graphql.operation Jenis kompleks HANYA BACA/TULIS BACA Referensi ke operasi default kueri.

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

 CAKUPAN
graphql.operation.name String Hanya Baca Nama operasi default kueri. CAKUPAN
graphql.operation.operationType Enumerasi Hanya Baca Jenis operasi default kueri yang bisa dijalankan terhadap proxy API ini. Nilai yang mungkin adalah query, mutation, atau all. CAKUPAN
graphql.operation.selectionSet Jenis Kompleks Pilihan default ditetapkan 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 kumpulan pilihan default operasi default kueri. CAKUPAN
graphql.operation.selectionSet.INDEX Bilangan bulat Hanya Baca Referensi ke set pemilihan pada indeks yang ditentukan dalam daftar set pemilihan. CAKUPAN
graphql.operation.selectionSet.INDEX.name String Hanya Baca Nama pemilihan pada indeks yang ditentukan dalam daftar set pemilihan untuk operasi ini. CAKUPAN
graphql.operation.selectionSet.INDEX.[selectionSet] Jenis kompleks HANYA BACA/TULIS BACA Satu atau beberapa objek kumpulan pemilihan tambahan.

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

CAKUPAN
graphql.operation.selectionSet.INDEX.directive Jenis kompleks Referensi ke perintah default dalam kumpulan 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 perintah 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

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 TargetServers yang gagal selama load balancing di TargetEndpoint.

 Target respons
loadbalancing.isfallback Boolean Hanya baca

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

 Target respons
loadbalancing.targetserver String Hanya baca

TargetServer dipanggil selama load balancing di TargetEndpoint. Tetapkan hanya jika elemen <Path> ditetapkan saat menentukan elemen load balancer.

 Target respons

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 request dalam Alur permintaan atau sebagai response dalam Alur respons atau sebagai error dalam alur Error.

 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.
 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./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 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, nilai yang ditampilkan dari message.header.cache-control adalah public.

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

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

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

Misalnya, jika header Cache-control adalah public,maxage=16544, 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, 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.path String Baca/Tulis

Jalur pesan permintaan lengkap di URL yang tidak mencakup parameter kueri apa pun.

Permintaan proxy
message.queryparam.param_name String Hanya baca

Menampilkan parameter kueri pesan tertentu.

 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, nilai yang ditampilkan 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 nilai berikut:

  • 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, yang diformat sebagai daftar yang dipisahkan koma.

Misalnya, jika string kueri adalah a=hello&a=world, 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.

Untuk melakukan iterasi pada nama parameter kueri menggunakan JavaScript, lihat Postingan komunitas Apigee berikut: Bagaimana cara melakukan iterasi pada 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 message.querystring adalah name=nick&surname=danger.

 Permintaan proxy
message.status.code Bilangan bulat Hanya baca

Kode status HTTP pesan respons dari target.

 Target respons
message.transport.message TransportMessage Hanya baca

Pesan dari jenis 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 (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 menyertakan nama host load balancer. Dengan ID ini, permintaan yang diterima di load balancer dapat dilacak setelah dikirim ke pemroses pesan.

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

 Permintaan proxy

mint

Variabel penunjang 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 atau tidak. Tetapkan ke true jika is_subscription_found adalah false.

Variabel alur ini tersedia jika kebijakan MonetizationLimitsCheck disertakan ke proxy API. Lihat Menerapkan batasan monetisasi di proxy API.

 Permintaan proxy
mint.limitscheck.is_subscription_found Boolean Hanya baca

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

Variabel alur ini tersedia jika kebijakan MonetizationLimitsCheck disertakan ke proxy API. Lihat Menerapkan batasan monetisasi di proxy API.

 Permintaan proxy
mint.limitscheck.prepaid_developer_balance Angka Hanya baca

Saldo saat ini di dompet akun prabayar developer yang terkait dengan mata uang paket tarif.

 Permintaan proxy
mint.limitscheck.prepaid_developer_currency String Hanya baca

Mata uang saldo tersedia di 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 disertakan ke proxy API. Lihat Menerapkan batasan monetisasi di proxy API.

 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 disertakan ke proxy API. Lihat Menerapkan batasan monetisasi di proxy API.

 Permintaan proxy
mint.mintng_consumption_pricing_rates String Hanya baca

Biaya berbasis pemakaian.

Menetapkan biaya saat membuat paket tarif.

 PostClientFlow
mint.mintng_consumption_pricing_type String Hanya baca

Jenis penetapan harga berdasarkan pemakaian. Contoh: FIXED_PER_UNIT

Tetapkan biaya berbasis konsumsi saat membuat paket tarif.

 PostClientFlow
mint.mintng_currency String Hanya baca

Mata uang untuk menghitung pendapatan.

Variabel alur ini memiliki nilai currency variabel monetisasi.

 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

Tanda 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 revShareGrossPrice variabel monetisasi.

 Kebijakan DataCapture dan PostClientFlow
mint.mintng_price_multiplier Angka Hanya baca

Faktorkan (pengganda) yang digunakan untuk mengalikan biaya per transaksi.

Variabel alur memiliki nilai perUnitPriceMultiplier variabel monetisasi.

 Kebijakan DataCapture dan PostClientFlow
mint.mintng_rate Angka Hanya baca

Tarif yang dikenakan untuk panggilan API.

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

 PostClientFlow
mint.mintng_rate_before_multipliers Angka Hanya baca

Tarif yang dikenakan untuk panggilan API tanpa penghitungan perUnitPriceMultiplier.

Jika kebijakan DataCapture memiliki variabel monetisasi perUnitPriceMultiplier, variabel alur ini akan menampilkan 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 transactionSuccess variabel monetisasi.

 Kebijakan DataCapture
mint.prepaid_updated_developer_usage Angka Hanya baca

Penggunaan developer prabayar saat ini.

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

 PostClientFlow
mint.rateplan_end_time_ms Angka Hanya baca

Waktu habis masa berlaku untuk 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 untuk 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. Hanya diisi jika terjadi error.

 PostClientFlow
mint.status_code Angka Hanya baca

Kode status HTTP dari panggilan yang dimonetisasi. Hanya diisi jika terjadi error.

 PostClientFlow
mint.subscription_end_time_ms Angka Hanya baca

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

Variabel alur ini tersedia jika kebijakan MonetizationLimitsCheck disertakan ke proxy API. Lihat Menerapkan batasan monetisasi di proxy API.

 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 disertakan ke proxy API. Lihat Menerapkan batasan monetisasi di proxy API.

 Permintaan proxy
mint.tx_success_result Boolean Hanya baca

Menunjukkan apakah monetisasi untuk transaksi berhasil atau tidak.

Variabel mint.tx_success_result dapat memiliki nilai berikut:

  • tx_Success disetel ke true: Variabel transactionSuccess adalah true, dan transaksi dimonetisasi. Karena transaksi dimonetisasi, nilai variabel mint.mintng_rate dan mint.mintng_dev_share akan dihitung.
  • tx_Berhasil ditetapkan ke 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 non 2xx: Variabel transactionSuccess tidak ditangkap dan kode status HTTP (message.status.code) transaksi bukan 2xx. Transaksi tidak dimonetisasi.
  • tx_Success tidak ditemukan. Kode status pesan sebelumnya adalah 2xx: Variabel transactionSuccess tidak ditangkap dan kode status HTTP (message.status.code) transaksi adalah 2xx. Transaksi tersebut dimonetisasi.
 PostClientFlow

Untuk informasi selengkapnya, lihat referensi berikut:

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 di 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 memiliki Endpoint Proxy API yang dikonfigurasi dengan jalur dasar /v2/weatherapi. (Lihat Konfigurasi Endpoint Proxy untuk detailnya.) Dalam hal ini, jika permintaan masuk menggunakan URL https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, maka:

  • Nama host-nya 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>, variabel proxy.basepath akan ditetapkan ke jalur dinamis. Untuk mengambil URL sebenarnya untuk permintaan tersebut, baca dan uraikan 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. Ini dapat berupa klien pemanggil 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 dalam URL yang dikirim dari klien dan diterima di ProxyEndpoint.

Basepath adalah komponen jalur paling kiri yang secara unik mengidentifikasi proxy API dalam Environment Group. Misalkan Anda memiliki endpoint Proxy API yang dikonfigurasi dengan jalur dasar /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 semua parameter kueri yang ada.

 Permintaan proxy

Untuk 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
batas kapasitas.policy_name.allowed.count Long Hanya-Baca Menampilkan jumlah kuota yang diizinkan. PostClientFlow
batas kapasitas.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 pada 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 di class PostClientFlow
ratelimit.policy_name.class.used.count Long Hanya-Baca Menampilkan kuota yang digunakan dalam sebuah class 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 class dalam interval kuota saat ini PostClientFlow
ratelimit.policy_name.class.total.exceed.count Long Hanya-Baca Menampilkan jumlah total permintaan yang melebihi batas di class pada semua interval kuota, sehingga merupakan jumlah class.exceed.count untuk semua interval kuota. PostClientFlow
batas kapasitas.policy_name.failed Boolean Hanya-Baca

Menunjukkan apakah kebijakan gagal (true atau false).

 PostClientFlow

Untuk informasi selengkapnya, lihat referensi berikut:

request

Permintaan yang 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 yang 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.
 values		 Koleksi Hanya baca

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

Misalnya, jika payload adalah a=hello&x=greeting&a=world, 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 dikaitkan dengan permintaan.

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

Nilai parameter formulir khusus Nth dalam pesan. Misalnya, jika string formulir adalah a=hello&a=world, nilai yang ditampilkan 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.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 informasi tentang proxy gRPC, lihat Membuat proxy gRPC API.

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

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

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, nilai yang ditampilkan dari request.header.cache-control adalah public.

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

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

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

Misalnya, jika header Cache-control adalah public, maxage=16544, 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

Hitung 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 string tunggal.

Misalnya, jika header Cache-control adalah public, maxage=16544, 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.path String Hanya baca

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

Misalnya, jika URI ke layanan backend adalah https://example.com/rest/api/latest, 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 adalah 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 nilai berikut:

  • 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, yang 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.

Untuk melakukan iterasi pada nama parameter kueri menggunakan JavaScript, lihat Bagaimana cara mengiterasi Pengumpulan 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 kontekstual.

 Permintaan proxy
request.transport.message {i>Transport-Message<i} Hanya baca

Permintaan jenis TransportMessage yang berkelanjutan.

 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.

Di response, request.uri adalah sisa alamat, termasuk parameter kueri, setelah HTTPTargetConnection.

Perbedaannya adalah karena permintaan asli masuk ke proxy, tetapi kemudian proxy tersebut 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 proxy memanggil:

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 contoh http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude, dan endpoint targetnya adalah http://example.com:8080, maka nilainya adalah:

  • Permintaan: t/a
  • Respons: http://example.com/user?user=Dude
 Target respons
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.

 Target respons
response.content String Baca/Tulis

Konten payload pesan respons yang ditampilkan oleh target.

 Target respons
response.header.header_name String Baca/Tulis

Mendapatkan atau menetapkan nilai header HTTP yang ditentukan dalam respons.

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

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

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

 Target respons
response.header.header_name.
 values		 Koleksi Hanya baca

Semua nilai header HTTP tertentu sebagai respons.

 Target respons
response.header.header_name.
 values.count		 Bilangan bulat Hanya baca

Hitung semua nilai header HTTP yang ditentukan sebagai respons.

 Target respons
response.header.header_name.
 values.string		 String Hanya baca

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

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

 Target respons
response.header.header_name.N String Baca/Tulis

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

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

 Target respons
response.headers.count Bilangan bulat Hanya baca

Jumlah semua header dalam respons.

 Target respons
response.headers.names Koleksi Hanya baca

Nama semua header dalam respons.

 Target respons
response.reason.phrase String Baca/Tulis

Frasa alasan respons untuk permintaan tertentu.

 Target respons
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.

 Target respons
response.transport.message String Hanya baca

Respons jenis TransportMessage yang merupakan objek berkelanjutan.

 Target respons

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 dieksekusi di ProxyEndpoint. Misalnya: default. RouteRule mereferensikan proxy API TargetEndpoint untuk dijalankan.

 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 sebagaimana dirujuk dalam kebijakan ServiceCallout. Hal ini hanya berguna 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 ini 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, Rab, 21 Agustus 2013 19:16:47 GMT.

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

 Permintaan proxy
system.time.year Bilangan bulat Hanya baca

Bagian tahun dari system.time.

 Permintaan proxy
system.time.month Bilangan bulat Hanya baca

Bagian bulan system.time.

 Permintaan proxy
system.time.day Bilangan bulat Hanya baca

Bagian hari dalam sebulan dari system.time.

 Permintaan proxy
system.time.dayofweek Bilangan bulat Hanya baca

Bagian hari dalam seminggu pada 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 (panjang) yang mewakili waktu 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 dalam 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:

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

target.basepath akan bernilai null.

 Permintaan target
target.copy.pathsuffix Boolean Baca/Tulis

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

 Permintaan target
target.copy.queryparams Boolean Baca/Tulis

Saat 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

 Target respons
target.cn String Hanya baca

Nama Umum TargetEndpoint. Hal ini hanya berguna 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

 Target respons
target.expectedcn String Baca/Tulis

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

 Permintaan proxy
target.host String Hanya baca

Nama domain layanan target yang menampilkan respons ke proxy API.

 Target respons
target.ip String Hanya baca

Alamat IP layanan target yang menampilkan respons ke proxy API.

 Target respons
target.locality String Hanya baca

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

 Target respons
target.name String Hanya baca

Target yang dituju untuk pesan yang dijangkau dari targetendpoint.

 Permintaan target
target.organization String Hanya baca

Pengaturan sertifikat TLS/SSL yang diberikan oleh server target.

 Target respons
target.organization.unit String Hanya baca

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

 Target respons
target.port Bilangan bulat Hanya baca

Nomor port layanan target yang menampilkan respons ke proxy API.

 Target respons
target.received.end.time String Hanya baca

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

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

 Target respons
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 berlalu sejak tengah malam, pada 1 Januari 1970 UTC.

 Target respons
target.received.start.time String Hanya baca

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

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

 Target respons
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 berlalu sejak tengah malam, pada 1 Januari 1970 UTC.

 Target respons
target.scheme String Hanya baca

Cakupan dimulai: Target respons
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 dalam TargetEndpoint. Misalnya, Rab, 21 Agt 2013 19:16:47 UTC.

Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, Rab, 21 Agustus 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 dalam TargetEndpoint. Misalnya, 1377112607413. Nilai ini adalah bilangan bulat 64-bit (panjang) 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 dalam TargetEndpoint. Misalnya, Rab, 21 Agt 2013 19:16:47 UTC.

Nilai waktu ini adalah representasi string dari kuantitas stempel waktu 32-bit yang sesuai. Misalnya, Rab, 21 Agustus 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 dalam TargetEndpoint. 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.

 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.

 Target respons
target.url String Baca/Tulis

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

 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 ditampilkan untuk nama umum jika dijalankan di TLS/SSL.

 Permintaan proxy

Untuk informasi selengkapnya tentang bekerja dengan TLS, lihat Opsi untuk mengonfigurasi TLS.