Panggil API PushObjectCache untuk melakukan prefetch konten - CDN - Alibaba Cloud - CDN

Deskripsi operasi

Metode permintaan: Permintaan POST didukung. Parameter ditampilkan dalam formulir.
Operasi terkait: Operasi refresh dan prefetch mencakup operasi refresh RefreshObjectCaches dan operasi prefetch PushObjectCache.
Kuota prefetch URL harian: Secara default, setiap akun dapat mengirimkan hingga 1.000 tugas prefetch URL per hari. Jika bandwidth puncak harian akun Anda melebihi 200 Mbit/s, Anda dapat mengirimkan tiket untuk meminta kuota harian yang lebih tinggi. Alibaba Cloud mengevaluasi dan mengonfigurasi kuota berdasarkan kebutuhan bisnis aktual Anda.
Anda dapat mengirimkan hingga 100 tugas prefetch URL sekaligus.
Aturan antrean prefetch: Ukuran antrean prefetch maksimum untuk setiap akun adalah 100.000 URL. CDN melakukan prefetch URL sesuai urutan pengirimannya. Ketika jumlah URL yang menunggu prefetch dalam antrean mencapai 100.000, CDN menolak tugas prefetch baru.
Jumlah maksimum pemanggilan operasi ini per detik oleh setiap pengguna: 50.
Untuk mengotomatiskan tugas refresh atau prefetch, lihat Skrip untuk Refresh dan Prefetch.

Sebelum Anda mulai

Setelah tugas prefetch dikirimkan dan berhasil dijalankan, titik kehadiran (point of presence) segera melakukan pengambilan asal untuk memuat sumber daya yang diperlukan. Mengirimkan sejumlah besar tugas prefetch menghasilkan banyak tugas unduhan bersamaan, yang menyebabkan lonjakan bandwidth dan permintaan pengambilan asal serta meningkatkan beban pada server asal.
Waktu eksekusi aktual tugas prefetch dari pengiriman hingga penyelesaian tergantung pada ukuran file yang di-prefetch dan biasanya memakan waktu 5 hingga 30 menit. Semakin kecil ukuran file rata-rata, semakin cepat prefetch.
Untuk menggunakan pengguna Resource Access Management (RAM) untuk melakukan operasi refresh atau prefetch, dapatkan otorisasi yang diperlukan terlebih dahulu. Lihat Memberikan izin kepada pengguna RAM untuk refresh dan prefetch untuk menyelesaikan otorisasi.
Header default yang dibawa dalam permintaan prefetch adalah Accept-Encoding:gzip. Untuk membawa header lain dalam permintaan prefetch atau mengimplementasikan prefetch multi-salinan, gunakan parameter permintaan WithHeader untuk menyesuaikan header prefetch.
Selama prefetch, jika server asal mengembalikan kode status pengalihan seperti 307, tugas prefetch tidak mengikuti URL pengalihan untuk menyelesaikan prefetch, yang menyebabkan prefetch gagal. Jika server asal mengembalikan kode status 301 atau 302 dan pengalihan 302 diaktifkan pada CDN, prefetch normal tidak terpengaruh.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

cdn:PushObjectCache

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ObjectPath	string	Yes	URL yang akan di-prefetch. Formatnya adalah nama domain terakselerasi/file yang akan di-prefetch. Catatan Pisahkan beberapa URL dengan baris baru. Setiap URL dapat memiliki panjang maksimal 1.024 karakter.	example.com/image/1.png\nexample.org/image/2.png
Area	string	No	Wilayah prefetch. Nilai yang valid: domestic: hanya Tiongkok daratan. overseas: global (tidak termasuk Tiongkok daratan). Jika Anda tidak mengatur parameter ini, wilayah prefetch default adalah wilayah akselerasi CDN yang dikonfigurasi untuk nama domain Anda. Catatan Untuk mengatur wilayah prefetch ke global, pastikan wilayah akselerasi nama domain terakselerasi diatur ke global, lalu kosongkan parameter ini.	domestic
L2Preload	boolean	No	Menentukan apakah akan melakukan prefetch konten langsung ke node L2. Nilai yang valid: true: Level node prefetch harus mencakup node L2. false: Hanya node lapisan back-to-origin yang di-prefetch. Ini adalah nilai default. Node lapisan back-to-origin dapat berupa node L2 atau L3.	true
WithHeader	string	No	Header default yang dibawa dalam permintaan prefetch adalah Accept-Encoding:gzip. Untuk membawa header lain dalam permintaan prefetch atau mengimplementasikan prefetch multi-salinan, gunakan parameter ini untuk menyesuaikan header prefetch. Kirimkan nilai dalam format JSON. Catatan Untuk mengecualikan header Accept-Encoding selama prefetch, kirimkan yang berikut: {"Accept-Encoding": [" "]}.	{ "Accept-Encoding": [ "gzip, deflate, br" ] }
QueryHashkey	boolean	No	Menentukan apakah akan mengaktifkan mode kueri hashkey saat menjalankan tugas prefetch. Nilai yang valid: false: mode default. Mode ini digunakan ketika parameter tidak ditentukan. URL yang dikirimkan langsung digunakan sebagai hashkey dari file yang di-prefetch. true: mengkueri hashkey aktual yang digunakan oleh URL prefetch berdasarkan konfigurasi nama domain.	true
ConsistencyHash	boolean	No	Jika wilayah akselerasi nama domain adalah Tiongkok daratan dan pengambilan asal berbasis hash diaktifkan, Anda dapat menggunakan parameter ini untuk mengaktifkan prefetch berbasis hash. Ini mengimplementasikan konvergensi back-to-origin regional dan mengurangi bandwidth back-to-origin yang dihasilkan oleh prefetch. true: mengaktifkan prefetch berbasis hash. false: perilaku default. Prefetch berbasis hash tidak diaktifkan. Penting Parameter ini hanya berlaku untuk nama domain yang wilayah akselerasinya adalah Tiongkok daratan. .	true

Elemen respons

Element	Type	Description	Example
	object
PushTaskId	string	ID tugas prefetch. Beberapa ID tugas dipisahkan oleh koma (,). ID tugas yang dikembalikan digabungkan berdasarkan aturan berikut: Tugas prefetch (pada granularitas URL) yang dikirimkan untuk nama domain yang sama dalam detik yang sama digabungkan menjadi satu PushTaskId. Jika lebih dari 500 tugas prefetch (pada granularitas URL) dikirimkan untuk nama domain yang sama dalam detik yang sama, mereka digabungkan menjadi nilai PushTaskId dalam batch 500.	9524xxxx
RequestId	string	ID permintaan.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Contoh

Respons sukses

JSONformat

{
  "PushTaskId": "9524xxxx",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	SingleRequest.OverLimit	A maximum of 1000 URLs are supported for each request.
400	QuotaExceeded.Preload	Your preload attempts have exceeded the daily limit.	The maximum number of URL prefetches on the current day is exceeded.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.
400	InvalidExtensiveDomain.ValueNotSupported	The specified ExtensiveDomain is not supported.
400	PreloadQueueFull	The warming queue is full,please try again later.
400	QuotaPerMinuteExceeded.Refresh	You have exceeded the prescribed preload limits per minute.
400	InvalidObjectPath.ExceedsMaximum	The maximum number of urls is exceeded.	The number of submitted URLs exceeds the maximum limit.
400	InvalidCustomHeader	Parse preload header failed.	Custom header parsing error.
429	TooManyRequests	System load fluctuates, please try again later.	System load fluctuates, please try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.