CreateOfficeConversionTask -

Membuat tugas konversi dokumen yang mengonversi file Word, PowerPoint, Excel, dan PDF yang disimpan di Object Storage Service (OSS) menjadi file gambar, teks, atau PDF.

Deskripsi operasi

Sebelum menggunakan operasi ini, pastikan Anda memahami metode penagihan dan harga Intelligent Media Management (IMM).
Penting Waktu eksekusi tugas asinkron tidak dijamin.
Format file input yang didukung:
- Dokumen pengolah kata (Word): doc, docx, wps, wpss, docm, dotm, dot, dan dotx.
- Dokumen presentasi (PowerPoint): pptx, ppt, pot, potx, pps, ppsx, dps, dpt, pptm, potm, ppsm, dan dpss.
- Dokumen spreadsheet (Excel): xls, xlt, et, ett, xlsx, xltx, csv, xlsb, xlsm, xltm, dan ets.
- Dokumen PDF: pdf.
Format file output yang didukung:
- Gambar: png dan jpg.
- Teks: txt.
- PDF: pdf.
Ukuran maksimum satu file adalah 200 MB. Batas ini tidak dapat diubah.
Jika file berukuran besar atau isinya kompleks, konversi mungkin mengalami timeout.
Jumlah permintaan per detik dibatasi hingga 50 untuk satu pengguna.
Informasi tugas hanya disimpan selama 7 hari sejak tugas dimulai. Setelah periode tersebut, informasi tidak dapat diambil lagi. Anda dapat segera memperoleh informasi tugas dengan salah satu metode berikut:
- Memanggil operasi GetTask atau ListTasks untuk memperoleh TaskId yang dikembalikan dan melihat informasi tugas.
- Mengaktifkan Message Service (MNS) di wilayah yang sama dengan IMM dan mengonfigurasi langganan untuk segera menerima notifikasi informasi tugas. Untuk informasi lebih lanjut tentang format pesan notifikasi asinkron, lihat Format pesan notifikasi asinkron. Untuk informasi lebih lanjut tentang kit pengembangan perangkat lunak (SDK) MNS, lihat Menerima dan menghapus pesan.
- Mengaktifkan RocketMQ di wilayah yang sama dengan IMM, serta membuat instans RocketMQ 4.0, topik, dan kelompok untuk segera menerima notifikasi informasi tugas. Untuk informasi lebih lanjut tentang format pesan notifikasi asinkron, lihat Format pesan notifikasi asinkron. Untuk informasi lebih lanjut tentang cara menggunakan RocketMQ, lihat Gunakan SDK HTTP untuk mengirim dan menerima pesan biasa.
- Mengaktifkan dan menghubungkan ke EventBridge di wilayah yang sama dengan IMM untuk segera menerima notifikasi informasi tugas. Untuk informasi lebih lanjut, lihat Event Intelligent Media Management IMM.

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

imm:CreateOfficeConversionTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	Nama proyek. Untuk informasi lebih lanjut tentang cara memperoleh nama proyek, lihat Buat proyek.	test-project
SourceURI	string	No	Alamat penyimpanan data sumber. Alamat OSS harus dalam format oss://${Bucket}/${Object}. `${Bucket}` adalah nama bucket OSS yang berada di wilayah yang sama dengan proyek saat ini. `${Object}` adalah path lengkap file, termasuk ekstensi nama file.	oss://test-bucket/test-object
Sources	array<object>	No	Daftar gambar input. Gambar dikonversi sesuai urutan URI-nya dalam daftar. (Parameter ini belum dipublikasikan. Jangan gunakan.)	oss://imm-test/test.pptx
	object	No	Informasi tentang gambar input.
URI	string	No	Alamat OSS gambar sumber. Alamat OSS harus dalam format oss://${Bucket}/${Object}. ${Bucket} adalah nama bucket OSS yang berada di wilayah yang sama dengan proyek saat ini. ${Object} adalah path lengkap file, termasuk ekstensi nama file. Format gambar yang didukung: jpg, jp2, png, tiff, webp, bmp, dan svg.	oss://examplebucket/sampleobject.jpg
Rotate	integer	No	Sudut rotasi gambar. Nilai yang valid: 0 (default) 90 180 270	90
TargetURI	string	No	Templat alamat output dokumen yang telah dikonversi. Alamat harus dalam format `oss://{bucket}/{tags.custom}/{dirname}/{barename}.{autoext}`. Untuk informasi lebih lanjut, lihat Templat TargetURI. Catatan Tentukan salah satu parameter ini atau `TargetURIPrefix`.	oss://examplebucket/outputDocument.pdf
TargetURIPrefix	string	No	Awalan alamat penyimpanan file output setelah konversi dokumen. Awalan harus dalam format `oss://${Bucket}/${Prefix}/`. `${Bucket}` adalah nama bucket OSS yang berada di wilayah yang sama dengan proyek saat ini. `${Prefix}` adalah awalan alamat penyimpanan file output. Catatan Tentukan salah satu parameter ini atau `TargetURI`.	oss://examplebucket/outputprefix/
SourceType	string	No	Jenis ekstensi data sumber. Secara default, jenis data sumber ditentukan oleh ekstensi objek OSS. Jika objek OSS tidak memiliki ekstensi, Anda dapat mengatur parameter ini. Nilai yang valid: Dokumen pengolah kata (Word): doc, docx, wps, wpss, docm, dotm, dot, dan dotx Dokumen presentasi (PowerPoint): pptx, ppt, pot, potx, pps, ppsx, dps, dpt, pptm, potm, ppsm, dan dpss Dokumen spreadsheet (Excel): xls, xlt, et, ett, xlsx, xltx, csv, xlsb, xlsm, xltm, dan ets Dokumen PDF: pdf	doc
TargetType	string	Yes	Jenis file output. Nilai yang valid: png: Mengonversi dokumen menjadi gambar PNG. jpg: Mengonversi dokumen menjadi gambar JPG. pdf: Mengonversi dokumen menjadi file PDF. txt: Mengonversi dokumen menjadi file teks saja. Ini terutama digunakan untuk mengekstraksi konten teks dari file. Opsi ini hanya didukung untuk dokumen presentasi, dokumen pengolah kata, dan dokumen spreadsheet. Saat Anda mengonversi dokumen spreadsheet, satu file txt dihasilkan, dan pengaturan variabel terkait sheet tidak berlaku.	png
UserData	string	No	Informasi kustom. Informasi ini dikembalikan dalam pesan notifikasi asinkron untuk membantu Anda mengaitkan notifikasi dengan layanan Anda. Nilainya dapat mencapai panjang 2.048 byte.	{ "id": "test-id", "name": "test-name" }
Tags	object	No	Tag kustom. Nilainya berupa kamus. Anda dapat menggunakan tag untuk mencari tugas.	{ "key": "value" }
StartPage	integer	No	Halaman awal untuk konversi dokumen. Nilai default adalah 1. Catatan Jika file sumber adalah spreadsheet, Anda harus menentukan nomor worksheet. Parameter ini hanya berlaku saat Anda mengonversi dokumen menjadi gambar. Parameter ini tidak berlaku saat Anda mengonversi dokumen menjadi file PDF atau file teks.	1
EndPage	integer	No	Halaman akhir untuk konversi dokumen. Nilai default adalah -1, yang menunjukkan bahwa semua halaman dari halaman awal hingga halaman terakhir dikonversi. Catatan Jika file sumber adalah spreadsheet, Anda harus menentukan nomor worksheet (`SheetIndex`). Jika dokumen memiliki banyak halaman, kami menyarankan agar Anda mengonversinya secara batch. Jika tidak, konversi mungkin mengalami timeout. Parameter ini hanya berlaku saat Anda mengonversi dokumen menjadi gambar. Parameter ini tidak berlaku saat Anda mengonversi dokumen menjadi file PDF atau file teks.	-1
Password	string	No	Kata sandi untuk membuka dokumen. Atur parameter ini jika Anda ingin mengonversi dokumen yang dilindungi kata sandi.	123456
ScalePercentage	integer	No	Rasio penskalaan dokumen. Nilai yang valid: 20 hingga 199. Nilai default adalah 100, yang menunjukkan bahwa dokumen tidak diskalakan. Catatan Nilai kurang dari 100 menunjukkan bahwa dokumen diperkecil. Nilai lebih dari 100 menunjukkan bahwa dokumen diperbesar.	100
Quality	integer	No	Kualitas file yang dikonversi. Nilai yang valid: 0 hingga 100. Nilai 0 menunjukkan kualitas terendah dan performa terbaik. Nilai 100 menunjukkan kualitas tertinggi dan performa terburuk. Secara default, sistem menetapkan nilai yang sesuai berdasarkan konten dokumen untuk menyeimbangkan kualitas dan performa.	60
Pages	string	No	Nomor halaman yang akan dikonversi. Parameter ini memiliki prioritas lebih tinggi daripada parameter `StartPage` dan `EndPage`. Formatnya sebagai berikut: Pisahkan beberapa nomor halaman dengan koma (,), misalnya 1,2. Tentukan rentang halaman berurutan dengan tanda hubung (-), misalnya 1,2-4,7.	1,2-4,7
MaxSheetRow	integer	No	Jumlah maksimum baris yang dikonversi saat Anda mengonversi dokumen spreadsheet menjadi gambar. Secara default, semua baris dikonversi. Catatan Parameter ini hanya berlaku saat Anda mengatur LongPicture ke `true`.	10
MaxSheetColumn	integer	No	Jumlah maksimum kolom yang dikonversi saat Anda mengonversi dokumen spreadsheet menjadi gambar. Secara default, semua kolom dikonversi. Catatan Parameter ini hanya berlaku saat Anda mengatur LongPicture ke `true`.	10
SheetCount	integer	No	Jumlah worksheet yang dikonversi menjadi gambar dalam dokumen spreadsheet. Secara default, semua worksheet dikonversi.	1
SheetIndex	integer	No	Nomor worksheet yang dikonversi menjadi gambar dalam dokumen spreadsheet. Nilai yang valid: 1 hingga nomor worksheet terakhir. Nilai default adalah 1.	1
FitToWidth	boolean	No	Saat Anda mengonversi dokumen spreadsheet menjadi gambar atau file PDF, tentukan apakah akan merender semua kolom pada satu gambar atau halaman PDF. Nilai yang valid: false (default): Tidak. Konten dirender pada beberapa gambar atau halaman PDF. true: Ya. Konten dirender pada satu gambar atau halaman PDF.	false
FitToHeight	boolean	No	Saat Anda mengonversi dokumen spreadsheet menjadi gambar atau file PDF, tentukan apakah akan merender semua baris pada satu gambar atau halaman PDF. Nilai yang valid: false (default): Tidak. Konten dirender pada beberapa gambar atau halaman PDF. true: Ya. Konten dirender pada satu gambar atau halaman PDF.	false
FirstPage	boolean	No	Saat Anda mengonversi dokumen spreadsheet menjadi gambar, tentukan apakah hanya mengembalikan gambar pertama dari hasil konversi. Jumlah baris dan kolom dalam gambar merupakan hasil pemisahan otomatis. Nilai yang valid: false (default): Tidak. Semua gambar dikembalikan. true: Ya. Hanya gambar pertama yang dikembalikan. Ini digunakan untuk mengekstraksi gambar mini. Catatan Parameter ini hanya berlaku jika Anda mengatur parameter LongPicture ke `true`.	false
PaperSize	string	No	Ukuran kertas untuk mengonversi dokumen spreadsheet menjadi gambar. Gambar output mirip dengan halaman cetak. Nilai yang valid: A0 A2 A4 (default) Catatan Parameter ini hanya berlaku saat digunakan bersama parameter FitToHeight dan FitToWidth.	A4
PaperHorizontal	boolean	No	Saat Anda mengonversi dokumen spreadsheet menjadi gambar, tentukan apakah kertas ditempatkan secara horizontal. Gambar output mirip dengan halaman cetak. Nilai yang valid: false (default): Tidak. Kertas ditempatkan secara vertikal. true: Ya. Kertas ditempatkan secara horizontal.	false
TrimPolicy	TrimPolicy	No	Kebijakan pemangkasan untuk konversi spreadsheet. Misalnya, jika spreadsheet berisi banyak baris dan kolom kosong, ruang putih yang besar dapat dihasilkan jika tidak ada kebijakan pemangkasan yang ditentukan.
ShowComments	boolean	No	Saat Anda mengonversi dokumen pengolah kata menjadi gambar, tentukan apakah komentar ditampilkan. Nilai yang valid: false (default): Tidak. Komentar tidak ditampilkan. true: Ya. Komentar ditampilkan.	false
LongPicture	boolean	No	Saat Anda mengonversi dokumen menjadi gambar, tentukan apakah akan mengonversinya menjadi gambar panjang. Nilai yang valid: false (default): Tidak. Dokumen dikonversi menjadi beberapa gambar. true: Ya. Dokumen dikonversi menjadi satu gambar panjang. Catatan Anda dapat menggabungkan maksimal 20 halaman menjadi satu gambar panjang. Jika jumlah halaman melebihi batas ini, tugas konversi mungkin gagal.	false
ImageDPI	integer	No	DPI gambar output. Nilai yang valid: 96 hingga 600. Nilai default adalah 96.	96
LongText	boolean	No	Saat Anda mengonversi dokumen menjadi teks, tentukan apakah akan mengonversinya menjadi satu file teks panjang. Nilai yang valid: false (default): Tidak. Setiap halaman dokumen dikonversi menjadi file teks terpisah. true: Ya. Seluruh konten ditempatkan dalam satu file teks.	false
HoldLineFeed	boolean	No	Saat Anda mengonversi dokumen menjadi teks, tentukan apakah line feed dalam dokumen dipertahankan. Nilai yang valid: false (default): Tidak. Line feed tidak dipertahankan. true: Ya. Line feed dipertahankan.	false
CredentialConfig	CredentialConfig	No	Jika Anda tidak memiliki persyaratan khusus, biarkan parameter ini kosong. Konfigurasi otorisasi berantai. Parameter ini tidak wajib. Untuk informasi lebih lanjut, lihat Gunakan otorisasi berantai untuk mengakses sumber daya entitas lain.
Notification	Notification	No	Konfigurasi notifikasi pesan. Untuk informasi lebih lanjut, klik Notification. Untuk informasi lebih lanjut tentang format pesan notifikasi asinkron, lihat Format pesan notifikasi asinkron.

Elemen respons

Element	Type	Description	Example
	object	Tanggapan untuk tugas asinkron.
RequestId	string	ID permintaan.	FF3B7D81-66AE-47E0-BF69-157DCF18*****
TaskId	string	ID tugas.	formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****
EventId	string	ID event.	2C2-1I0EG57VR37J4rQ8oKG6C9*****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF18*****",
  "TaskId": "formatconvert-00bec802-073a-4b61-ba3b-39bc2fdd*****",
  "EventId": "2C2-1I0EG57VR37J4rQ8oKG6C9*****"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.