Alibaba Cloud CLI adalah alat baris perintah umum yang dikembangkan berdasarkan OpenAPI Explorer. Anda dapat menggunakan Alibaba Cloud CLI untuk mengotomatisasi pengelolaan dan pemeliharaan di ApsaraVideo Media Processing. Topik ini menjelaskan cara menggunakan Alibaba Cloud CLI untuk memanggil operasi API ApsaraVideo Media Processing.
Sebelum memulai
Pelajari lebih lanjut tentang Alibaba Cloud CLI. Untuk informasi selengkapnya, lihat Apa itu Alibaba Cloud CLI?
Instal Alibaba Cloud CLI
Anda harus menginstal Alibaba Cloud CLI sebelum menggunakannya. Alibaba Cloud CLI dapat diinstal pada sistem operasi Windows, Linux, dan macOS. Pilih paket instalasi sesuai dengan sistem operasi perangkat Anda. Untuk informasi selengkapnya, lihat topik-topik berikut:
Anda juga dapat menggunakan Cloud Shell yang disediakan oleh Alibaba Cloud untuk men-debug perintah yang ingin Anda jalankan melalui Alibaba Cloud CLI. Untuk informasi selengkapnya tentang Cloud Shell, lihat Apa itu Cloud Shell?
Konfigurasi Alibaba Cloud CLI
Akun Alibaba Cloud memiliki izin untuk mengelola dan mengakses operasi API semua layanan Alibaba Cloud. Jika Anda menggunakan akun Alibaba Cloud untuk memanggil operasi API, risiko keamanan mungkin timbul. Kami menyarankan agar Anda memanggil operasi API atau melakukan O&M rutin sebagai Pengguna Resource Access Management (RAM).
Sebelum menggunakan Alibaba Cloud CLI, Anda harus mengonfigurasi informasi seperti kredensial identitas dan ID wilayah. Alibaba Cloud CLI mendukung berbagai jenis kredensial identitas. Untuk informasi selengkapnya, lihat bagian "Jenis kredensial" dalam topik Konfigurasi profil. Dalam contoh ini, kredensial AccessKey digunakan. Ikuti langkah-langkah berikut untuk menggunakan kredensial AccessKey:
Buat RAM user dan berikan izin yang diperlukan kepada RAM user tersebut. Untuk informasi selengkapnya, lihat Buat RAM user dan Berikan izin kepada RAM user.
PentingDalam contoh ini, kebijakan
AliyunMTSFullAccessdilampirkan pada RAM user. Anda juga dapat menggunakan kebijakan kustom. Untuk informasi selengkapnya, lihat Kebijakan kustom untuk MPS.Buat pasangan AccessKey untuk RAM user dan catat
AccessKey IDdanAccessKey secretuntuk konfigurasi kredensial identitas selanjutnya. Untuk informasi selengkapnya, lihat Buat pasangan AccessKey.Dapatkan dan catat ID wilayah yang tersedia untuk konfigurasi kredensial identitas selanjutnya. Alibaba Cloud CLI menggunakan ID wilayah yang ditentukan untuk memulai panggilan API. Untuk informasi selengkapnya tentang wilayah yang tersedia, lihat Endpoint.
CatatanSaat menggunakan Alibaba Cloud CLI, Anda dapat menentukan opsi
--regionuntuk menjalankan perintah di wilayah tertentu. Jika Anda menentukan opsi ini, Alibaba Cloud CLI akan mengabaikan informasi wilayah dalam konfigurasi profil default dan variabel lingkungan. Untuk informasi selengkapnya, lihat Opsi baris perintah untuk panggilan API.Gunakan pasangan AccessKey dari RAM user untuk mengonfigurasi kredensial AccessKey dalam profil bernama
AkProfile. Untuk informasi selengkapnya, lihat bagian "Contoh konfigurasi" dalam topik Konfigurasi profil.
Buat perintah CLI
-
Pada kotak pencarian di sisi kiri halaman Debugging, cari operasi API yang ingin Anda panggil. Di tab Parameters operasi API tersebut, tentukan parameter sesuai referensi API. Klik tab CLI Example di sisi kanan untuk melihat perintah contoh yang dihasilkan beserta parameter yang telah ditentukan.
Klik ikon
untuk memulai Cloud Shell dan men-debug perintah tersebut di Cloud Shell.Klik ikon
untuk menyalin perintah contoh ke clipboard. Lalu, tempel perintah contoh tersebut ke shell lokal Anda untuk menjalankannya.Perhatikan format parameter saat menempel perintah contoh ke shell lokal Anda untuk debugging. Untuk informasi selengkapnya tentang format parameter Alibaba Cloud CLI, lihat Format parameter.
Secara default, OpenAPI Explorer menambahkan opsi
--regionke perintah contoh yang dihasilkan. Saat Anda menjalankan perintah tersebut di shell lokal, Alibaba Cloud CLI akan mengabaikan informasi wilayah dalam konfigurasi profil default dan variabel lingkungan, serta menjalankan perintah di wilayah yang ditentukan. Anda dapat menghapus atau mempertahankan opsi tersebut sesuai kebutuhan bisnis Anda.
Panggil operasi API
Sintaksis
Di Alibaba Cloud CLI, Anda dapat menggunakan sintaksis berikut untuk menjalankan perintah. Untuk informasi selengkapnya, lihat bagian "Sintaksis" dalam topik Buat dan jalankan perintah CLI.
aliyun <command> <subcommand> [opsi dan parameter]Opsi perintah
Saat menggunakan Alibaba Cloud CLI, Anda dapat menentukan opsi perintah untuk mengubah perilaku default perintah atau mengaktifkan fitur tambahan. Opsi perintah umum:
--profile <profileName>: Anda dapat menggunakan opsi--profiledan parameterprofileNameuntuk menentukan profil. Setelah menentukan profil yang valid, Alibaba Cloud CLI akan mengabaikan konfigurasi profil default dan variabel lingkungan, serta menggunakan profil yang Anda tentukan untuk menjalankan perintah.--help: Anda dapat menggunakan opsi--helpuntuk mendapatkan informasi bantuan tentang suatu perintah. Untuk informasi selengkapnya, lihat Gunakan perintah help.
Untuk informasi selengkapnya, lihat Opsi baris perintah untuk panggilan API.
Contoh
Contoh 1: Gunakan opsi --help untuk mendapatkan daftar operasi API ApsaraVideo Media Processing yang didukung oleh Alibaba Cloud CLI. Anda juga dapat melihat operasi API yang dapat dipanggil di Daftar operasi berdasarkan fungsi.
Jalankan perintah berikut:
aliyun mts --help-
Lihat output perintah.
Usage: aliyun mts <ApiName> --parameter1 value1 --parameter2 value2 ... Product: Mts (媒体处理) Version: 2014-06-18 Available Api List: ActivateMediaWorkflow Activates a media workflow. AddMedia Submits a job to add a media asset. AddMediaTag Adds tags to a media asset. AddMediaWorkflow Creates a media workflow. AddPipeline Creates a pipeline. AddSmarttagTemplate Adds a template for a smart tagging job. AddTemplate Creates a custom template that includes container, video, and audio stream settings.
Contoh 2: Gunakan Alibaba Cloud CLI untuk memanggil operasi QueryMediaInfoJobList dari ApsaraVideo Media Processing untuk mengkueri pekerjaan informasi media. Untuk informasi selengkapnya tentang operasi QueryMediaInfoJobList, lihat QueryMediaInfoJobList.
Jalankan perintah berikut:
aliyun mts QueryMediaInfoJobList --region cn-hangzhou --MediaInfoJobIds '23ca1d184c0e4341e5b665e2a12****'-
Lihat output perintah.
{ "NonExistMediaInfoJobIds": { "String": [ "11ce1d184c0e4341e5b665e2a12****" ] }, "RequestId": "46A04AA5-B119-41BB-B750-7C5327AC3E7A", "MediaInfoJobList": { "MediaInfoJob": [ { "CreationTime": "2014-01-10T12:00:00Z", "State": "Success", "JobId": "23ca1d184c0e4341e5b665e2a12****", "UserData": "testid-001", "Code": "InvalidParameter.JsonObjectFormatInvalid", "Message": "The parameter "*" does not conform to the JSON Object specification", "PipelineId": "88c6ca184c0e432bbf5b665e2a15****", "Async": true, "Input": { "Object": "example.mp4", "Location": "oss-cn-hangzhou", "Bucket": "example-bucket" }, "MNSMessageResult": { "MessageId": "123", "ErrorMessage": "The parameter \\\"Input\\\" does not conform to the JSON Object specification", "ErrorCode": "InvalidParameter.JsonObjectFormatInvalid" }, "Properties": { "Width": "1280", "Height": "720", "Duration": "17.226000", "Fps": "25", "Bitrate": "1630.045", "FileFormat": "QuickTime/MOV", "Streams": { "VideoStreamList": { "VideoStream": [ { "Sar": "1:1", "Height": "1080", "CodecTagString": "[0][0][0][0]", "NetworkCost": { "PreloadTime": "8", "AvgBitrate": "300.34", "CostBandwidth": "10" }, "Width": "1920", "Index": "1", "Timebase": "1/1000", "AvgFPS": "23.976025", "PixFmt": "yuv420p", "Lang": "eng", "CodecLongName": "H.264/AVC/MPEG-4 AVC/MPEG-4 part 10", "NumFrames": "100", "Rotate": "180", "Bitrate": "30541090", "HasBFrames": "0", "Profile": "High", "StartTime": "0.042000", "Dar": "16:9", "CodecName": "h264", "Duration": "100", "Fps": "25", "CodecTag": "0x0000", "CodecTimeBase": "1001/48000", "Level": "41", "ColorRange": "700", "ColorTransfer": "R255 G83 B170", "ColorPrimaries": "700" } ] }, "AudioStreamList": { "AudioStream": [ { "Timebase": "1/1000", "Index": "1", "SampleFmt": "fltp", "ChannelLayout": "5.1(side)", "Lang": "eng", "Samplerate": "48000", "CodecLongName": "DCA (DTS Coherent Acoustics)", "Channels": "2", "NumFrames": "123", "Bitrate": "1536000", "CodecTagString": "[0][0][0][0]", "StartTime": "0.042000", "CodecName": "acc", "Duration": "123", "CodecTag": "0x0000", "CodecTimeBase": "1/48000" } ] }, "SubtitleStreamList": { "SubtitleStream": [ { "Timebase": "1/1000", "Index": "3", "StartTime": "0.000000", "CodecName": "ass", "Lang": "eng", "CodecLongName": "ASS (Advanced SSA) subtitle", "Duration": "1370.116000", "CodecTag": "0x0000", "CodecTimeBase": "0/1", "CodecTagString": "[0][0][0][0]" } ] } }, "Format": { "StartTime": "0.042000", "NumPrograms": "2", "Size": "3509895", "NumStreams": "1", "FormatLongName": "QuickTime/MOV", "Duration": "17.226000", "Bitrate": "1630.045", "FormatName": "mov" }, "FileSize": "3509895" } } ] } }CatatanJika terjadi error setelah Anda memanggil operasi API ApsaraVideo Media Processing, Anda harus memeriksa apakah parameter permintaan dan nilainya valid berdasarkan kode kesalahan yang dikembalikan.
Anda juga dapat mencatat ID permintaan dari respons atau pesan error SDK dan menggunakan OpenAPI Diagnostics untuk menjalankan diagnosis self-service.