Topik ini menjelaskan header permintaan umum dari operasi API Layanan Log.
Parameter
Operasi API Layanan Log merupakan operasi API RESTful berbasis protokol HTTP. Seperangkat header permintaan umum dapat digunakan dalam operasi API ini. Tabel berikut menjelaskan header permintaan umum untuk semua permintaan API.
Nama Header | Tipe | Diperlukan | Deskripsi |
Accept | String | Tidak | Tipe nilai yang diharapkan oleh klien agar Layanan Log mengembalikan. Nilai valid: application/json dan application/x-protobuf. Header ini hanya valid untuk permintaan GET. Nilainya bervariasi sesuai dengan definisi API. |
Accept-Encoding | String | Tidak | Algoritma kompresi yang diharapkan oleh klien agar Layanan Log mengembalikan. Nilai valid: LZ4, DEFLATE, dan null (tidak dikompresi). Header ini hanya valid untuk permintaan GET. Nilainya bervariasi sesuai dengan definisi API. |
Authorization | String | Ya | Konten dari tanda tangan. Untuk informasi lebih lanjut, lihat Tanda tangan permintaan. |
Content-Length | Nilai numerik | Tidak | Panjang badan permintaan HTTP yang didefinisikan dalam RFC 2616. Untuk permintaan tanpa badan, header ini tidak diperlukan. |
Content-MD5 | String | Tidak | String yang dihasilkan setelah badan permintaan dihitung berdasarkan algoritma MD5. Nilainya dalam huruf besar. Untuk permintaan tanpa badan, header ini tidak diperlukan. |
Content-Type | String | Tidak | Tipe badan permintaan HTTP yang didefinisikan dalam RFC 2616. Nilai valid: application/x-protobuf. Untuk permintaan tanpa badan, header ini tidak diperlukan. Nilainya bervariasi sesuai dengan definisi API. |
Date | String | Ya | Waktu saat permintaan dikirim. Hanya format pesan RFC 1123 yang didukung. Waktunya dalam GMT. Stringnya dalam format berikut: %a, %d%b%Y %H:%M:%S GMT, contohnya, Mon, 3 Jan 2010 08:33:47 GMT. |
Host | String | Ya | Nama host dari permintaan HTTP. Nilainya tidak termasuk header protokol seperti |
x-log-apiversion | String | Ya | Versi API. Versi saat ini adalah 0.6.0. |
x-log-bodyrawsize | Nilai numerik | Tidak | Ukuran awal dari badan permintaan. Untuk permintaan tanpa badan, nilainya adalah 0. Untuk permintaan dengan badan terkompresi, nilainya adalah ukuran badan sebelum kompresi. Rentang nilai: 0 hingga 3145728. Header ini hanya diperlukan ketika badan dikompresi. |
x-log-compresstype | String | Tidak | Algoritma yang digunakan untuk menekan badan permintaan. LZ4 dan DEFLATE yang ditentukan dalam RFC 1951 didukung. Jika Anda perlu menggunakan format data terkompresi ZLIB, lihat RFC 1950. Untuk permintaan dengan badan tidak terkompresi, header ini tidak diperlukan. |
x-log-date | String | Tidak | Waktu saat permintaan dikirim. Formatnya sama dengan header Date. Jika sebuah permintaan berisi header permintaan umum ini, nilai dari header ini menggantikan nilai dari header Date standar. Nilai ini digunakan oleh Layanan Log untuk memverifikasi permintaan. Header ini tidak disertakan dalam perhitungan tanda tangan. Header Date standar HTTP harus disertakan dalam permintaan terlepas dari apakah permintaan tersebut berisi header x-log-date. |
x-log-signaturemethod | String | Ya | Metode perhitungan tanda tangan. Nilai valid: |
x-acs-security-token | String | Tidak | Identitas sementara Security Token Service (STS) digunakan untuk mengirim data. Header permintaan ini hanya diperlukan ketika identitas sementara STS digunakan. |
Perbedaan maksimum antara waktu dalam header Date dan waktu saat Layanan Log menerima permintaan adalah 15 menit. Jika perbedaan melebihi 15 menit, Layanan Log akan menolak permintaan. Untuk permintaan dengan header x-log-date, perbedaan waktu dihitung berdasarkan nilai dari header x-log-date.
Jika algoritma kompresi ditentukan dalam header x-log-compresstype suatu permintaan, data mentah harus dikompresi lalu dimasukkan ke dalam badan permintaan HTTP. Nilai dari header Content-Length dan Content-MD5 dihitung berdasarkan badan terkompresi.
Untuk permintaan HTTP yang dikirim dari platform tertentu, Anda tidak dapat menentukan header Date. Waktu saat ini dikirim sesuai dengan basis data internal dari platform. Oleh karena itu, nilai yang benar dari header Date tidak dapat digunakan untuk menghitung tanda tangan permintaan. Dalam hal ini, Anda harus menentukan header x-log-date. Nilai ini digunakan untuk menghitung tanda tangan permintaan. Setelah permintaan API diterima, Layanan Log menentukan apakah permintaan berisi header x-log-date. Jika permintaan berisi header x-log-date, Layanan Log menggunakan nilai dari header x-log-date untuk memverifikasi tanda tangan. Jika tidak, Layanan Log menggunakan nilai dari header Date standar untuk memverifikasi tanda tangan.
Contoh
POST / HTTP/1.1
Authorization: LOG <yourAccessKeyId>:<yourSignature>
x-log-bodyrawsize: 0
User-Agent: sls-java-sdk-v-0.6.1
x-log-apiversion: 0.6.0
Host: my-project-test.cn-shanghai.log.aliyuncs.com
x-log-signaturemethod: hmac-sha1
Date: Sun, 27 May 2018 07:43:26 GMT
Content-Type: application/json
Content-MD5: A7967D81EFF5E3CD447FB6D8DF294E20
Content-Length: 80
Connection: Keep-Alive