Parameter umum harus disertakan dalam semua permintaan HTTP. Parameter ini mencakup header permintaan umum dan parameter permintaan umum.
Header permintaan umum
Tabel berikut menjelaskan header permintaan umum yang digunakan saat mengirim permintaan HTTP POST melalui URL untuk memanggil API Content Moderation.
Header | Tipe | Diperlukan | Deskripsi |
Accept | String | Ya | Tipe data respons yang dapat diterima. Hanya tipe JSON yang didukung. Atur nilainya menjadi application/json. |
Content-Type | String | Ya | Tipe data badan permintaan. Hanya tipe JSON yang didukung. Atur nilainya menjadi application/json. |
Content-MD5 | String | Tidak | Nilai hasil enkode yang dihitung berdasarkan badan permintaan. Untuk mendapatkan nilai tersebut, gunakan isi dari badan permintaan sebagai string, terapkan algoritma MD5 pada string untuk mendapatkan output data biner, lalu enkode output tersebut berdasarkan algoritma Base64. Catatan Header ini opsional saat algoritma enkripsi HMAC-SM3 digunakan. Header ini diperlukan saat algoritma enkripsi HMAC-SHA1 digunakan. Secara default, algoritma enkripsi HMAC-SHA1 digunakan. |
Date | String | Ya | Waktu pengiriman permintaan. Header ini menggunakan format GMT. Contoh: Tue, 17 Jan 2017 10:16:36 GMT. |
x-acs-version | String | Ya | Versi API Content Moderation. Atur nilainya menjadi 2018-05-09. Penting Versi sebelum 2018-05-09 sudah tidak digunakan lagi. Jika Anda menggunakan versi lebih lama, kesalahan HttpCode:400 , ErrorCode:InvalidAction.NotFound akan dikembalikan. Ganti versi dengan 2018-05-09. |
x-acs-signature-nonce | String | Ya | Nomor unik dan acak yang digunakan untuk mencegah serangan replay. Kami menyarankan Anda menggunakan nomor berbeda untuk setiap permintaan. |
x-acs-signature-version | String | Ya | Versi algoritma enkripsi tanda tangan. Atur nilainya menjadi 1.0. |
x-acs-signature-method | String | Ya | Metode enkripsi string tanda tangan. Nilai valid:
Untuk informasi lebih lanjut tentang metode enkripsi, lihat Tanda tangan permintaan. |
x-acs-content-sm3 | String | Tidak | Nilai hasil enkode yang dihitung berdasarkan badan permintaan. Untuk mendapatkan nilai tersebut, gunakan isi dari badan permintaan sebagai string, terapkan algoritma enkripsi SM3 pada string untuk mendapatkan array byte, lalu ubah array tersebut ke format heksadesimal. Ini adalah metode encodeHexString(SM3Digest(body)). |
Authorization | String | Ya | Metode otentikasi. Deskripsi parameter:
|
Parameter permintaan umum
Tabel berikut menjelaskan parameter permintaan umum yang dapat digunakan saat mengirim permintaan HTTP POST melalui URL untuk memanggil API Content Moderation.
Parameter | Tipe | Diperlukan | Deskripsi |
clientInfo | String | Tidak | Informasi tentang klien yang mengirim permintaan. Informasi ini diserialisasi dari struktur ClientInfo dalam format JSON. Informasi tersebut mencakup pengenal mesin unik (UMID) dan Identitas Peralatan Bergerak Internasional (IMEI) dari klien. Untuk informasi lebih lanjut, lihat ClientInfo. |
Parameter | Tipe | Diperlukan | Deskripsi |
sdkVersion | String | Tidak | Versi SDK Content Moderation. Parameter ini diperlukan saat operasi dipanggil menggunakan SDK Content Moderation. Untuk informasi lebih lanjut, lihat Ikhtisar SDK. |
cfgVersion | String | Tidak | Versi konfigurasi. Parameter ini diperlukan saat operasi dipanggil menggunakan SDK Content Moderation. Untuk informasi lebih lanjut, lihat Ikhtisar SDK. |
userType | String | Tidak | Tipe akun pengguna. Nilai valid:
|
userId | String | Tidak | ID unik pengguna dalam sistem bisnis. Parameter ini membantu Anda mendeteksi perilaku pelanggaran potensial dari pengguna tertentu. Kami menyarankan Anda mengatur parameter ini. |
userNick | String | Tidak | Nama panggilan pengguna. |
imei | String | Tidak | IMEI perangkat. |
imsi | String | Tidak | Identitas Pelanggan Seluler Internasional (IMSI) perangkat. |
umid | String | Tidak | UMID perangkat. |
ip | String | Tidak | Alamat IP publik pengguna dalam sistem bisnis. Jika permintaan berasal dari perangkat, parameter ini bisa dibiarkan kosong. Jika permintaan berasal dari server, parameter ini diatur ke alamat IP logon pengguna atau alamat IP publik perangkat. Kami menyarankan Anda mengatur parameter ini untuk membantu menganalisis perilaku pelanggaran pengguna. Jika parameter ini tidak ditentukan dalam permintaan, server mencoba mendapatkan alamat IP dari URL permintaan atau header permintaan HTTP. |
os | String | Tidak | Sistem operasi perangkat. Contoh: Android 6.0. |
channel | String | Tidak | Nomor saluran. |
hostAppName | String | Tidak | Nama aplikasi host. |
hostPackage | String | Tidak | Nama paket aplikasi host. |
hostVersion | String | Tidak | Versi aplikasi host. |
Contoh permintaan
POST /green/image/scan?clientInfo=%7b%22userId%22%3a%22120234234%22%2c%22userNick%22%3a%22Mike%22%2c%22userType%22%3a%22others%22%7d HTTP/1.1
Accept: application/json
Content-Type: application/json
Content-MD5: C+5Y0crpO4sYgC2DNjycug==
Date: Tue, 15 May 2018 10:16:36 GMT
x-acs-version: 2018-05-09
x-acs-signature-nonce: adfkjfaHKslkjf
x-acs-signature-version: 1.0
x-acs-signature-method: HMAC-SHA1
Authorization: acs q23Q9K4PaGi12Wyk:adFff0FFO6sGcDbDNjRtso==
Host: green.cn-shanghai.aliyuncs.com/
Content-Length: 191
{
"scenes": [
"porn"
],
"tasks": [
{
"dataId": "test2NInmO$tAON6qYUrtCRgLo-1mwxdi",
"url": "https://img.alicdn.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
}
]
}Deskripsi parameter:
POST menentukan metode permintaan./green/image/scan menentukan jalur permintaan.clientInfo=%7b%22userId%22%3a%22120234234%22%2c%22userNick%22%3a%22Mike%22%2c%22userType%22%3a%22others%22%7dadalah parameter permintaan umum yang telah dienkode.Konten dari Accept:application/json hingga
Content-Length:191menentukan header permintaan HTTP.Header dariAccept: application/jsonhinggaAuthorization: acs q23Q9K4PaGi12Wyk:adFff0FFO6sGcDbDNjRtso==merupakan header permintaan umum yang digunakan untuk tanda tangan.Konten yang diapit dalam kurung kurawal {} adalah badan permintaan berformat JSON.Struktur badan permintaan bergantung pada definisi operasi API yang berbeda. Untuk informasi lebih lanjut, lihat Daftar operasi berdasarkan fungsi.