Dokumen ini menjelaskan API Layanan Penyimpanan Objek (OSS), membantu Anda memahami konsep inti dan model sumber daya OSS serta menemukan API yang diperlukan dengan cepat. Untuk pengembangan kustom, gunakan kit pengembangan perangkat lunak (SDK) di lingkungan produksi Anda. SDK mengenkapsulasi logika kompleks seperti penandatanganan, percobaan ulang, dan konkurensi. Dokumen ini berfungsi sebagai referensi untuk implementasi dasar SDK dan berguna untuk penyesuaian tingkat lanjut atau memahami mekanisme komunikasi.
Sebelum memulai, perhatikan hal-hal berikut:
Panggilan API harus mematuhi Batasan.
Sebelum menggunakan API, pastikan Anda memahami metode penagihan OSS. Informasi lebih lanjut tentang harga dapat ditemukan di Harga OSS.
Mulai Cepat: Panggil API pertama Anda
Bab ini menggunakan pembuatan bucket (PutBucket) sebagai contoh untuk menjelaskan proses lengkap membuat panggilan API.
1. Persiapan
Sebelum memulai, pastikan Anda memiliki informasi berikut:
AccessKey: Untuk keamanan, semua permintaan API OSS, kecuali permintaan akses anonim, harus ditandatangani untuk otentikasi. OSS menggunakan mekanisme tanda tangan berdasarkan pasangan AccessKey, yang terdiri dari ID AccessKey dan Rahasia AccessKey, untuk memverifikasi permintaan. Informasi tanda tangan harus disertakan dalam bidang
Authorizationheader permintaan HTTP. Untuk detail tentang cara menghitung tanda tangan, lihat Signature V4 (direkomendasikan).Endpoint: Permintaan API harus dikirim ke endpoint wilayah tempat bucket tujuan berada. Endpoint adalah alamat akses layanan OSS. Informasi lebih lanjut tentang endpoint berbagai wilayah dapat ditemukan di Wilayah dan endpoint.
2. Buat dan kirim permintaan
PUT / HTTP/1.1
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Date: Thu, 17 Apr 2025 03:15:40 GMT
x-oss-acl: private
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e
<?xml version="1.0" encoding="UTF-8"?>
<CreateBucketConfiguration>
<StorageClass>Standard</StorageClass>
<DataRedundancyType>LRS</DataRedundancyType>
</CreateBucketConfiguration>3. Pahami respons
Respons Berhasil: Jika permintaan berhasil, server mengembalikan kode status
2xx. Untuk operasi yang mengembalikan konten, badan respons dalam format XML.HTTP/1.1 200 OK x-oss-request-id: 534B371674E88A4D8906**** Date: Fri, 24 Feb 2017 03:15:40 GMT Content-Length: 0 Connection: keep-alive Server: AliyunOSS Location: /oss-examplePenanganan Kesalahan: Jika permintaan gagal, server mengembalikan kode status
4xxatau5xx. Badan respons juga dalam format XML dan berisi kode kesalahan spesifik (Code) dan pesan kesalahan (Message). Untuk informasi lebih lanjut, lihat Kode kesalahan untuk menyelesaikan masalah tersebut.
Daftar API
Operasi Layanan
API | Deskripsi |
Mengembalikan semua bucket yang dimiliki oleh peminta. | |
Menampilkan semua tugas transisi redundansi data milik peminta. |
Operasi Wilayah
API | Deskripsi |
Meminta endpoint semua wilayah yang didukung atau wilayah tertentu. |
Operasi Bucket
Klasifikasi | API | Deskripsi |
Operasi dasar | Membuat bucket. | |
Menghapus bucket. | ||
Menampilkan informasi tentang semua objek dalam sebuah bucket. | ||
Mengkueri informasi bucket. | ||
Memeriksa lokasi sebuah bucket. | ||
Memeriksa penggunaan penyimpanan dan jumlah objek dalam sebuah bucket. | ||
Kebijakan retensi | Membuat kebijakan retensi. | |
Menghapus kebijakan retensi yang belum terkunci. | ||
Mengunci kebijakan retensi. | ||
Memperpanjang periode retensi objek dalam bucket yang kebijakan retensinya terkunci. | ||
Memeriksa kebijakan retensi dari sebuah bucket. | ||
Kontrol akses | Menetapkan izin akses untuk sebuah bucket. | |
Memeriksa izin akses dari sebuah bucket. | ||
Siklus hidup | Menetapkan aturan siklus hidup untuk objek dalam sebuah bucket. | |
Meminta aturan siklus hidup untuk objek dalam sebuah bucket. | ||
Menghapus aturan siklus hidup untuk objek dalam sebuah bucket. | ||
Akselerasi transfer | Mengonfigurasi akselerasi transfer untuk bucket. | |
Memeriksa konfigurasi akselerasi transfer dari sebuah bucket. | ||
Versi | Menetapkan status pengendalian versi dari sebuah bucket. | |
Memeriksa status pengendalian versi sebuah bucket. | ||
Menampilkan versi dari semua objek dalam sebuah bucket. | ||
Replikasi lintas wilayah | Menetapkan aturan replikasi data untuk sebuah bucket. | |
Mengaktifkan atau menonaktifkan kontrol waktu replikasi (RTC) untuk aturan replikasi lintas wilayah yang ada. | ||
Memeriksa aturan replikasi data yang ditetapkan untuk sebuah bucket. | ||
Meminta wilayah tujuan ke mana data dapat direplikasi. | ||
Mengkueri kemajuan replikasi data bucket. | ||
Menghentikan tugas replikasi data dan menghapus konfigurasi replikasi dari sebuah bucket. | ||
Kebijakan otorisasi | Menetapkan Kebijakan bucket. | |
Meminta Kebijakan bucket. | ||
Memeriksa apakah Kebijakan bucket saat ini mengizinkan akses publik. | ||
Menghapus kebijakan bucket. | ||
Inventaris | Menetapkan aturan inventaris untuk bucket. | |
Meminta tugas inventaris tertentu dalam sebuah bucket. | ||
Memeriksa semua tugas inventaris di dalam bucket. | ||
Menghapus tugas inventaris tertentu dari bucket. | ||
Manajemen Log | Mengaktifkan fitur pencatatan log akses untuk sebuah bucket. | |
Memeriksa konfigurasi log akses dari sebuah bucket. | ||
Menonaktifkan fitur pencatatan log akses untuk sebuah bucket. | ||
Mengonfigurasi bidang | ||
Memeriksa konfigurasi dari bidang | ||
Menghapus konfigurasi | ||
Situs web statis | Mengatur bucket ke mode hosting situs web statis. | |
Memeriksa status hosting situs web statis dari sebuah bucket. | ||
Menonaktifkan mode hosting situs web statis untuk sebuah bucket. | ||
Perlindungan hotlink | Menetapkan aturan perlindungan hotlink untuk sebuah bucket. | |
Memeriksa aturan Perlindungan hotlink dari sebuah bucket. | ||
Tag | Menambahkan atau memodifikasi tag bucket. | |
Meminta tag bucket. | ||
Menghapus tag bucket. | ||
Enkripsi | Mengonfigurasi aturan enkripsi untuk bucket. | |
Meminta aturan enkripsi bucket. | ||
Menghapus aturan enkripsi bucket. | ||
Pembayaran oleh peminta | Menetapkan bucket ke mode bayar-per-permintaan. | |
Memeriksa konfigurasi bayar-per-permintaan dari sebuah bucket. | ||
Berbagi sumber daya lintas asal | Menetapkan aturan berbagi sumber daya lintas asal (CORS) untuk bucket yang ditentukan. | |
Memeriksa aturan CORS saat ini dari bucket yang ditentukan. | ||
Menonaktifkan fitur CORS dan menghapus semua aturan CORS untuk bucket tertentu. | ||
Sebelum browser mengirimkan permintaan lintas asal, ia mengirimkan permintaan preflight (OPTIONS) yang membawa informasi seperti asal sumber, metode HTTP, dan header ke OSS untuk menentukan apakah akan mengirimkan permintaan sebenarnya. | ||
Pelacakan akses | Mengonfigurasi status pelacakan akses dari sebuah bucket. | |
Memeriksa status pelacakan akses dari sebuah bucket. | ||
Pengindeksan Data | Mengaktifkan fitur manajemen metadata untuk bucket. | |
Mengeksekusi kueri terhadap indeks metadata dari bucket yang ditentukan. | ||
Mengajukan pertanyaan tentang objek yang memenuhi kondisi tertentu dan mencantumkan informasi objek berdasarkan bidang dan metode pengurutan yang ditentukan. | ||
Menonaktifkan fitur manajemen metadata untuk bucket. | ||
Perlindungan DDoS | Membuat Anti-DDoS untuk instans OSS. | |
Mengubah status instans Anti-DDoS untuk OSS. | ||
Mengambil informasi tentang Anti-DDoS untuk instans OSS yang dimiliki oleh akun tertentu. | ||
Menginisialisasi perlindungan untuk sebuah bucket. | ||
Memperbarui status perlindungan dari sebuah bucket. | ||
Meminta daftar informasi perlindungan untuk sebuah bucket. | ||
Grup sumber daya | Mengonfigurasi grup sumber daya untuk bucket. | |
Mengkueri ID grup sumber daya tempat bucket termasuk. | ||
Nama domain kustom | Membuat token CNAME yang diperlukan untuk memverifikasi kepemilikan nama domain. | |
Meminta token CNAME yang telah dibuat. | ||
Mengikat rekaman CNAME ke bucket. | ||
Memeriksa daftar semua Record CNAME yang terikat pada sebuah bucket. | ||
Menghapus rekaman CNAME yang terikat. | ||
Gaya gambar | Menambahkan gaya citra. | |
Meminta informasi tentang gaya citra tertentu dalam sebuah bucket. | ||
Menanyakan semua gaya citra yang dibuat dalam sebuah bucket. | ||
Menghapus gaya citra tertentu dari sebuah bucket. | ||
Keamanan lapisan transport | Mengaktifkan atau menonaktifkan pengaturan Versi TLS untuk sebuah bucket. | |
Memeriksa pengaturan Versi TLS dari sebuah bucket. | ||
Transisi redundansi | Membuat tugas transisi redundansi data. | |
Memeriksa tugas transisi redundansi data. | ||
Menghapus tugas transisi redundansi data. | ||
Menampilkan semua tugas transisi redundansi data dari peminta. | ||
Menampilkan semua tugas transisi redundansi data dalam sebuah bucket. | ||
Titik akses | Membuat titik akses. | |
Mengkueri informasi tentang titik akses. | ||
Menghapus titik akses. | ||
Mengkueri informasi tentang titik akses tingkat pengguna atau tingkat bucket. | ||
Mengonfigurasi kebijakan titik akses. | ||
Mengkueri konfigurasi kebijakan titik akses. | ||
Menghapus kebijakan titik akses. | ||
Object FC titik akses | Membuat titik akses Object FC. | |
Mengambil informasi dasar tentang titik akses Object FC. | ||
Menghapus titik akses Object FC. | ||
Meminta informasi tentang titik akses Object FC tingkat pengguna. | ||
Memodifikasi konfigurasi titik akses Object FC. | ||
Meminta konfigurasi dari titik akses Object FC. | ||
Mengonfigurasi kebijakan akses untuk titik akses Object FC. | ||
Memeriksa konfigurasi kebijakan akses dari titik akses Object FC. | ||
Menghapus kebijakan akses dari titik akses Object FC. | ||
Menyesuaikan data yang dikembalikan dan header respons. | ||
Blokir Akses Publik | Mengaktifkan Blokir Akses Publik secara global untuk OSS. | |
Memeriksa konfigurasi global Blokir Akses Publik untuk OSS. | ||
Menghapus konfigurasi global Blokir Akses Publik untuk OSS. | ||
Mengaktifkan Blokir Akses Publik untuk sebuah bucket. | ||
Memeriksa konfigurasi Blokir Akses Publik dari bucket yang ditentukan. | ||
Menghapus konfigurasi Blokir Akses Publik dari bucket yang ditentukan. | ||
Mengaktifkan Blokir Akses Publik untuk sebuah titik akses. | ||
Memeriksa konfigurasi Blokir Akses Publik dari titik akses yang ditentukan. | ||
Menghapus konfigurasi Blokir Akses Publik dari titik akses yang ditentukan. | ||
Akses real-time objek Arsip | Mengaktifkan atau menonaktifkan akses waktu nyata untuk objek Arsip. | |
Memeriksa apakah akses waktu nyata untuk objek Arsip diaktifkan. | ||
Akselerator OSS | Membuat Akselerator OSS atau memodifikasi konfigurasinya. | |
Meminta informasi tentang Akselerator OSS. | ||
Menghapus Akselerator OSS. |
Operasi Objek
Klasifikasi | API | Deskripsi |
Operasi dasar | Mengunggah objek. | |
Mengkueri objek. | ||
Menyalin objek. | ||
Mengunggah objek menggunakan unggah tambahan. | ||
Mencegah data ditambahkan ke objek Appendable. | ||
Menghapus satu objek. | ||
Menghapus beberapa objek. | ||
Hanya mengembalikan metadata objek, bukan konten objek. | ||
Mengembalikan metadata dasar objek, seperti ETag, ukuran, dan waktu modifikasi terakhir objek, tetapi tidak mengembalikan konten objek. | ||
Mengunggah objek menggunakan formulir HTML. | ||
Anda dapat menerapkan callback dengan menyertakan parameter callback dalam permintaan yang Anda kirim ke OSS. | ||
Memulihkan objek Penyimpanan Arsip, Penyimpanan Arsip Dingin, atau Deep Cold Archive. | ||
Mengakhiri status pemulihan objek lebih awal. | ||
Menjalankan pernyataan SQL pada file objek dan mengembalikan hasil eksekusi. | ||
Meminta jumlah total baris, jumlah total kolom (untuk file CSV), dan jumlah split dari file objek. | ||
Manajemen folder | Membuat folder. | |
Mengganti nama folder atau objek. | ||
Menghapus folder. | ||
Unggah multipart | Memulai acara unggah multi-bagian. | |
Mengunggah data dalam bagian berdasarkan nama objek dan ID unggah yang ditentukan. | ||
Memanggil operasi UploadPartCopy untuk menyalin data dari objek yang ada untuk mengunggah bagian dengan menambahkan header permintaan x-oss-copy-source ke permintaan UploadPart. | ||
Setelah semua bagian file diunggah, Anda harus memanggil operasi CompleteMultipartUpload untuk menyelesaikan unggah multi-bagian file. | ||
Membatalkan acara unggah multi-bagian dan menghapus bagian yang telah diunggah. | ||
Menampilkan semua acara unggah multi-bagian yang sedang berlangsung. Acara unggah multi-bagian yang sedang berlangsung adalah acara unggah multi-bagian yang dimulai tetapi belum selesai atau dibatalkan. | ||
Menampilkan semua bagian yang berhasil diunggah yang termasuk dalam ID unggah tertentu. | ||
Kontrol akses | Memodifikasi izin akses objek. | |
Meminta izin akses objek. | ||
Tautan simbolik | Membuat tautan simbolik. | |
Mengkueri tautan simbolik. | ||
Penandaan | Menetapkan atau memperbarui tag objek. | |
Meminta tag objek. | ||
Menghapus tag objek tertentu. |
Operasi bucket vektor
Klasifikasi | API | Deskripsi |
Bucket vektor | Membuat bucket vektor. | |
Meminta detail bucket vektor. | ||
Menampilkan semua bucket vektor yang dimiliki oleh akun saat ini. | ||
Menghapus bucket vektor. | ||
Indeks | Membuat indeks vektor dalam bucket vektor. | |
Mengambil detail indeks vektor. | ||
Menampilkan semua indeks vektor dalam bucket vektor. | ||
Setelah semua bagian data diunggah, Anda harus memanggil API CompleteMultipartUpload untuk menyelesaikan unggah multi-bagian. | ||
Vektor | Menulis data vektor ke indeks. | |
Meminta data vektor tertentu. | ||
Menampilkan semua data vektor dalam indeks vektor. | ||
Menghapus data vektor tertentu dari indeks vektor. | ||
Menjalankan pencarian kesamaan vektor. |
Operasi QoS kelompok sumber daya
API | Deskripsi |
Menetapkan pembatasan kecepatan untuk bucket dalam kolam sumber daya. | |
Meminta konfigurasi pembatasan kecepatan bucket dalam kolam sumber daya. | |
Menghapus konfigurasi pembatasan kecepatan bucket yang ditentukan dalam kolam sumber daya. | |
Menetapkan pembatasan tingkat bucket untuk peminta. | |
Meminta konfigurasi pembatasan tingkat bucket untuk peminta tertentu. | |
Meminta konfigurasi pembatasan tingkat bucket untuk semua peminta. | |
Menghapus konfigurasi pembatasan kecepatan peminta untuk bucket. | |
Meminta informasi tentang semua kolam sumber daya yang dimiliki oleh akun saat ini. | |
Meminta konfigurasi pembatasan kecepatan kolam sumber daya tertentu. | |
Menampilkan daftar bucket yang termasuk dalam kolam sumber daya tertentu. | |
Mengonfigurasi pembatasan kecepatan untuk peminta kolam sumber daya. | |
Meminta konfigurasi pembatasan kecepatan peminta tertentu untuk kolam sumber daya. | |
Meminta konfigurasi pembatasan kecepatan untuk semua peminta dalam kolam sumber daya. | |
Menghapus konfigurasi pembatasan kecepatan peminta tertentu untuk kolam sumber daya. | |
Menambahkan bucket dalam kolam sumber daya ke grup bucket. | |
Menampilkan grup bucket dalam kolam sumber daya tertentu. | |
Mengonfigurasi atau memodifikasi pengaturan pembatasan kecepatan untuk grup bucket dalam kolam sumber daya. | |
Meminta konfigurasi pembatasan kecepatan grup bucket dalam kolam sumber daya. | |
Menampilkan konfigurasi pembatasan kecepatan grup bucket dalam kolam sumber daya. | |
Menghapus konfigurasi pembatasan kecepatan grup bucket dalam kolam sumber daya. |
Operasi LiveChannel
API | Deskripsi |
Mengubah status LiveChannel. | |
Membuat LiveChannel. | |
Meminta daftar putar. | |
Membuat daftar putar. | |
Meminta status pengambilan aliran LiveChannel. | |
Meminta konfigurasi LiveChannel. | |
Meminta catatan pengambilan aliran LiveChannel. | |
Menampilkan LiveChannel. | |
Menghapus LiveChannel. |