Ikhtisar API - Object Storage Service - Alibaba Cloud Documentation Center

Dokumen ini menjelaskan API Object Storage Service (OSS), membantu Anda memahami konsep inti dan model sumber daya OSS serta menemukan dengan cepat API yang dibutuhkan. Untuk pengembangan kustom, gunakan software development kit (SDK) di lingkungan produksi Anda. SDK mengenkapsulasi logika kompleks seperti penandatanganan, percobaan ulang (retries), dan konkurensi. Dokumen ini berfungsi sebagai referensi untuk implementasi dasar SDK dan berguna untuk kustomisasi lanjutan atau pemahaman mekanisme komunikasi.

Sebelum memulai, perhatikan hal-hal berikut:

Pemanggilan API harus mematuhi Batasan.
Sebelum menggunakan API, pastikan Anda memahami metode penagihan OSS. Untuk informasi lebih lanjut mengenai harga, lihat Harga OSS.

Mulai cepat: Panggil API pertama Anda

Bagian ini menggunakan pembuatan bucket (PutBucket) sebagai contoh untuk menjelaskan proses lengkap pemanggilan API.

1. Persiapan

Sebelum memulai, siapkan informasi berikut:

AccessKey: Untuk keamanan, semua permintaan API OSS—kecuali permintaan akses anonim—harus ditandatangani untuk autentikasi. OSS menggunakan mekanisme tanda tangan berbasis pasangan AccessKey, yang terdiri dari ID AccessKey dan Rahasia AccessKey, untuk memverifikasi permintaan. Informasi tanda tangan harus disertakan dalam bidang Authorization header permintaan HTTP. Untuk informasi lebih lanjut 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. Untuk informasi lebih lanjut mengenai endpoint berbagai wilayah, lihat Wilayah dan endpoint.

2. Membuat dan mengirim 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. Memahami respons

Respons Sukses: Jika permintaan berhasil, server mengembalikan kode status 2xx. Untuk operasi yang mengembalikan konten, badan respons berformat 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-example

Penanganan Error: Jika permintaan gagal, server mengembalikan kode status 4xx atau 5xx. Badan respons juga berformat XML dan berisi kode kesalahan spesifik (Code) serta pesan kesalahan (Message). Untuk informasi lebih lanjut, lihat Kode kesalahan untuk mengatasi masalah tersebut.

Daftar API

Operasi layanan

API	Deskripsi
ListBuckets (GetService)	Mengembalikan semua bucket yang dimiliki oleh pemohon.
ListUserDataRedundancyTransition	Menampilkan semua tugas transisi redundansi data milik pemohon.

Operasi wilayah

API	Deskripsi
DescribeRegions	Meminta endpoint semua wilayah yang didukung atau wilayah tertentu.

Operasi bucket

Klasifikasi	API	Deskripsi
Operasi dasar	PutBucket	Membuat bucket.
	DeleteBucket	Menghapus bucket.
	ListObjects (GetBucket)	Menampilkan informasi semua objek dalam bucket.
	ListObjectsV2 (GetBucketV2)	Menampilkan informasi semua objek dalam bucket.
	GetBucketInfo	Meminta informasi bucket.
	GetBucketLocation	Meminta lokasi bucket.
	GetBucketStat	Meminta penggunaan penyimpanan dan jumlah objek dalam bucket.
Kebijakan retensi	InitiateBucketWorm	Membuat kebijakan retensi.
	AbortBucketWorm	Menghapus kebijakan retensi yang belum dikunci.
	CompleteBucketWorm	Mengunci kebijakan retensi.
	ExtendBucketWorm	Memperpanjang periode retensi objek dalam bucket yang telah memiliki kebijakan retensi terkunci.
	GetBucketWorm	Meminta kebijakan retensi bucket.
Kontrol akses	PutBucketAcl	Menetapkan izin akses bucket.
Kontrol akses	GetBucketAcl	Meminta izin akses bucket.
Lifecycle	PutBucketLifecycle	Menetapkan aturan siklus hidup untuk objek dalam bucket.
	GetBucketLifecycle	Meminta aturan siklus hidup untuk objek dalam bucket.
	DeleteBucketLifecycle	Menghapus aturan siklus hidup untuk objek dalam bucket.
Akselerasi transfer	PutBucketTransferAcceleration	Mengonfigurasi akselerasi transfer untuk bucket.
Akselerasi transfer	GetBucketTransferAcceleration	Meminta konfigurasi akselerasi transfer bucket.
Pengendalian versi	PutBucketVersioning	Menetapkan status pengendalian versi bucket.
	GetBucketVersioning	Meminta status pengendalian versi bucket.
	ListObjectVersions (GetBucketVersions)	Menampilkan versi semua objek dalam bucket.
Replikasi lintas wilayah	PutBucketReplication	Menetapkan aturan replikasi data untuk bucket.
	PutBucketRTC	Mengaktifkan atau menonaktifkan replication time control (RTC) untuk aturan replikasi lintas wilayah yang sudah ada.
	GetBucketReplication	Meminta aturan replikasi data yang ditetapkan untuk bucket.
	GetBucketReplicationLocation	Meminta wilayah tujuan tempat data dapat direplikasi.
	GetBucketReplicationProgress	Meminta progres replikasi data bucket.
	DeleteBucketReplication	Menghentikan tugas replikasi data dan menghapus konfigurasi replikasi bucket.
Kebijakan otorisasi	PutBucketPolicy	Menetapkan kebijakan bucket.
	GetBucketPolicy	Meminta kebijakan bucket.
	GetBucketPolicyStatus	Memeriksa apakah kebijakan bucket saat ini mengizinkan akses publik.
	DeleteBucketPolicy	Menghapus kebijakan bucket.
Inventaris	PutBucketInventory	Menetapkan aturan inventaris untuk bucket.
	GetBucketInventory	Meminta tugas inventaris tertentu dalam bucket.
	ListBucketInventory	Meminta semua tugas inventaris dalam bucket.
	DeleteBucketInventory	Menghapus tugas inventaris tertentu dari bucket.
Manajemen Log	PutBucketLogging	Mengaktifkan fitur pencatatan log akses untuk bucket.
	GetBucketLogging	Meminta konfigurasi log akses bucket.
	DeleteBucketLogging	Menonaktifkan fitur pencatatan log akses untuk bucket.
	PutUserDefinedLogFieldsConfig	Mengonfigurasi bidang `user_defined_log_fields` dalam log waktu nyata bucket.
	GetUserDefinedLogFieldsConfig	Meminta konfigurasi bidang `user_defined_log_fields` dalam log waktu nyata bucket.
	DeleteUserDefinedLogFieldsConfig	Menghapus konfigurasi bidang `user_defined_log_fields` dalam log waktu nyata bucket.
Situs web statis	PutBucketWebsite	Menetapkan bucket ke mode hosting situs web statis.
	GetBucketWebsite	Meminta status hosting situs web statis bucket.
	DeleteBucketWebsite	Menonaktifkan mode hosting situs web statis untuk bucket.
Perlindungan hotlink	PutBucketReferer	Menetapkan aturan perlindungan hotlink untuk bucket.
Perlindungan hotlink	GetBucketReferer	Meminta aturan perlindungan hotlink bucket.
Tag	PutBucketTags	Menambahkan atau memodifikasi tag bucket.
	GetBucketTags	Meminta tag bucket.
	DeleteBucketTags	Menghapus tag bucket.
Enkripsi	PutBucketEncryption	Mengonfigurasi aturan enkripsi untuk bucket.
	GetBucketEncryption	Meminta aturan enkripsi bucket.
	DeleteBucketEncryption	Menghapus aturan enkripsi bucket.
Bayar oleh pemohon	PutBucketRequestPayment	Menetapkan bucket ke mode pay-by-requester.
Bayar oleh pemohon	GetBucketRequestPayment	Meminta konfigurasi pay-by-requester bucket.
Berbagi sumber daya lintas asal	PutBucketCors	Menetapkan aturan Berbagi Sumber Daya Lintas Asal (CORS) untuk bucket tertentu.
	GetBucketCors	Meminta aturan CORS saat ini dari bucket tertentu.
	DeleteBucketCors	Menonaktifkan fitur CORS dan menghapus semua aturan CORS untuk bucket tertentu.
	Options	Sebelum browser mengirim permintaan lintas asal, browser mengirim permintaan preflight (OPTIONS) yang membawa informasi seperti origin sumber, metode HTTP, dan header ke OSS untuk menentukan apakah akan mengirim permintaan sebenarnya.
Pelacakan akses	PutBucketAccessMonitor	Mengonfigurasi status pelacakan akses bucket.
Pelacakan akses	GetBucketAccessMonitor	Meminta status pelacakan akses bucket.
Pengindeksan Data	OpenMetaQuery	Mengaktifkan fitur manajemen metadata untuk bucket.
	GetMetaQueryStatus	Meminta pustaka indeks metadata bucket tertentu.
	DoMetaQuery	Meminta objek yang memenuhi kondisi tertentu dan menampilkan informasi objek berdasarkan bidang dan metode pengurutan yang ditentukan.
	CloseMetaQuery	Menonaktifkan fitur manajemen metadata untuk bucket.
Proteksi DDoS	InitUserAntiDDosInfo	Membuat instans Anti-DDoS untuk OSS.
	UpdateUserAntiDDosInfo	Mengubah status instans Anti-DDoS untuk OSS.
	GetUserAntiDDosInfo	Meminta informasi tentang instans Anti-DDoS untuk OSS milik akun tertentu.
	InitBucketAntiDDosInfo	Menginisialisasi proteksi untuk bucket.
	UpdateBucketAntiDDosInfo	Memperbarui status proteksi bucket.
	ListBucketAntiDDosInfo	Meminta daftar informasi proteksi untuk bucket.
Kelompok sumber daya	PutBucketResourceGroup	Mengonfigurasi kelompok sumber daya untuk bucket.
Kelompok sumber daya	GetBucketResourceGroup	Meminta ID kelompok sumber daya tempat bucket berada.
Nama domain kustom	CreateCnameToken	Membuat token CNAME yang diperlukan untuk memverifikasi kepemilikan nama domain.
	GetCnameToken	Meminta token CNAME yang telah dibuat.
	PutCname	Mengikat record CNAME ke bucket.
	ListCname	Meminta daftar semua record CNAME yang terikat ke bucket.
	DeleteCname	Menghapus record CNAME yang terikat.
Gaya gambar	PutStyle	Menambahkan gaya gambar.
	GetStyle	Meminta informasi tentang gaya gambar tertentu dalam bucket.
	ListStyle	Meminta semua gaya gambar yang dibuat dalam bucket.
	DeleteStyle	Menghapus gaya gambar tertentu dari bucket.
Keamanan lapisan transport	PutBucketHttpsConfig	Mengaktifkan atau menonaktifkan pengaturan versi TLS untuk bucket.
Keamanan lapisan transport	GetBucketHttpsConfig	Meminta pengaturan versi TLS bucket.
Transisi redundansi	CreateBucketDataRedundancyTransition	Membuat tugas transisi redundansi data.
	GetBucketDataRedundancyTransition	Meminta tugas transisi redundansi data.
	DeleteBucketDataRedundancyTransition	Menghapus tugas transisi redundansi data.
	ListUserDataRedundancyTransition	Menampilkan semua tugas transisi redundansi data milik pemohon.
	ListBucketDataRedundancyTransition	Menampilkan semua tugas transisi redundansi data dalam bucket.
Titik akses	CreateAccessPoint	Membuat titik akses.
	GetAccessPoint	Meminta informasi tentang titik akses.
	DeleteAccessPoint	Menghapus titik akses.
	ListAccessPoints	Meminta informasi tentang titik akses tingkat pengguna atau tingkat bucket.
	PutAccessPointPolicy	Mengonfigurasi kebijakan titik akses.
	GetAccessPointPolicy	Meminta konfigurasi kebijakan titik akses.
	DeleteAccessPointPolicy	Menghapus kebijakan titik akses.
Titik akses Object FC	CreateAccessPointForObjectProcess	Membuat titik akses Object FC.
	GetAccessPointForObjectProcess	Meminta informasi dasar tentang titik akses Object FC.
	DeleteAccessPointForObjectProcess	Menghapus titik akses Object FC.
	ListAccessPointsForObjectProcess	Meminta informasi tentang titik akses Object FC tingkat pengguna.
	PutAccessPointConfigForObjectProcess	Memodifikasi konfigurasi titik akses Object FC.
	GetAccessPointConfigForObjectProcess	Meminta konfigurasi titik akses Object FC.
	PutAccessPointPolicyForObjectProcess	Mengonfigurasi kebijakan akses untuk titik akses Object FC.
	GetAccessPointPolicyForObjectProcess	Meminta konfigurasi kebijakan akses titik akses Object FC.
	DeleteAccessPointPolicyForObjectProcess	Menghapus kebijakan akses titik akses Object FC.
	WriteGetObjectResponse	Menyesuaikan data yang dikembalikan dan header respons.
Blokir Akses Publik	PutPublicAccessBlock	Mengaktifkan Blokir Akses Publik secara global untuk OSS.
	GetPublicAccessBlock	Meminta konfigurasi Blokir Akses Publik global untuk OSS.
	DeletePublicAccessBlock	Menghapus konfigurasi Blokir Akses Publik global untuk OSS.
	PutBucketPublicAccessBlock	Mengaktifkan Blokir Akses Publik untuk bucket.
	GetBucketPublicAccessBlock	Meminta konfigurasi Blokir Akses Publik bucket tertentu.
	DeleteBucketPublicAccessBlock	Menghapus konfigurasi Blokir Akses Publik bucket tertentu.
	PutAccessPointPublicAccessBlock	Mengaktifkan Blokir Akses Publik untuk titik akses.
	GetAccessPointPublicAccessBlock	Meminta konfigurasi Blokir Akses Publik titik akses tertentu.
	DeleteAccessPointPublicAccessBlock	Menghapus konfigurasi Blokir Akses Publik titik akses tertentu.
Akses waktu nyata untuk objek Arsip	PutBucketArchiveDirectRead	Mengaktifkan atau menonaktifkan akses waktu nyata untuk objek Arsip.
Akses waktu nyata untuk objek Arsip	GetBucketArchiveDirectRead	Memeriksa apakah akses waktu nyata untuk objek Arsip diaktifkan.
Akselerator OSS	PutBucketDataAccelerator	Membuat akselerator OSS atau memodifikasi konfigurasinya.
	GetBucketDataAccelerator	Meminta informasi tentang akselerator OSS.
	DeleteBucketDataAccelerator	Menghapus akselerator OSS.

Operasi objek

Klasifikasi	API	Deskripsi
Operasi dasar	PutObject	Mengunggah objek.
	GetObject	Meminta objek.
	CopyObject	Menyalin objek.
	AppendObject	Mengunggah objek menggunakan unggah append.
	SealAppendObject	Mencegah data ditambahkan ke objek Appendable.
	DeleteObject	Menghapus satu objek.
	DeleteMultipleObjects	Menghapus beberapa objek.
	HeadObject	Hanya mengembalikan metadata objek, bukan konten objek.
	GetObjectMeta	Mengembalikan metadata dasar objek, seperti ETag, ukuran, dan waktu modifikasi terakhir objek, tetapi tidak mengembalikan konten objek.
	PostObject	Mengunggah objek menggunakan formulir HTML.
	Callback	Anda dapat menerapkan callback dengan menyertakan parameter callback dalam permintaan yang dikirim ke OSS.
	RestoreObject	Memulihkan objek Archive Storage, Cold Archive, atau Deep Cold Archive.
	CleanRestoredObject	Mengakhiri keadaan dipulihkan objek lebih awal.
	SelectObject	Menjalankan pernyataan SQL pada file objek dan mengembalikan hasil eksekusi.
	CreateSelectObjectMeta	Meminta jumlah total baris, jumlah total kolom (untuk file CSV), dan jumlah split file objek.
Manajemen folder	CreateDirectory	Membuat folder.
	Rename	Mengganti nama folder atau objek.
	DeleteDirectory	Menghapus folder.
Unggah multi-bagian	InitiateMultipartUpload	Menginisiasi event unggah multi-bagian.
	UploadPart	Mengunggah data secara bertahap berdasarkan nama objek dan ID unggah yang ditentukan.
	UploadPartCopy	Memanggil operasi UploadPartCopy untuk menyalin data dari objek yang sudah ada guna mengunggah bagian dengan menambahkan header permintaan x-oss-copy-source ke permintaan UploadPart.
	CompleteMultipartUpload	Setelah semua bagian file diunggah, Anda harus memanggil operasi CompleteMultipartUpload untuk menyelesaikan unggah multi-bagian file tersebut.
	AbortMultipartUpload	Membatalkan event unggah multi-bagian dan menghapus bagian yang telah diunggah.
	ListMultipartUploads	Menampilkan semua event unggah multi-bagian yang sedang berlangsung. Event unggah multi-bagian yang sedang berlangsung adalah event yang telah diinisiasi tetapi belum diselesaikan atau dibatalkan.
	ListParts	Menampilkan semua bagian yang berhasil diunggah yang termasuk dalam ID unggah tertentu.
Kontrol akses	PutObjectACL	Memodifikasi izin akses objek.
Kontrol akses	GetObjectACL	Meminta izin akses objek.
Tautan simbolik	PutSymlink	Membuat tautan simbolik.
Tautan simbolik	GetSymlink	Meminta tautan simbolik.
Penandaan	PutObjectTagging	Menetapkan atau memperbarui tag objek.
	GetObjectTagging	Meminta tag objek.
	DeleteObjectTagging	Menghapus tag objek tertentu.

Operasi bucket vektor

Klasifikasi	API	Deskripsi
Bucket vektor	PutVectorBucket	Membuat bucket vektor.
	GetVectorBucket	Meminta detail bucket vektor.
	ListVectorBuckets	Menampilkan semua bucket vektor milik akun saat ini.
	DeleteVectorBucket	Menghapus bucket vektor.
Indeks	PutVectorIndex	Membuat indeks vektor dalam bucket vektor.
	GetVectorIndex	Meminta detail indeks vektor.
	ListVectorIndexes	Menampilkan semua indeks vektor dalam bucket vektor.
	DeleteVectorIndex	Setelah Anda mengunggah semua bagian data, Anda harus memanggil API CompleteMultipartUpload untuk menyelesaikan unggah multi-bagian.
Vektor	PutVectors	Menulis data vektor ke indeks.
	GetVectors	Meminta data vektor tertentu.
	ListVectors	Menampilkan semua data vektor dalam indeks vektor.
	DeleteVectors	Menghapus data vektor tertentu dari indeks vektor.
	QueryVectors	Menjalankan pencarian kemiripan vektor.

Operasi QoS kelompok sumber daya

API	Deskripsi
PutBucketQoSInfo	Menetapkan pembatasan kecepatan untuk bucket dalam kolam sumber daya.
GetBucketQoSInfo	Meminta konfigurasi pembatasan kecepatan bucket dalam kolam sumber daya.
DeleteBucketQosInfo	Menghapus konfigurasi pembatasan kecepatan bucket tertentu dalam kolam sumber daya.
PutBucketRequesterQoSInfo	Menetapkan pembatasan kecepatan tingkat bucket untuk pemohon.
GetBucketRequesterQoSInfo	Meminta konfigurasi pembatasan kecepatan tingkat bucket untuk pemohon tertentu.
ListBucketRequesterQoSInfos	Meminta konfigurasi pembatasan kecepatan tingkat bucket untuk semua pemohon.
DeleteBucketRequesterQoSInfo	Menghapus konfigurasi pembatasan kecepatan pemohon untuk bucket.
ListResourcePools	Meminta informasi semua kolam sumber daya milik akun saat ini.
GetResourcePoolInfo	Meminta konfigurasi pembatasan kecepatan kolam sumber daya tertentu.
ListResourcePoolBuckets	Meminta daftar bucket yang termasuk dalam kolam sumber daya tertentu.
PutResourcePoolRequesterQoSInfo	Mengonfigurasi pembatasan kecepatan untuk pemohon kolam sumber daya.
GetResourcePoolRequesterQoSInfo	Meminta konfigurasi pembatasan kecepatan pemohon tertentu untuk kolam sumber daya.
ListResourcePoolRequesterQoSInfos	Meminta konfigurasi pembatasan kecepatan semua pemohon untuk kolam sumber daya.
DeleteResourcePoolRequesterQoSInfo	Menghapus konfigurasi pembatasan kecepatan pemohon tertentu untuk kolam sumber daya.
PutBucketResourcePoolBucketGroup	Menambahkan bucket dalam kolam sumber daya ke grup bucket.
ListResourcePoolBucketGroups	Menampilkan grup bucket dalam kolam sumber daya tertentu.
PutResourcePoolBucketGroupQoSInfo	Mengonfigurasi atau memodifikasi pengaturan pembatasan kecepatan untuk grup bucket dalam kolam sumber daya.
GetResourcePoolBucketGroupQoSInfo	Meminta konfigurasi pembatasan kecepatan grup bucket dalam kolam sumber daya.
ListResourcePoolBucketGroupQoSInfos	Menampilkan konfigurasi pembatasan kecepatan grup bucket dalam kolam sumber daya.
DeleteResourcePoolBucketGroupQoSInfo	Menghapus konfigurasi pembatasan kecepatan grup bucket dalam kolam sumber daya.

Operasi LiveChannel

API	Deskripsi
PutLiveChannelStatus	Mengalihkan status LiveChannel.
PutLiveChannel	Membuat LiveChannel.
GetVodPlaylist	Meminta playlist.
PostVodPlaylist	Membuat playlist.
GetLiveChannelStat	Meminta status pengambilan aliran LiveChannel.
GetLiveChannelInfo	Meminta konfigurasi LiveChannel.
GetLiveChannelHistory	Meminta catatan pengambilan aliran LiveChannel.
ListLiveChannel	Menampilkan LiveChannel.
DeleteLiveChannel	Menghapus LiveChannel.

Object Storage Service:Ikhtisar API